Re: Is this a Caution or a Warning

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.

<snip>

Alert Notices
- - - - - - -
These notices are included to highlight a particular useful fact, or to
prevent you from harming the equipment or yourself. Alert notices follow
these conventions:


NOTE
Provides useful additional information for a particular description or
procedure.

SHORTCUT
Provides a faster way of accomplishing a particular task.

CAUTION!
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.

WARNING!
Alerts the reader to a situation where he/she is at temporary risk of bodily
injury.

DANGER!
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.

<end snip>

I always find myself harassing the software twinkies who insist on putting
the word "WARNING" into minor error messages, as in: "WARNING! File will
be renamed."

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.



Take care, Vikki - hope this helps.



Jim.






On Wed, 30 Jul 1997 07:10:45 -0700, Vikki Shine
<Vikki_Shine -at- NOTES -dot- TERADYNE -dot- COM> wrote:

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!"
<<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>>

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: Daily Messages
Next by Author: Re: Language rules
Previous by Thread: Re: IMI methodology
Next by Thread: Consistancy (was RE: Single-step procedures)


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads