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.
Assuming that there are no regulatory restrictions in your industry,
then all that matters is that you use consistent standards that are
clear to your audience. You can make a "warning" in your documentation
mean whatever works for you and your customers.
Richard's examples are a fine standard, but as David Patterson says:
"The wonderful thing about standards is that there are so many from
which you can choose."
> -----Original Message-----
> From: Downing, David
> Sent: Friday, December 19, 2008 10:34 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: "Button Gravity" and "Warning Gravity"
>
> 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?
>
This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.
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-