Re: Opinions, please: Document by the Component or by the Tab?

Subject: Re: Opinions, please: Document by the Component or by the Tab?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>, <jlshaeffer -at- aol -dot- com>
Date: Wed, 1 Oct 2008 11:55:54 -0700

I wouldn't discount the possibility that task-based
documents might not be desired by a product's
users. But I would still maintain that everyone
working on the development should still be able
to tell you what the most common tasks are
without having to go away and perform some
kind of "analysis." How do you develop and test
a product, much less document it, if you don't
know what it's supposed to do?

Gene Kim-Eng


----- Original Message -----
From: <jlshaeffer -at- aol -dot- com>


>I have observed a tendency to abandon task-based documentation at the
>System Administrator level. The tasks are seen as so ad hoc, fluid and
>unpredictable that creating reference manuals for the tools available
>is all we can do. Developers also believe that reference works are all
>that system administrators would really want. (I'm not arguing in favor
>of this approach, just observing that it seems fairly common.)

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

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-

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.


Follow-Ups:

References:
Re: Opinions, please: Document by the Component or by the Tab?: From: Gene Kim-Eng
Re: Opinions, please: Document by the Component or by the Tab?: From: jlshaeffer

Previous by Author: Re: Opinions, please: Document by the Component or by the Tab?
Next by Author: Re: Ten Technical Writing Stereotypes
Previous by Thread: Re: Opinions, please: Document by the Component or by the Tab?
Next by Thread: Re: Opinions, please: Document by the Component or by the Tab?


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


Sponsored Ads