Re: introducing steps

Subject: Re: introducing steps
From: Laura Lemay <lemay -at- lauralemay -dot- com>
To: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
Date: Tue, 18 Oct 2011 08:07:43 -0700


Uh, I was addressing the original question of how to grammatically introduce a serious of steps, not how to structure a help topic overall.

But since you asked, no, I don't put prerequisites in steps. These days it seems like prerequisites, the actual steps, and next steps are spelled out explicitly in the structure of the topic itself with headings and jump links, something like this:

FLIBBERING THE FOOBAR

+ Before You Start

Greasing the Gobsmack
Macking the Macaroon

+ Steps

1. ...
2. ...
3. ...

+ Where to Go From Here

Noodling the Nightengale


On Oct 18, 2011, at 7:27 AM, McLauchlan, Kevin wrote:

> Laura Lemay wrote.
>
>> My
>> personal preference these days in the absence of a style guide is to
>> remove as much introductory text as possible, because people just don't
>> read it.
>
> 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?
>
> Assuming a Help page/topic, and not a linear manual, how
> do you know the person arriving at your un-introduced
> instructions has been through any previous procedures,
> or has brought necessary objects or information to
> the current set of steps?
>
> - kevin
> <bumpfstart>
> The information contained in this electronic mail transmission
> may be privileged and confidential, and therefore, protected
> from disclosure. If you have received this communication in
> error, please notify us immediately by replying to this
> message and deleting it from your computer without copying
> or disclosing it.
>
>

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

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: introducing steps
Next by Author: references was Re: STC certification program
Previous by Thread: RE: introducing steps
Next by Thread: RE: introducing steps


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

Sponsored Ads


Sponsored Ads