Re: So what is API documentation anyway?

["D. Michael McIntyre" <michael -dot- mcintyre -at- rosegardenmusic -dot- com>]

On Sunday 25 March 2007 9:44 pm, A.H. wrote:
> 1. What is it?
> 2. Who on the list does it or has done it?

An API is an Application Programming Interface.  This stuff tells a programmer 
what he needs to know in order to use the functions in a library, for 
example.  In my experience, it serves two primary purposes.  I use it when I 
know I want to use a KSomethingOrOther() object to accomplish something, but 
I don't remember what parameters I need to feed it, or in what order, etc.  I 
also use it to shop for a pre-existing function that already does what I 
need, so I don't write something from scratch senselessly.

I've never really done API documentation in a formal way, but I consume it all 
the time.
-- 
D. Michael McIntyre 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.