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.
My understanding is the (product) functions the same
with one or two modules installed. The difference is
that the production rate is faster with two modules,
otherwise the function is the same. If this is
correct, >>AND<< the majority of customers will
initially order the (product) with two modules
installed, then I suggest document that as the primary
form this product is delivered to the customer.
Then in a separate section in the back of the manual,
document the product (machine or whatever this is)
with one module installed. Specify the differences ?
besides just production rate. Is maintenance (if any)
different? Troubleshooting? Parts replacement? If
there is anything different, document those
differences, if not, refer the customer to section X
of chapter Y of the section that deals with the two
module version.
Stop there for the basic manual. Then write a second
manual for the upgrade from one module to two. This
would be included when a (single module) customer
orders the second module to upgrade the product.
In my experience and opinion as a customer and not
just a writer, making the manual easy to comprehend is
of primary importance. Intermixing explanations of
one and two module products within the same manual
sections is (IMO) not the prudent way to do this. Use
separate sections (not just chapters) within the
manual to document the differences. The KISS
principle applies here too.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
