Re: front matter in manuals

Subject: Re: front matter in manuals
From: Bill Swallow <techcommdood -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 31 Oct 2005 08:31:13 -0500

> Our user guides are intended for quite technical people, and today,
> when everyone knows how to use a computer, is such a section
> redundant?
> What do you normallly include at the beginning of a (software) user guide?

Rule #1: Know your audience.

If you are documenting software aimed at a very computer-savvy
audience, you can probably omit the "must know the difference between
a CD drive and a cupholder" section. ;-)

Bill Swallow
HATT List Owner
WWP-Users List Owner


Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here:

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more.

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.

front matter in manuals: From: Carrie Baker

Previous by Author: Re: Training Materials vrs User's Guides/Online Help
Next by Author: RE: Asking The Billing Rate?
Previous by Thread: front matter in manuals
Next by Thread: RE: front matter in manuals

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

Sponsored Ads