Document Planning

Subject: Document Planning
From: "George F. Hayhoe" <george -at- GHAYHOE -dot- COM>
Date: Wed, 11 Jun 1997 09:21:14 -0400

In response to Matthew Long's query about documenting an
interface with multiple flavors:

If the user population is large enough to warrant it, you might
consider writing a separate document for each flavor. That way,
users of the vanilla flavor won't get distracted--or
confused--by the information provided for users of the rocky
road flavor, and the manual for each will be relatively short.
You'll be able to reuse a lot of material among the different
manuals, so this approach doesn't significantly increase the
amount of work required of the documentation team.

--George Hayhoe (george -at- ghayhoe -dot- com)

George Hayhoe Associates
Voice: +1 803-642-2156
Fax: +1 803-642-9325
Award-winning Web site: http://www.ghayhoe.com

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Word 7 Display Problems
Next by Author: Writing, Designing, Etc.
Previous by Thread: Re: Document Planning
Next by Thread: Re: Document Planning


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


Sponsored Ads