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.
On Tue, 14 Sep 2004 08:53:42 -0700 (PDT), Leo Hill <leochill -at- yahoo -dot- com> wrote:
> 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.
Some amount of maintenance is different, too. For example, in the air
system, a solenoid on the base module might be number 1A, and the
corresponding (same feature) solenoid on the second module would be
2A. There is only one exception to that, where the solenoids serve a
different function on each side.
To answer someone else's question, I am using FrameMaker. I am also in
the process of learning how to use FrameScript for some fancy content
management, above and beyond what can be done with conditional text. I
do not want two separate books for this.
The way I see it after reading various comments is I have two options:
1) I can write about the base module and add a single chapter that
contains all the differences between the two modules.
2) I can write about the base module and insert notes about the second
module as applicable throughout the book.
For the way our users work (these are operators running the machines
and mechanics maintaining and repairing the machines), it would
probably be easiest for them to have the notes throughout rather than
in one section.
Or... (does anyone else find that some of their best ideas come while
trying to explain a situation to someone else? *grin*) Perhaps,
through content management, I could write the "Differences" chapter,
and pull pieces of it into the individual sections, thereby having the
best of both worlds... hmm... that actually seems like it might be the
way to go.
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.
