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

["Michael West" <mbwest -at- bigpond -dot- com>]

> 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?

If you want to cater to users, don't "document a software product."

Document how a user gets work done. Organise by functional task, not
interface design.
-- 
Mike West



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

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.