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: FWD: Documenting products integrated with your own
Subject:Re: FWD: Documenting products integrated with your own From:Robin Whitmore <robin -dot- whitmore -at- CYGENT -dot- COM> Date:Thu, 15 Apr 1999 10:24:02 -0700
Anon said:
>
>My company has developed a client-server product that relies on several
>third-party applications, including SilverStream Application Server,
>Oracle, and Netscape/Internet Explorer.
>
>I'm wondering what should be documented about these third-party products.
My personal experience has been if you document something, you're
responsible for any problems users might have when following that
documentation. Therefore, if you document how to tune up a database or
application server, you will most likely receive tech support calls
regarding those procedures. And since SilverStream and Oracle are best
equipped to handle those calls, you should leave the documentation up to
them.
I think stating that your app works best when "he SilverStream application
server is configured to blah blah blah....See the SilverStream User guide
for detailed instructions." is fine. Just make sure that the user can find
the needed info in the SilverStream documentation based on the way you
reference it.
