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:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 6 Nov 2008 10:42:16 -0800
This is why there's a distinction between warnings, cautions
and notes, and why warnings often are accompanied by
graphics of human forms being crushed, burned, gassed,
poisoned or otherwise folded, spindled and mutilated.
A partial list of my past products, both as an engineer and
a writer (I think I've mentioned some of these previously):
Helicopter rescue hoists
Handling and loading equipment for ICBMs
Semiconductor fabrication equipment (lethal chemicals, megavoltages, lasers)
Mass spectrometer and chromatography instruments (more lasers)
DNA sequencers (still more lasers)
Architectural/industrial scanning equipment (surprise! lasers again)
Aircraft power management systems
The risks involved with operating some of these incorrectly
may not be immediately obvious; others you'd hear about
immediately if someone made a big enough mistake.
Gene Kim-Eng
----- Original Message -----
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
Granted I get the gist of the example you provided, I agree that it would work
better were it integrated into the procedure (rather than as a call-out). It
sounds more like an essential consideration that is part of the procedure rather
than something external to the process. You might also consider telling the user
why he needs to do that or what will happen if he ignores the directions. For
example, "Place couplers to allow for vertical and horizontal signal runs; this
will enable to job to complete without interruption."
It also occurs to me that if you use call-outs for non-critical information,
user's might start ignoring callouts and miss those that truly are critical.
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-