Inserting Use Cases in Online Help

Subject: Inserting Use Cases in Online Help
From: "Ronald Schwarz" <RSchwarz -at- cosmocom -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 6 Oct 2008 13:05:27 -0400

My Product manager wrote the official Documentation Plan for the new product release. He included examples of different use cases in one of the user documents. In my ten years of experience in other companies, use cases were not included in user instructions.

Is it an idea to insert use cases as configuration examples following a normal set of user instructions for a "generic" situation?

What is a good argument to use against the inclusion of the use cases? 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.

Ronald Schwarz

Senior Technical Writer

CosmoCom, Inc.
121 Broad Hollow Road
Melville, NY 11747 USA
Phone: +1 (631) 940-4320
Fax: +1 (631) 930-3252
EMAIL: RSchwarz -at- cosmocom -dot- com

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.


Previous by Author: Additional new features
Next by Author: RE: Survey Results for 10 Technical Writing Stereotypes
Previous by Thread: Re: Additional new features
Next by Thread: Re: Inserting Use Cases in Online Help

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

Sponsored Ads