TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
URL: http://www.cosmocom.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. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-