RE: "Button Gravity" and "Warning Gravity"

Subject: RE: "Button Gravity" and "Warning Gravity"
From: "Downing, David" <DavidDowning -at- users -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 19 Dec 2008 09:33:35 -0600

From: "Lippincott, Richard" <RLippincott -at- as-e -dot- com>
Subject: RE: "Button Gravity" and "Warning Gravity"

[snip]

"Danger" means that failing to follow the procedure as written will
likely result in death.

"Warning" means that failing to follow the procedure as written can
possibly result in serious injury or death.

"Caution" means that failing to follow the procedure as written can
result in damage to the equipment or system. Personally, I include
"crashing the software" as damage (even though nothing is actually
broken, it's something the user might very much want to avoid), so I
insert "Caution" admonitions if getting the next steps wrong will result
in a software conniption.

"Note" is used to provide some additional information that may be of use
or make the user's job easier.

---------

Then technically, I should never use anything stronger than a caution,
because I don't document equipment that could injure or kill people.
However, I -- and some of the other folks in my department -- will
occasionally use warnings for situations where a wrong move could cause
serious corruption and/or destruction of data, with disastrous results
to whatever institution was using the software. Does this seem
acceptable?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

Previous by Author: RE: "Button Gravity" and "Warning Gravity"
Next by Author: User-friendly documentation (was: "Button Gravity" and "Warning Gravity")
Previous by Thread: RE: "Button Gravity" and "Warning Gravity"
Next by Thread: RE: "Button Gravity" and "Warning Gravity"


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


Sponsored Ads