API Documentation?

Subject: API Documentation?
From: Geoff hart <ghart -at- attcanada -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 19 Feb 2001 09:01:01 -0500

Marc A. Santacroce wondered:
> 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?

This has been discussed a few times on the list, so you should be able to find
a fair bit of helpful information in the archives. If you're looking for an
actual course on this, there are some local Montreal techwhirling trainers who
have just announced a course on documenting APIs: head over to
www.gordonandgordon.com for contact information. (They have GNU and can
travel.* In fact, they'll be giving a few seminars at the STC conference this
May.)

* gratuitous Paladin/UNIX pun, fyi.

Disclaimer: Gordon Graham, one of the two principals, is a personal friend.
Manny Gordon, the other principal, is also a friend, though I don't see him
much these days. But speaking objectively, the terrible twosome have been
running seminars for Montreal's STC chapter for many years now, and playing to
packed rooms and appreciative audience. Disclaimers notwithstanding, I feel
that speaks for itself.

--Geoff Hart ghart -at- netcom -dot- ca
Pointe-Claire, Quebec, Canada
"Most business books are written by consultants and professors who haven't
spent much time in a cubicle. That's like writing a firsthand account of the
Donner party based on the fact that you've eaten beef jerky."--Scott Adams, The
Dilbert Principle



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17)
http://www.weisner.com/training/dreamweaver_help.htm 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 www.forehelp.com 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
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: Creating watermarks in PageMaker
Next by Author: Forms in all their infinite variety?
Previous by Thread: Antwort: New TECHWR-L Poll Question
Next by Thread: RE: reviewing: the saga concluded


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

Sponsored Ads


Sponsored Ads