Doc Design and Conventions

Subject: Doc Design and Conventions
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 30 Oct 2009 04:49:59 -0700 (PDT)

I think you're defining use cases differently than I do. To me a use
case is a high-level description of the goal and how to achieve it.
How do you see a use case?

------------
"What's the use case for feature X?"

That's backwards.

The user wants to reach the end point of the use case (that is,
achieve some sort of real-world goal) as efficiently as possible. To
that end, good documentation explains which parts of which features to
use in what order to get there.

Only the people who write the software and doc needs to understand the
use cases for the features.
--------------



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

Are you looking for one documentation tool that does it all?&#160; Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.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


Follow-Ups:

Previous by Author: Doc Design and Conventions
Next by Author: Doc Design and Conventions
Previous by Thread: Re: Doc Design and Conventions
Next by Thread: Re: Doc Design and Conventions


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

Sponsored Ads


Sponsored Ads