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 11:26:26 -0400


> 4) Know, without further info, that the following steps are
> the right thing to
> do now, in your situation, or skip the next seven steps.

Some readers will know they are in the right place. Some will assume they
are in the right place. Some will not be sure if they are in the right
place. The fact that only the third group will read the introductory
material does not mean you should move the introductory
is-this-the-right-thing-to-do material into the steps. It's proper place is
at the top of the topic. That is where those who want to read it will expect
to find it. It is just not safe or appropriate to write the procedure as if
everyone will have read the introductory material.

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


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

Previous by Author: RE: introducing steps
Next by Author: RE: The legalese pages
Previous by Thread: RE: introducing steps
Next by Thread: Re: introducing steps


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


Sponsored Ads