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: Features of a well-written procedure From:"Bailie, Rahel" <r_bailie -at- trillium -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 20 Dec 2000 08:48:38 -0800
Concise is good for certain audiences, but we need to balance the need for
plain language, as well. Packing procedural steps to create conciseness
sometimes backfires, as people absorb part of a sentence at the expense of
the rest of the sentence. Of course, as techcomm folks, we can rely on user
testing to incidate where the overly-concise sentences need to be "unpacked"
for maximum information absorption.
Rahel Bailie
Joyce Fetterman wrote:
I'd also change the second point from "is short" to "is concise", for many
of the same reasons. Some procedures are complex and must necessarily go
beyond "short". But if they are concise, then there shouldn't be a problem.
Thomas Quine wrote:
A well-written procedure:
* Is short
<bit snip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.