RE: managing, updating, incorporating 3rd-party docs

Subject: RE: managing, updating, incorporating 3rd-party docs
From: "Nuckols, Kenneth M" <Kenneth -dot- Nuckols -at- mybrighthouse -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 14 Jun 2005 12:29:02 -0400

Sean wrote:

> We integrate a number of third-party applications/technologies into
> product and part of the integration process is re-labeling the
> documentation (switching product names, updating screen shots, etc).
> example, our application integrates technology Nifty from Groovy Techi
> Corp. We receive the Nifty source documentation and go through and
> content and formatting changes to make it consistent with our own
> documentation.

Sean, I have to perform a similar process for 3rd party product
documentation that we use. As a service provider, we buy hardware from
many vendors and incorporate it into the service we provide commercial
and residential customers. The majority of my documentation is
non-external customer facing, but several different departments need to
know different parts of the product operation. For example one team
configures the routers, broadband modems, and other devices while
another team goes into the field to perform the installation at the
customer's home or business.

So what I wind up having to do is often re-write entire sections of
vendor documentation, giving my reader only the information he or she
needs to perform their job function (and integrating
non-product-specific procedures relating to network settings and
corporate policies). I'm fairly new in this company, so I haven't seen
how rapidly our vendors update and upgrade their hardware. I would also
be interested in what people do to track such changes, especially since
in my case it may prompt edits or re-writes of several documents for
several end user audiences.



New from Quadralay Corporation: WebWorks ePublisher Pro! Easily create
14 online formats, including 6 Help systems, in a project-based
workflow. Live, online demo!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release.

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 lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Does a rhetorical question need a '?'
Next by Author: RE: general topic of spelling
Previous by Thread: managing, updating, incorporating 3rd-party docs
Next by Thread: RE: managing, updating, incorporating 3rd-party docs

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

Sponsored Ads