Re: Display installer panels in doc?

Subject: Re: Display installer panels in doc?
From: Lee Hunter <lee -dot- hunter -at- hum -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 22 Oct 2004 11:49:26 -0400

Quoting Joyce Fetterman <JoyceF -at- gtsoftware -dot- com>:

> Do you typically include screen shots of installer panels in documentation
> aimed at a technical audience?
> We market software products that are used by other software developers, a
> tech-savvy audience. The installer walks the user through a series of a
> dozen or so uncomplicated, self-explanatory panels. I see no reason to put
> screen captures of all these panels in the doc, but I'm getting flak about
> that decision from somebody who is sometimes (but not always) right.

Captures of every screen are excellent in the design specs because it ensures
that everyone knows what the application is supposed to look like. In the user
documentation they should be used much more judiciously.

The whole point of using an installation wizard is that it should communicate
everything the user needs to know about accomplishing a task. Showing pictures
of the wizard in the procedure is almost always redundant and, by bloating the
procedure over multiple pages, increases the likelihood that the user will get

In theory, the wizard shouldn't need any documentation (beyond how to launch)
unless there is something about it which can't be explained in the embedded


Lee Hunter - Technical Editor & Information Architect

------ ------- 613-282-1904 ------


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: Interviews & the ULTIMATE red flag
Next by Author: Re: ADMIN: New Article on TECHWR-L Web Site (was: Re: fiction manuscripts being unpublishable for "not being creative enough")
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