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. A good name for the manual? From:"Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA> To:"Techwr-L (E-mail)" <TECHWR-L -at- lists -dot- raycomm -dot- com> Date:Thu, 24 Feb 2000 08:55:10 -0500
Reni reports: <<We divided our manuals to several smaller ones like
Programming manual, Programming Interfaces, Reference manual and User
manual. If we decide to make a separate manual from sections: -
configuration parameters and - log, alarm and statistic messages What would
be a descriptive name for one manual, which includes these all
sections?>>
"Reference" manual, since that's what these sections contain: material that
people will _refer_ to when they need to look up parameters or messages.
They won't likely read this manual either for pleasure or to find out how to
do a procedure; that's what they'll find in the "User" manual.
--Geoff Hart, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"The paperless office will arrive when the paperless toilet
arrives."--Matthew Stevens
