Re: API Documentation

Subject: Re: API Documentation
From: "Bill McClain" <bmcclain -at- ibss -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 19 Feb 2001 11:45:41 -0500

Howdy, Marc!

First, a general question for everybody, then stratagems for you:

Doing a quick Google search for the phrase "how to write API
documentation" revealed a whole bunch of API generators implemented in
C, C++, Java, etc. Does anyone have a feel for how useful these
automatic generators have proven for developers?

Generally, I'd look around at a whole bunch of APIs posted on the Web,
see what they have in common, and how they're different. My favorite is
Sun's documentation for Java
(, of which I'm frankly
envious. Even better, when you search the TECHWR-L archives
( for recent entries
containing "API," you'll find more threads than you could shake a stick

Whenever you have a question, the TECHWR-L archives are probably the
better bet than Google (or whatever your preferred flavor of search
engine). The subject matter you're looking for is already far more
focused than in a generalized Web search.

Bill McC

"Marc A. Santacroce" <epubs -at- wwc -dot- com> wrote:

> I've just become aware of the need (at least in the SF Bay area) for
> technical writers who can document Application Program (or
> Programmer) Interfaces. Can anyone point me to of a good "how to"
> reference on APIs?

<I liked your Irish poem>

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See for more information and free evaluation downloads

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.

Previous by Author: Re: Lightbulbs (was Re: HUMOR: Consultants vs ..)
Next by Author: Re: HUMOR: I Need Help
Previous by Thread: RE: API Documentation
Next by Thread: RE: API Documentation

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

Sponsored Ads