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:Fw: Placement of cautions in procedures From:eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 9 Sep 2004 14:48:37 -0400
bounce-techwr-l-106467 -at- lists -dot- techwr-l -dot- com wrote on 09/09/2004 02:32:01 PM:
> The book Single Sourcing - Building Modular Documentation
> by Kurt Ament recommends placing notes and cautions after
> a step for just this reason.
Seems a very poor and lazy work-around to the problem. Scripting and link
checking should be able to ensure links led to applicable warnings and
notes as required.
> Think of it in terms of an
> outline. If you're looking at an outline, do you expect to
> see information relating to an item before the item
> itself? Or does it all follow the number?
But, a procedure IS NOT an outline and the user following it is most
likely not viewing it as such. The user is far more likely to be reading
only what little is required to advance to the next step. In other words,
processing and executing the procedure one line/paragraph at a time.
Unless you are certain that users are instructed to read ALL dangers,
warnings, and cautions after each step before proceeding and that their
use of the procedure in this manner is monitored and enforced, it is very
dangerous to put them after the step.
You want the user to verify that dangerous voltages are removed BEFORE
they perform the step. Not inform their colleagues as to why they are
dead.
Or, similarly, you want the user to know what needs to be done to protect
the equipment being removed BEFORE they lift it up and set it aside. Not
after they've pried it loose, put it down hard, and the component is
shattered beyond repair on the work bench.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
