vendor documentation in manuals

Subject: vendor documentation in manuals
From: "Lisa Bronson" <Lisa -dot- Bronson -at- ipaper -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 4 Jun 2002 14:38:40 -0500

Hello everyone,

Have you ever put vendor documentation in your instruction manuals? If so,
did it turn out well, and you've continued, or bad, and you've stopped?

I write and illustrate (some new, mostly maintenance) instruction manuals
for liquid packaging machines, the kind that fill cardboard cartons with
milk, juice, fabric softener, etc.

Our machine are made up of hundreds of parts, some of which come with
vendor documentation. My manager told me this afternoon that one of the
engineers suggested we include some of the vendor documentation in the
appendix of our manuals. We could then refer to the appendix from the
parts of the manual that we write ourselves. The engineer thinks it would
save him and us time, because we wouldn't be reinventing the wheel, so to
speak, by rewriting information that already exists.

I have some objections to this technique (will my user be able to find
information easily, translation issues, and copyright issues are at the top
of the list), and I would appreciate any feedback you can give me.

Lisa B.

Lisa Bronson
Associate Technical Writer
Evergreen Packaging Equipment
Cedar Rapids, Iowa

"Writing about yourself is a tremendously powerful exercise. If you want to
know how accurately you perceive reality in the present, try writing about
your perception of your past. You just might discover an entirely new
reality."--Lisa Bronson

Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to

Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


Previous by Author: Online FrameMaker Classes
Next by Author: Technical Communication Survey
Previous by Thread: Re: Declarative vs. imperative
Next by Thread: Re: vendor documentation in manuals

What this post helpful? Share it with friends and colleagues:

Sponsored Ads