Re: Features of a well-written procedure

["Joyce Fetterman" <joycef -at- gtsoftware -dot- com>]

I agree with Mike Stockman (and others) about the number of steps.

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.

I frequently provide a brief outline of lengthy procedures -- a checklist of
sorts for those who need just a reminder about what's supposed to happen.
Then I include the details in the procedure. That way I've provided the info
needed for both new and more experienced users.

Joyce
(enjoying a rare snowy day in metro Atlanta)



Thomas Quine wrote:

A well-written procedure:
* Is clear
* Is short
* Has a title
* Clearly defines the task at hand
* Clearly states the outcome
* Is numbered
* Lists one action per step
* Uses parallelism
* Uses five to seven steps
* Uses the active voice
* Uses graphics where appropriate
* Has a conclusion

Are these features a useful guideline? <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.