TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: FWD: Self-explanatory installation From:"Jeanne A. E. DeVoto" <jaed -at- jaedworks -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 17 Jan 2000 07:19:17 -0800
At 6:38 AM -0800 1/17/2000, Anonymous Poster wrote:
>Our installation guides can run to 30/40 pages, with most pages
>containing just the graphic and one or two lines of text. I imagine this
>must be totally tedious for the user, and I doubt if it's of much use
>either. However, our managers don't want to do away with the
>Installation Guides altogether.
I'd say this is a job for....
<cheesy echo effect>
AUDIENCE ANALYSIS!!!
*Is* the current format useful to your audience? Do they use the
Installation Guide when they install the software? Do your users want to
change the socket number to something other than the default during
installation? Do they, by and large, know what a socket number is? Do they
know enough to *know* whether they should accept the default socket number?
Without having an answer to at least some of these questions, it'll be
difficult to figure out how to improve the guide. You might want to add
reference information, or add pointers to reference info elsewhere (if only
a few users need it), or remove the graphic as unnecessary, or do any of a
dozen other things to make the installation guide easier to use and more
informative. But you'll be shooting in the dark until you have a good idea
of what your users need in an installation guide.