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

["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.
>From what I've seen of this system, though, figuring out a workflow
might not be possible; the system is ridiculously flexible. For this
release, anyway, a reference is the best I can provide.

I'm just dithering over which way of organizing it will make the
information easiest for the admin to find. (Not to worry, there's
plenty of other parts to document while I have this cooking on the
back burner.)

On Tue, Sep 30, 2008 at 2:53 PM,  <jlshaeffer -at- aol -dot- com> wrote:
> Set aside how the software is organized.
> How does the user organize his or her jobs and tasks? The user doesn't care about components or tabs, just work flow.
> If you don't have a job/task analysis or experience to work from (I've been there), pick a technique that creates the simplest-to-use reference materials.
>
>
>
>
> Jim Shaeffer
>
>
> -----Original Message-----
> From: Lin Sims <ljsims -dot- ml -at- gmail -dot- com>
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Sent: Tue, 30 Sep 2008 2:39 pm
> Subject: Opinions, please: Document by the Component or by the Tab?
>
>
>
>
>
>
>
>
> I'm documenting a software product that has multiple components, each
> of which can be configured individually through an administration
> screen. The administration screen for the individual components is
> divided into tabs. Many of these tabs repeat over multiple components.
>
> >From a user's perspective, would it be better to document each
> component, repeating the information for the in-common tabs, or would
> it be better to document the tabs and list which components they are
> used in?
>
> I'd do both if I had time; but I don't, so I won't. (Next edition!
> This is good enough for now!)
>
> Thanks!
>
> --
> Lin Sims
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
>
>
>
>
>
>
>
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 ljsims -dot- ml -at- gmail -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/ljsims.ml%40gmail.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.
>
>



-- 
Lin Sims
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.