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: help with a strong word From:"Eric L. Dunn" <edunn -at- TRANSPORT -dot- BOMBARDIER -dot- COM> Date:Fri, 13 Aug 1999 13:08:47 -0400
After following this thread I think that this is this was the best response
yet.
If the procedure exists and is required then all the suggestions of various
"Don't do this" titles are silly. If the manual being discussed only lists
procedures, why would the person be using it if they did not already know
they
had to accomplish the task? Obviously either the manual in question
describes
'when' to perform the procedure or another related one does. The procedure
itself should only have to remind the user of, or point them back to, the
explanatory passage.
Set up a standard such as the one suggested by Betsy Maaks. While that
example
used Caution, Warning, and Danger, we use a similar standard of Warning,
Caution
and Note.
NOTE: Any comment that will facilitate the procedure. (To ease widget
removal,
jiggle widget slightly while rotating.)
CAUTION: Used to warn against damaging equipment. (Do not bend widget while
removing.)
WARNING: Used to warn against personnel injury/death. (Widget weighs 100 lb.
Use
appropriate lifting equipment when removing widget.)
These three cover your rear when necessary. So in the case of a potentially
dangerous/server crashing procedure the following should suffice:
FORMATTING SERVER
CAUTION: Formatting the server drive will lose all data. Formatting is final
and
no undo is possible.
Step 1:.....
To make the Warnings, cautions and notes stand out, adopt a suitable style
with
bold, underlining or framing. For more impact, follow the other suggestions
put
forward of including an internationally recognised pictogram. (Colours,
shapes,
and symbols all available through various ISO standards)
Eric L. Dunn