RE: So what is API documentation anyway?

Subject: RE: So what is API documentation anyway?
From: "Walden Miller" <wmiller -at- vidiom -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 25 Mar 2007 21:39:00 -0600

On Sunday 25 March 2007 9:44 pm, A.H. wrote:
> 1. What is it?

Generically, API docs are the detailed functional description of all the
calls/methods/functions/interfaces to "something" that you need to
control/access/manipulate as a programmer. What is boils down to is a lot
of descriptions of java/c/c++/language of choice functions + all the
defines, variables, etc. used in a specific system. I think the largest set
I documented was in the 3000 function range for an authoring tool
(OpenAuthor) or a middleware (Balboa for CD-i). Hard to say. Lots and lots
of pages before PDF was popular :)

> 2. Who on the list does it or has done it?

I spent 15 years (1985-2000) writing API docs for operating systems and
middleware (system level calls to the OS, drivers, etc.) as well as API docs
for authoring tools to write multimedia apps. Many other folk in the list
(lurking out there) have also done so.

There has been much written in the archives concerning API docs. The
questions about API docs usually gravitate to what do you have to know to
write API docs, how hard can it be, etc.

I would direct you to the archives and then if you still have questions,
please fire away... On list or off.



Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output.

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Re: So what is API documentation anyway?: From: D. Michael McIntyre

Previous by Author: RE: What do I call this doodad?
Next by Author: Re: Rant... please let me help you fix the user interface
Previous by Thread: Re: So what is API documentation anyway?
Next by Thread: Re: So what is API documentation anyway?

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

Sponsored Ads

Sponsored Ads