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: "Obvious" warnings - drawing the line From:letoured -at- together -dot- net To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 05 Aug 2002 15:20:08 -0400
In <3D4ECBE2 -dot- FF4929A4 -at- optonline -dot- net>, on 08/05/02
at 03:02 PM, Peter <pnewman1 -at- optonline -dot- net> said:
>letoured -at- together -dot- net wrote:
>>
>> The answer is not that complicated. -- The general rule is simple;
>>
>> If doing something or not doing it can lead to an injury or death, it gets a
>> warning. If doing something or not doing it can lead to equipment damage, it
>> gets a caution note. And if there is something that isn't part of a step or
>> sequence, but useful to the user, it gets an advisory note -- especially if
>> the lack of the information could lead to an action that would call for a
>> warning or caution at a later point in the procedure.
>>
>> Think "root cause" for general guidance; If the worse happened, could one
>> element of prevention be traced back to the lack of a warning, caution or
>> note. If so, it needs one of them.
>Not quite that simple. would you include a warning on every coil of rope not
>to tie a loop around your neck when standing on a ladder. I know someone who,
>before he went on a roof, tied a length of rope around his waist and
>anchored the other end to the bumper of his truck. He climbed on the roof and
>his wife then drove the truck away. Would you put a complimentary warning on
>the truck bumper. "Caution, anchoring a rope to this bumper which is tied to
>your waist could cause serious injury if you go on a roof."
You understood what I meant. Of course if you want to make the argument that
you didn't understand, go ahead -- but writers who work on utility systems,
chemical plants, railroads, shipbuilding, military equipment, and more -- know
them quite well.
They work and very well, unless the writer is a complete dummy taking things
to the extreme <s> -- which not only wouldn't get past the sign-off review,
but neither would the writer if he ever tried it again.
-----------------------------------------------------------
letoured -at- together -dot- net
-----------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Save up to 50% with RoboHelp Deluxe. Get 2 great products for 1 low price!
You'll get RoboHelp Office PLUS RoboDemo, the software demonstration tool
that everyone's been talking about. Check it out and save! http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.