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: "always read and follow the instructions" From:Keith Hood <klhra -at- yahoo -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 3 Jun 2008 10:29:37 -0700 (PDT)
Yes. Do you have conventions about different alert
levels? In one projects I worked on, each procedure
might include some sort of note to alert the reader to
possible hazards.
We used a "Danger" note (with a little graphic of a
lightning bolt to represent a shock hazard) when doing
something wrong might cause physical hard. We had a
"Warning" note with a graphic of a stop sign when a
mistake could result in damage to the system. The last
was a "Caution" that included an oversize exclamation
mark, to indicate where a mistake could cause loss of
data or communication.
Before 9/11/2001, the "Danger" note had a graphic of a
little round bomb with a burning fuse. The boss made
us change it the next day.
> We put a list of all the consequences and safety
> warnings right up front, but never miss a chance
> to slap readers on the side of the head one last
> time before they start working a procedure.
>
> Gene Kim-Eng
>
>
> ----- Original Message -----
> From: "Keith Hood" <klhra -at- yahoo -dot- com>
> > In a situation like that, I think it should read
> "To
> > prevent death or injury, you must..." Give them
> that
> > reason right up front, and they're more likely to
> pay
> > serious attention to the instructions.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to
> Help file formats or
> printed documentation. Features include support for
> Windows Vista & 2007
> Microsoft Office, team authoring, plus more.
>http://www.DocToHelp.com/TechwrlList
>
> True single source, conditional content, PDF export,
> modular help.
> Help & Manual is the most powerful authoring tool
> for technical
> documentation. Boost your productivity!
>http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as
> klhra -at- yahoo -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/klhra%40yahoo.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.
>
>
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-