RE: Features of a well-written procedure

Subject: RE: Features of a well-written procedure
From: "Michael West" <mike -dot- west -at- oz -dot- quest -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 19 Dec 2000 15:39:36 +1100




Clear? Definitely.

Short? Well, that's relative.

Title? Well, a label of some sort, certainly.

Clearly defines the task at hand? I don't know what that means.

Clearly states the outcome? Yes. Preferably, at the beginning.

Is numbered? If that means broken into numbered steps, yes.

Lists one action per step? Not really. There is room for debate about what
"one action" means.

Uses parallelism? Sure.

Five to seven steps? Not necessarily, but it's a good target.

Uses active voice? Yes, usually. Active voice, imperative mood.

Uses graphics where appropriate? Ah, there we go again! Who decides?

Has a conclusion? No. A conclusion (as I understand the term) isn't needed.
But remember to tell
them what to do next if it matters.


--
Michael West
Technical Writer
Melbourne


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


Previous by Author: RE: Displays versus Appears-Which One? (Passive Voice)
Next by Author: RE: Active versus passive (WAS Displays versus Appears-Which One?)
Previous by Thread: RE: Features of a well-written procedure
Next by Thread: Features of a well-written procedure


What this post helpful? Share it with friends and colleagues:


Sponsored Ads