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.
RE: Requoting other companies' docs in your own docs
Subject:RE: Requoting other companies' docs in your own docs From:"David Berg" <dberg -at- dmpnet -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 22 Jan 2001 11:40:58 -0600
> 2. Create a short manual with hyperlinks to the appropriate
> sections in the
> 2 external manuals.
> Problems: One of these is in PDF format and can't be linked to
> (unless there
> is something I don't know about PDFs here).
Depending on your exact situation, I think are probably best off with this
solution for the most part. My company has numerous products that work
together. It's altogether unrealistic to copy everything in every document
where someone might need it. If I can do it very briefly, I offer a short
summary that explains the answer. If I need to offer a more complete
explanation of the relationship between the two products, this is the
perfect place for that. But, if I am in a situation that involves wholesale,
lengthy quote, I refer them to the other manual.
I also state the need for the other manual(s) in the opening sections of the
document. I think your boss should see the logic. Hey, tell him you're not
being lazy, you're saving the company money by not re-publishing information
the user will already have in the other company's manual. <g>
David Berg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
