Re: Warnings at front of document
We have several pages of warnings in the front of our hardware manuals.This thread came at an opportune time as I'm currently reviewing a manual as part of a proposal for a Technical Writing contract for a local manufacturing company. The review document has 23 pages of Safety Information, with most of them actually testing procedures (such as testing the interlocks) versus warnings. While there are legal reasons for some of the boilerplate in the front of this manual....23 pages seems a bit excessive. Basically, it's like saying "Buy our product but don't open the box. Instead, store it in a warehouse far away from any life form forever. Don't bother reading any further. If you have a problem, call our Customer Service hotline. Have a nice day."
These are required by law. Are you referring to those safety and physical hazard type warnings? Or
are you just referring to a list of notes and cautions as part of your
procedures, such as "Caution: make sure not to install the xx device
into a switched power source."
That's different than the physical safety and electrocution warnings at
the front of a manual.
Someone already suggested to check with your company attorney, and I
second that.
--
Al Geist
Technical Writing, Online Help, Marketing Collateral, Web Design, Award Winning Videos, Professional Photography
Voice/Msg: 802-658-3140
E-mail: al -dot- geist -at- geistassociates -dot- com <mailto:al -dot- geist -at- geistassociates -dot- com>
URL: www.geistassociates.com <http://www.geistassociates.com> (online portfolio/resume)
See also:
URL: www.geistimages.com <http://www.geistimages.com> (fine art prints for home or office and note cards for all occasions)
"When the situation is absolutely hopeless, you have nothing to worry about."
Compliments of The Monkey Wrench Gang
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
References:
RE: Warnings at front of document: From: Claire Conant
Previous by Author:
Re: Most annoying word
Next by Author:
How bad an idea is this?
Previous by Thread:
RE: Warnings at front of document
Next by Thread:
RE: Warnings at front of document
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads