RE: Display installer panels in doc?

Subject: RE: Display installer panels in doc?
From: "Catherine Buck" <cbuck -at- xillix -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 22 Oct 2004 09:20:44 -0700

If it's a good bet that the user is reading the install guide while looking
at the screen (not offline), the screen shots are redundant and take up way
too much room. Users don't want to read the doc, so they are not going to be
encouraged to do so if they get the impression that the install guide is
just a dump of panels.

The installer should try to be self-documenting (duh). This may not happen
if the installer is badly designed or if there are some aspects to
installation that are too complicated to pack into one panel. In either
case, I still try to avoid screen shots in the main thread of the install
guide (in a hope of getting this thread onto one or two pages) and instead
include x-refs to later subsections in the install guide, maybe with a
screen shot, to act as a visual cue. If the reason for the x-ref is a badly
designed wizard, the long explanation can become a base for redesigning the
wizard in a later revision - ie, the logic that's had to go into the install
guide can be integrated into the wizard.

Do you market or develop - if you develop, why not ask the software
developers who created the product if they want screens? Ten-to-one they


ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed!

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


Display installer panels in doc?: From: Joyce Fetterman

Previous by Author: RE: The End Of Technical Writing Was RE: Re: a different res ume red flag
Next by Author: Re: How did you get your first tech writing job
Previous by Thread: Re: Display installer panels in doc?
Next by Thread: RE: Display installer panels in doc?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads