RE: front matter in manuals

Subject: RE: front matter in manuals
From: "Kevin McGowan" <thatguy_80 -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 31 Oct 2005 08:25:06 -0500

Our manuals have front matter that include subjectssuch as, who is
intended to read the books, objectives, using the documentation etc.
For some reason the following section also appears there:
"Document conventions: This guide assumes you have a working knowledge
of your computer and its operating conventions, including how to use a
mouse, standard menus and commands. It also assumes you know how to
open, save and close files. For help with any of these techniques,
please see your Windows documentation."

Our user guides are intended for quite technical people, and today,
when everyone knows how to use a computer, is such a section

I agree that this is probably redundant. For example, in our manuals (our product is a network management system for highly knowledgeable IT professionals), we used to have a glossary of terminology. It had a bunch of simple IT terms such as RAM, SNMP, etc. We pulled it out because it was highly unlikely that anyone reading these guides would need such a basic overview.

If your audience is that specific, then you can probably pull that out.


Take charge with a pop-up guard built on patented Microsoft® SmartScreen Technology Start enjoying all the benefits of MSN® Premium right now and get the first two months FREE*.


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.

Previous by Author: RE: SnagIT vs Irfanview
Next by Author: Independent Contractor Insurance Question
Previous by Thread: Re: front matter in manuals
Next by Thread: RE: front matter in manuals

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

Sponsored Ads