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: Placement of cautions in procedures From:"Spreadbury, David " <David -dot- Spreadbury -at- afc -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 9 Sep 2004 10:37:40 -0500
Mil-38784 clearly defines when and where any type of admonishment
(Caution, Warning, Note) should appear.
-----Original Message-----
From: bounce-techwr-l-149767 -at- lists -dot- techwr-l -dot- com
[mailto:bounce-techwr-l-149767 -at- lists -dot- techwr-l -dot- com] On Behalf Of HSC
Italian
Sent: Thursday, September 09, 2004 10:31 AM
To: TECHWR-L
Subject: Placement of cautions in procedures
Hello,
I was wondering if anyone on this list knows of any good resources that
clearly defines where cautions/warnings should be placed within a set of
procedures, and how often they should appear.
The following example is how I was taught (to put the cautions before
the
step):
1. Remove the push-in fastener that secures the head-open flag indicator
to
the toggle shaft. Remove the head-open flag.
2. Remove the screw from the head-open latch. Remove the latch.
Caution: Wear protective eyewear when installing or removing E-rings,
C-clips, snap rings, springs, and mounting buttons. These are under
tension and could fly off.
3. Remove the C-clip from the end of the auxiliary roller shaft.
If anyone has any insight, resource, and the like, you feedback would be
much appreciated. In addtion, how often should cautions/warnings appear
in procedures, just in the first instance, or before each instance the
caution/warning is needed.
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.
