RE: Step One. Done.

Subject: RE: Step One. Done.
From: "Robart, Kay" <Kay -dot- Robart -at- tea -dot- state -dot- tx -dot- us>
To: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>, "Sarah Stegall" <sstegall -at- bivio -dot- net>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Jun 2010 16:04:44 -0500

Your first sentence is very true, but occasionally the purpose of a
window is to view data, in which case I would have an unnumbered
one-step instruction for how to open it and then a detailed description
of what the user is viewing.

However, 50 one-step procedures sounds excessive.

Kay

------------------------------
The purpose of a procedure is to complete some task that fulfills a
goal. It seems weird to me to have 50 or so tasks on the order of
opening a window.

I suggest stepping back and considering whether these one-step
procedures really help users complete a meaningful goal. My guess is
they don't; they should be one step of many toward some higher-level
task. Users' real goals aren't that granular and artificial.

That said, my FM template has a dedicated pgf tag for a one-step
procedure, using a pair of angle brackets in place of a number, so the
procedure looks like this:

To immanetize the eschaton:

>> Blah blah blah

It's used rarely.


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------





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

Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days.
http://www.doctohelp.com/


---
You are currently subscribed to TECHWR-L as kay -dot- robart -at- tea -dot- state -dot- tx -dot- us -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/kay.robart%40tea.stat
e.tx.us


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

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

Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help 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:
Step One. Done.: From: Sarah Stegall
RE: Step One. Done.: From: Combs, Richard

Previous by Author: RE: Step One. Done.
Next by Author: RE: Training - who gets it? How useful?
Previous by Thread: RE: Step One. Done.
Next by Thread: RE: Step One. Done.


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

Sponsored Ads


Sponsored Ads