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:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:"Shannon Wade" <SWade -at- daktronics -dot- com>, <dvora -at- tech-challenged -dot- com> Date:Thu, 6 Nov 2008 10:14:14 -0800
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.
Leonard
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Shannon Wade
Sent: Thursday, November 06, 2008 7:51 AM
To: dvora -at- tech-challenged -dot- com
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Is there a study on reading warnings, notes?
If the note were something that might prevent them from harm or difficulty, we would include it right there in the applicable text. However, the bulk of our "notes" were things like "Place couplers to allow for vertical and horizontal signal runs." We determined that these weren't worthy of their former note status. They have since been moved into the surrounding text. Anything else would be included within the text as well as in some front matter. I'm all about allowing lawyers to make their living. I'm just not interested in their making a living based on my mistakes! ;)
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-
