The Right Amount of Safety

Subject: The Right Amount of Safety
From: "Pinkham, Jim" <Jim -dot- Pinkham -at- voith -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 11 Jul 2007 16:41:01 -0500

Safety issues can play prominently in the manuals that we produce. I've
added a lot of back-of-the-book safety resources to our manuals and
cross-referenced them in the main body of the book. Until now, my rule
of thumb has been to reference the document the first time in each
chapter that a situation seems to call for it. In other words, if a
chapter discusses a handful of cases where lockout/tagout may be
warranted, I'll include the cross-reference to my OSHA lockout/tagout
tips upon the first instance of such a situation. Most of my chapters
are short, typically five to 20 pages, so I haven't felt the need to
insert a fresh cross-reference to that same document for every single
time a lockout/tagout situation may come up within the same chapter. I
occasionally make an exception and repeat a reference if there's been a
wide span intervening -- for instance, on page 2 and then again on p.
16. I'm curious, though. How do those of you in similar situations
approach this -- are there guidelines or house rules that you follow as
to an optimal frequency of citation?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


Previous by Author: RE: desktop search recommendations
Next by Author: RE: desktop search recommendations
Previous by Thread: RE: How to Use English Punctuation Correctly - wikiHow
Next by Thread: How do you select translation vendors?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads