RE: introducing steps

Subject: RE: introducing steps
From: "Michael West" <mbwest -at- bigpond -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 19 Oct 2011 23:20:28 +1100

I've always been a fan of JoAnn Hackos.

Yes, use the heading to declare what you're about to present. No need to
repeat it in the body text.

"Minimalism", if you will.

But more than that, it avoids breaking traditional grammar rules about using
fragments. Not that that is the most important thing. No -- the most
important thing is brevity and clarity.

You people have to understand that among your readers are people to whom
traditional rules still matter. You'd better be across that if you claim to
be "writers".

--
Mike West



-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Arnold, Ann
Sent: Tuesday, October 18, 2011 8:51 AM
To: Becca; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: introducing steps

After taking JoAnn Hacko's course, "Minimalism: Creating Manuals People Can
Use," based on user tests and research, I'd do away with intro sentences all
together whenever possible. Just use the Heading ...

To Add a Gadget to the Widget (heading or subheading)
1. Navigate to the blah blah
2. Select the blah blah from the blah blah

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

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


Previous by Author: Re: introducing steps
Next by Author: Re: Penguins?
Previous by Thread: RE: introducing steps
Next by Thread: RE: introducing steps - translation issues


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

Sponsored Ads


Sponsored Ads