TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Opinions, please: Document by the Component or by the Tab?
Subject:Opinions, please: Document by the Component or by the Tab? From:"Lin Sims" <ljsims -dot- ml -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 30 Sep 2008 14:39:45 -0400
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 archive -at- web -dot- techwr-l -dot- com -dot-