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

[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.)



Jim ShaefferÂ


-----Original Message-----
From: Gene Kim-Eng <techwr -at- genek -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Wed, 1 Oct 2008 10:25 am
Subject: Re: Opinions, please: Document by the Component or by the Tab?








If your developers and/or product manager are
unable to list, without someone performing a new 
"analysis," the most common tasks they designed
the product to perform, you all have much more
serious issues than which way to document the
components and tabs.

Gene Kim-Eng


----- Original Message ----- 
From: "Lin Sims" <ljsims -dot- ml -at- gmail -dot- com>
> This guide is strictly for the administrator of the system. Ideally,
> the administration settings should be a "set it and forget it"
> situation. Much as I'd like to create a workflow and make the docs
> task-based, I've been given no time to do the analysis work necessary.





 




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

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.