Re: Task-based documentation-best practice

Subject: Re: Task-based documentation-best practice
From: Steven Brown <stevenabrown -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Feb 2002 09:34:57 -0800 (PST)

>From what you've told us, it sounds like you can
continue with a task-focused format. I'm not sure the
"business" task versus "tool" task distinction is
important; it's really about the user -- user tasks.
Every action the user takes is toward performing a
goal. Anything less and it's entertainment.

So to continue your paint program analogy, where the
user might or might not use a variety of tools (in any
sequence), you should still see a common theme among
them, which will allow you to structure the
documentation appropriately. For example:

Chapter 5: Working with Objects
A. Creating an Object
B. Saving an Object
C. Manipulating an Object
1. Resizing
2. Changing colors
3. Adding sub-objects

...and so on.

Even though you're documenting how to use individual
tools, those tools are used within larger tasks. Even
without a hyperlinking capability, you can refer to
those tool tasks using "see" references within other
tasks. For example:

When you convert an image from an earlier version of
AcmeTool, you can make the following changes:

- resize
- change colors
- add sub-objects

For detailed instructions on making these changes, see
section C.

Hope this helps. Sometimes it's challenging to discuss
these things using hypothetical examples!

Steven Brown
Senior Technical Writer

Do You Yahoo!?
Yahoo! Greetings - Send FREE e-cards for every occasion!

Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002.

Have you looked at the new content on TECHWR-L lately?
See and check it out.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Task-based documentation-best practice: From: etienneg

Previous by Author: Re: HOW TOs?
Next by Author: FW: Menu: what to call it
Previous by Thread: Task-based documentation-best practice
Next by Thread: Updating version numbers in Word

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

Sponsored Ads