Documenting an API

Subject: Documenting an API
From: "Yanick" <yleclerc -at- cadvision -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 23 Dec 2000 18:41:28 -0700

Can anyone suggest guidelines for what a good API document should include
(aside from the input and output of each function with code examples).

ALSO, can anyone refer me to a good example of an API document online or

Thanks in advance.
Yanick LeClerc
(403) 251.4554
2023 7 Av. SE
Calgary, AB
T2G 0k2

Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. or 800-646-9989.

Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off!
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: Help on Help
Next by Author: Re: In Defense of Bourgeois Pedants
Previous by Thread: Re: what's a paragraph; was: Active versus passive (WAS Displays vers us Appears-Which One?)
Next by Thread: RE: Documenting an API

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

Sponsored Ads