RE: Is there a study on reading warnings, notes?

["Lippincott, Richard" <RLippincott -at- as-e -dot- com>]

Leonard C. Porrello wrote:

 

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."

 

Best definition of a "Note" I ever heard was that while it provides
useful information and is an aid, you could take it completely off the
page and the user would still be able to perform the procedure without
impediment. 

 

Going by that, a "Note" shouldn't have any action in it at all, just an
explanation of why some actions are being taken.

 

Using Leonard's example, I'd say that sentence should be broken down
into a Note and a step, as follows:

 

Note: Correct coupler placement allows the job to complete without
interruption.

 

1.	Place couplers to allow for vertical and horizontal signal runs
2.	Etc....

 

Rick Lipincott
Technical Writer
AS&E* 
American Science & Engineering 
829 Middlesex Turnpike
Billerica, MA  01821-3907
978-262-8807 (direct)
978-495-2335 (mobile)
978-262-8702 (fax)

 


This message is intended only for the addressee and may contain information 
that is confidential or privileged. Unauthorized use is strictly prohibited 
and may be unlawful. If you are not the intended recipient, or the person 
responsible for delivering it to the intended recipient, you should not read, 
copy , disclose or otherwise use this message, except for the purposes of 
delivery to the addressee. If you have received this e-mail in error please 
delete it and advise AS&E immediately.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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- 

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. 

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat