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