Re: So what is API documentation anyway?

["Guy K. Haas" <guy -at- hiskeyboard -dot- com>]

Here is an extensive example of the documentation of an API.
http://www.google.com/apis/maps/documentation/#The_Hello_World_of_Google_Maps
The application programming interface for Google maps.

The "nut" of the API is found in the class reference at
http://www.google.com/apis/maps/documentation/reference.html
which shows just the absolute nuts and bolts.

But the rest of the "Hello World" addresses the concepts of the API and 
how to use it.

--Guy K. Haas
   Software Exegete in Silicon Valley
    doing API doc in most of the months since 1995

A.H. wrote:
> 1. What is it?
> 2. Who on the list does it or has done it? 
> 
> Anthony
> 
> 
>  
> ____________________________________________________________________________________
> Get your own web address.  
> Have a HUGE year through Yahoo! Small Business.
> http://smallbusiness.yahoo.com/domains/?p=BESTDEAL
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> 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. http://www.DocToHelp.com/TechwrlList
> 
> Now shipping: Help & 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 & Manual: http://www.helpandmanual.com
> 
> ---
> You are currently subscribed to TECHWR-L as guy -at- hiskeyboard -dot- com -dot- 
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/guy%40hiskeyboard.com
> 
> 
> 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
> http://www.techwr-l.com/techwhirl/ for more resources and info.
> 
> 
> 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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. http://www.DocToHelp.com/TechwrlList

Now shipping: Help & 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 & Manual: http://www.helpandmanual.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.