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.
QUESTION: one manual for two different editions of the same produ ct?
Subject:QUESTION: one manual for two different editions of the same produ ct? From:JONESC <JONESC -at- DSTM -dot- COM> Date:Tue, 12 May 1998 13:31:02 -0400
Whirlers,
Here's the scenario:
Our company developed an html-based product that interfaces with our
flagship product line (5 versions). 90% of the new application is identical
across all editions of the main product. However, in one version, we added a
single feature that makes the last 10% different in one of the versions.
This difference equates to a single screen shot, paragraph, and field
addition.
My question is this:
Would it be better to (a) create one manual that covers all option including
the version differences within each section as notes to the user, (b) create
one manual that covers all option including the version differences as
separate sections, or (c) create another manual for the different version.
I will be documenting future changes to the product (all versions) so my
vote is for the single source :-)
Thanks in advance for the advice.
______________________________________________________
Chris Jones
Technical Communications
Datastream Systems, Inc.
800.955.6775 ext.5126 mailto:jonesc -at- dstm -dot- com http://www.dstm.com
