Re: Help on Adapter Documentation

Subject: Re: Help on Adapter Documentation
From: Goober Writer <gooberwriter -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 14 Nov 2003 05:51:33 -0800 (PST)

> We have an Enterprise Application Integration (EAI)
> product. We need to
> prepare user guide for an adapter documentation? Can
> anyone please tell me
> what goes into the documentation. Any URLs for
> reference would be useful.

Well, the adapter, I assume, is what "plugs" your
integrated pieces into the enterprise application,

First determine your audience... Who manages it? How
is it installed? What do people do with it once they
have it? Who uses it?

There is no set-in-stone way of documenting this. You
just have to do the leg-work to determine the
who/what/where/when/why/how surrounding your adapter
and focus your documentation to clarify those concepts.

Goober Writer
(because life is too short to be inept)

"As soon as you hear the phrase "studies show",
immediately put a hand on your wallet and cover your groin."
-- Geoff Hart

Do you Yahoo!?
Protect your identity with Yahoo! Mail AddressGuard



RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at:

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.

Help on Adapter Documentation: From: Anagha . Mulay

Previous by Author: Re: NASA Technical Documentation WAS RE: An urban legend regarding documentation?
Next by Author: Re: Distilling oversize Visio page
Previous by Thread: Help on Adapter Documentation
Next by Thread: Re: Help on Adapter Documentation

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

Sponsored Ads