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:using notes From:Tom Little <LITTLE_TOM_H -at- OFVAX -dot- LANL -dot- GOV> Date:Fri, 27 Jan 1995 13:37:00 MDT
An anonymous poster writes:
> My department is currently reevaluating how we use notes in our manuals.
> Cautions and warnings seem to have clear guidelines, because of their legal
> ramifications and evolution out of the Mil Spec and standards worlds. Using
> notes seems to be less well-defined for style and usage. How do you use
> notes? What are their purpose? How many are too many?
This is a subtle question. When I was writing procedures, we used notes to
present supplemental information that is not necessary to successfully complete
the task. A note could not contain any "action step" for the reader. This
definition makes notes subordinate to the document text. They might be thought
of as "asides."
However, it is also common (especially in less formal contexts) to use notes to
identify information that is especially IMPORTANT for some reason. These might
be thought of as "alerts."
I'm uncomfortable with these two opposite connotations living side-by-side. I
wonder how many readers approach a note thinking it is incidental when in fact
it is essential, or vice versa.
The more I think about it, the more it seems that the word "NOTE" sends a very
ambiguous message to the reader. Perhaps the "NOTE" label should be replaced by
more specific terms, more clearly identifying the type of information that
Tom Tadfor Little | This
Technical Writer/Editor | space
Los Alamos National Laboratory | for
little_tom_h -at- ofvax -dot- lanl -dot- gov | rent