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: Naming Convention for Manuals From:"Merrick, Tim" <tim -dot- merrick -at- LSIL -dot- COM> Date:Tue, 22 Jun 1999 08:17:47 -0500
Lenore Weiss wrote:
"What do you use as standard nomenclature to distinguish your suite
of published books and how do you define each kind?"
We use Installation Guide, User Guide, and Kit Instructions for hardware;
Installation and Support Guide and User Guide for software.
"We want to standardize on Guide and Reference Manual. (The first
for the user; the second for the administrator.)
I'm curious why you would use 'Guide' for the end user and 'Manual' for the
administrator. Any reason? Why not User Guide and Administrator Guide? Or,
if for some reason you want to stress the technical nature of the admin
book, how about Technical Reference?
"What about your use of apostrophes in titles as in User's Guide vs.
User Guide. Any words of wisdom there?
It's my impression that the standard form is User Guide (no apostrophe),
though I still see instances of both forms. I prefer User Guide.
Tim Merrick
Technical Publications
LSI Logic Storage Systems
