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: How many warnings are too many? From:"Martinek, Carla" <CMartinek -at- zebra -dot- com> To:"Technical Writing" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 30 Dec 2008 08:59:28 -0600
We've taken the stance that you repeat the warning as often as
necessary, wherever it is needed. Unfortunately, in today's litigious
society, failure to do so can open you up to lawsuits.
"But you told me *there* and *there* in the document not to touch the
cutter blade because it was sharp, but you failed to tell me *here*, and
that's when I got hurt!!!"
Also, with modular reuse of content, general warnings at the beginning
of sections just don't convey the importance needed at times. So, use
the warnings every time you need them. Yeah, it sometimes seems like
overkill, and may look distracting, but unfortunately that's what we've
come to.
And yes, redesigning the product to eliminate the need for them in the
first place is a great goal, but we all have to work with what we have
right now.
-Carla
You can't legislate stupidity or common sense.
- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
