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.
I have been through this with so many companies, who had standards that I
actually did not agree with...
It all depends on what the manual is about - the title should make it
clear.For example, "XXX Compiler Guide" means nothing, while "How to use the
XXX Compiler on YYY" does. Is it an instruction manual, a reference manual,
a bulletin (advance info, for example), a sales document, a brochure, a
"read me first", an "additional notes", or what?
At my present company we have Guides, which are "How to use" manuals,
Reference Manuals, which are just that (somewhere to refer to), Additional
Notes (last-minute information), and so on.
All you have to do is choose a title that is clear, concise, and complete:
if your readers don't come back with a question about the title, then you
have probably got it right.
Martyn Thirlway
thirlwaym -at- usoft -dot- nl
Author of "Writing Software Documentation - A Practical Guide"
["This writing business, pencils and what-not. Overrated if you ask me."
Eeyore]
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-
