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.
>> ===========================================
>> WARNING
>>
>> Reversing the following steps could kill
>> you.
>> ============================================
According to Simplified English (used in the Aeronautics industry), the
following descriptions apply to the use of Notes, Cautions and Warnings
(which BTW are the only ones allowed).
Notes and cautions tell a user that parts of the procedures can be dangerous.
*Note*
A note is a general comment made to inform the user of a particularity.
*Caution*
A caution tells the user that damage to equipment or data is possible. A
caution must be specific and written as a command, not as a general comment.
Start a caution with a simple and clear command. Then add
a brief explanation to give a clear idea of the possible risk.
Example: Make sure that ...... This prevents the record from being deleted.###
*Warning*
A warning tells the reader that injury or death is possible if intructions
are not followed.
Example: Make sure to call back every connected critical customer after
power restoration. Their lives depend on whether or not they get the power
back.###
--Simplified English PSC-85-16598
\\|//
(o o)
----------oOO--( )--OOo----------
Josee Sevigny Technical Writer
joseey -at- m3isystems -dot- qc -dot- ca
M3i Systems Inc., Longueuil, QC
----------oOO-------OOo----------
