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: Is this a Caution or a Warning From:Jim McAward <jimmc -at- CHYRON -dot- COM> Date:Fri, 1 Aug 1997 12:18:41 -0400
I use the following boilerplate definitions in all my products, and demand
that my writers observe them.
- - - - - - -
These notices are included to highlight a particular useful fact, or to
prevent you from harming the equipment or yourself. Alert notices follow
Provides useful additional information for a particular description or
Provides a faster way of accomplishing a particular task.
Alerts the reader to a situation where the EQUIPMENT may be at risk, or
where some critical function (such as on-air behavior) may be affected.
Alerts the reader to a situation where he/she is at temporary risk of bodily
Alerts the reader to a situation of *continued* risk of bodily injury, such
as when performing adjustments to a machine where the power must be on for
the duration of the adjustments.
I always find myself harassing the software twinkies who insist on putting
the word "WARNING" into minor error messages, as in: "WARNING! File will
However, our products are used in on-line broadcast environments, so
sometimes a CAUTION is warranted for a software thing. One small example is
that the entire Super Bowl video feed passes through one (or more) of our
systems; a spontaneous reboot could disgruntle lots of high-paying sponsors
to the tune of $1,200,000 per minute. This warrants a CAUTION, even in my book.
I have to include a note in the a power supply maintenance manual that I am
writing. The company that I worked for is now using liquid-cooled test
systems and high voltage. When needed, I have to use the following note:
James G. McAward Chyron Corporation
Manager, Melville, NY 11747
Technical Publications http://www.chyron.com
"So many facts, so little time!"