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: Is there a study on reading warnings, notes? From:"Pinkham, Jim" <Jim -dot- Pinkham -at- voith -dot- com> To:"Al Geist" <al -dot- geist -at- geistassociates -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 6 Nov 2008 08:32:12 -0600
Same here. We document a wide variety of machines used in the
manufacture of paper products. The first page of the first chapter in
every manual introduces and describes a standard set of safety icons.
The second chapter includes a standard roster of warnings, notices, and
the like, complete with OSHA cross-references for more information. In
subsequent chapters dealing with installation, operation, and
maintenance, we include warnings and the like in context -- often
repeatedly within the same chapter. These warnings are always called out
with safety icons and a special tabular format that makes them stand out
from the rest of the text. Similarly, when we recommend or suggest that
a user incorporate a specific product as part of a procedure -- an oil
or grease or solvent or anti-seize compound, for instance -- we also
provide technical data sheets and MSDSs in the appendix. We
cross-reference to these appended documents, in context, within the
particular chapter where we make the suggestion or recommendation.
-----Original Message-----
From: techwr-l-bounces+jim -dot- pinkham=voith -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jim -dot- pinkham=voith -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Al Geist
Sent: Thursday, November 06, 2008 6:49 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Is there a study on reading warnings, notes?
Like a few on this list, I document manufacturing systems. These systems
use robots, high pressure pneumatics, hydraulics, extreme pressures,
temperatures up to 500 degrees C, and voltages up to 2000 VDC. Any one
of these can cause serious harm or death to the operator or maintenance
engineer. Some of the systems also use exotic chemicals to clean the
silicon wafers prior to processing. I have no problem telling the
operator or engineer multiple times to use caution and why. I figure
that paper (or
words) are cheap when in comes to an individual's safety. SEMI also
thinks so because much of the safety information is specified by them.
Sometimes, I have to include so many warnings, cautions, and notes that
I wish I were paid by the word.
Al Geist
Technical Communicator, Help, Web Design, Video, Photography
Office/Msg: 802-872-9190
Cell: 802-578-3964
E-mail: al -dot- geist -at- geistassociates -dot- com
Website: www.geistassociates.com
See Also:
Fine Art Photography
Website: www.geistimages.com
"...I walked to work, quit my job, and kept walking. Better to be a
pilgrim without a destination, I figured, than to cross the wrong
threshold each day." (Sy Safransky)
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 Jim -dot- Pinkham -at- voith -dot- com -dot-
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-
