Re: FWD: Documenting products integrated with your own

Subject: Re: FWD: Documenting products integrated with your own
From: "Beard, Samuel" <Samuel -dot- Beard -at- GSC -dot- GTE -dot- COM>
Date: Fri, 16 Apr 1999 07:03:00 -0700

Robin Whitmore said:
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.

>>I think that I agree with this. Simply stating that the users can find
detailed instructions for Oracle and SilverStream in their respective user
guides should suffice. Another thing to consider: Even though the program
requires an operating system of some sort, you don't tell the users how to
configure their operating system, do you? This may be somewhat
oversimplistic, but I think perhaps it gets the point across.

Sam Beard
Technical Writer
GSC, GTE (Soon to be GTE-Bell Atlantic, soon to be something else
entirely!!)

From ??? -at- ??? Sun Jan 00 00:00:00 0000=




Previous by Author: Re: Staring into Space
Next by Author: Re: The Worst Thing About Contracting
Previous by Thread: Re: Documenting products integrated with your own
Next by Thread: Re: FWD: Documenting products integrated with your own


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


Sponsored Ads