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.
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,
right?
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
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: http://www.ehelp.com/techwr-l4
---
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.
