RE: introducing steps

Subject: RE: introducing steps
From: "Mark Baker" <mbaker -at- analecta -dot- com>
To: "'McLauchlan, Kevin'" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>, "'Laura Lemay'" <lemay -at- lauralemay -dot- com>, "'Becca'" <becca_price -at- yahoo -dot- com>
Date: Tue, 18 Oct 2011 10:50:24 -0400


Kevin McLauchlan wrote:

> So if there are a several prerequisites, you make them
> steps 1 through 4, before step 5 gets to the meat of the
> current procedure?

Indeed. I have always thought the idea of stating prerequisites to a
procedure is asking for trouble. If there are things you have to do before
step 1, then is isn't step 1, is it?

Numbered steps are like catnip to an impatient reader. We should write
procedures as if readers do not read anything between the topic title and
the first numbered step.

Mark

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.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


Follow-Ups:

References:
introducing steps: From: Becca
Re: introducing steps: From: Gene Kim-Eng
Re: introducing steps: From: Laura Lemay
RE: introducing steps: From: McLauchlan, Kevin

Previous by Author: RE: Help - my consultants cannot write!
Next by Author: RE: introducing steps
Previous by Thread: RE: introducing steps
Next by Thread: RE: introducing steps


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


Sponsored Ads