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:Setting up a standard for User Manuals -Reply From:Carol Van Natta <CVANNATT -at- ITC -dot- NRCS -dot- USDA -dot- GOV> Date:Mon, 8 Dec 1997 11:02:19 -0700
I'm not exactly sure what kind of standards you think you
want -- organization? content (required chapters)? look and
feel? language style? grammar & spelling? These are the
types of things usually covered by in-house style manuals.
As with any document, it kind of depends on what you want
your style manual to accomplish. Establish a record of your
documentation decisions? Help another writer (or even a
contractor) produce documentation that looks like it came
from the same company? Convince other writers in other
groups that they ought to be following your (or at least
SOME) standards? Answering these questions will tell you a
lot about what should be in your style manual and what level
of detail you include.
>>> Coetta A Lampe <clampe -at- OKWAY -dot- OKSTATE -dot- EDU>
12/8/97 10:42 am >>>
I need to devise a document for "standards" to use in the
area where I
work. I am not aware of any that currently exist here. I
"lone" writer for the applications that the group in my
produces (everyone else is a programmer).
I have produced several in the past couple of years and I
documented some of my own ideas. I would appreciate
to the content that I should include. I want to include, at
what most of you believe is important.