RE: Looking for Doc Class Recommendations (or How You Learned toLove Documenting APIs)

["Barry Kieffer" <Barry -dot- Kieffer -at- worldwidepackets -dot- com>]

Hi Marsha,

One way to learn to document API's is to review a few. Sun Microsystems is a good place to start ( www.sun.com ) 

Also, try a Google or other web search on API and take a look-see at some of the API documentation other tech writers have put together.

Barry Kieffer
Portland, Oregon  USA





-----Original Message-----
From: marsha_howard -at- peoplesoft -dot- com 

Rephrasing my 12/21 question (Information Request for API Class) since I
didn't get any responses:

Has anyone ever taken a class on documenting APIs? If so, which one did you
take and would you recommend it to a relative newbie? If not, how did you
learn to document APIs? Thanks.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sponsored by eHelp Corporation, makers of RoboHelp - the industry standard
in Help authoring. Download a trial version today or get special savings when
you buy the RoboHelp 2002 Holiday Edition. Visit http://www.ehelp.com/techwr

---
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.