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:Mon, 18 Dec 2000 08:44:12 -0800
I would add another point. Because procedures are ways to carry out policy,
a procedure should be traceable to its policy; to keep the procedures from
being used for purposes not intended, each policy should have an intent
statement that is reflected in the related procedures.
Rahel Bailie
-----Original Message-----
From: Thomas Quine [mailto:quinet -at- home -dot- com]
Sent: Monday, December 18, 2000 5:50 AM
To: TECHWR-L
Subject: Features of a well-written procedure
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? If anyone would care to comment, I'll
post a summary later...
- Thom
www.documen.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
