RE: Inserting Use Cases in Online Help

Subject: RE: Inserting Use Cases in Online Help
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 9 Oct 2008 09:49:11 -0400

Dana Worley was heard to say:

> On Monday, October 06, 2008, Ronald Schwarz wrote:
> > Is it an idea to insert use cases as configuration examples
> > a normal set of user instructions for a "generic" situation?
> >
> > What is a good argument to use against the inclusion of the use
> > It seems to me the right place to include such data is internal
> > documentation for advocating the creation of new features, in
> > marketing documentation, and sales presentations.
> If the use cases subsequently tell how to solve the problem using the
> product, then I think
> they have a perfectly legitimate place in the document.

For a complex or flexible product, I think that one of the best uses of
use cases in Help (or other customer docs) is that it shows the product
in action, in a fairly complete, end-to-end fashion. It might not be
exactly what the reading customer intends to do, but it's a starting
point to get them thinking how the product might be used in their

That said, I don't have a lot of use-case material. I'm always looking
for more. But even the examples that I provide for commands and
operations can be useful for somebody who has a different need than the
one for which the example was written.

What's happened more than once is that somebody has bought our hardware
and toolkit because it had certain specific capabilities, and they had a
certain method in mind (which is why they sought a product with specific
capabilities) - but they noticed an example for some other set of
commands and options that they hadn't even considered, and decided to go
a different (more efficient or more comprehensive) direction with their
own development.

- Kevin
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.


ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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

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 for more resources and info.

Inserting Use Cases in Online Help: From: Ronald Schwarz
Re: Inserting Use Cases in Online Help: From: Dana Worley

Previous by Author: RE: Quality posters from PPT?
Next by Author: !RE: injecting a little whimsy into grey text
Previous by Thread: Re: Inserting Use Cases in Online Help
Next by Thread: Booklets or anything saddle-stitched

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

Sponsored Ads