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: Warnings at front of document From:"Claire Conant" <Claire -dot- Conant -at- Digeo -dot- com> To:"Al Geist" <al -dot- geist -at- geistassociates -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 28 Feb 2006 14:20:04 -0800
Al Geist wrote:
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."
Yes, that does seem excessive. One of our hardware manuals has four
pages of small print warnings. Some of the warnings appear to be
mandated by the FCC (since the manual is for a set-top box) and there is
a diagram of antenna grounding. Pretty typical I think for this sort of
guide. I vaguely recall questioning it myself when I first started here
but this thread is making me question it again. Inquiring minds want to
know: WHY? Do we really have to include all that stuff?
Pretty much, though: What Al said.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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