Re: API docs for dummies

[Susan W. Gallagher <sgallagher5 -at- cox -dot- net>]

Mark,

Go to my website at http://members.cox.net/susanwg/
and follow the Whitepapers link to "Yesterday API 
was just another acronym; today I have to document
one."

And good luck at the interview!

HTH!
-Sue Gallagher

> 
> From: "Mark Lewin" <mlewin -at- supanet -dot- com>

> I am new to the list and have recently applied for a new role over here in
> the UK which will require me to write API docs for C programmers.  I learnt
> C many moons ago and although I have looked at API docs in the past, I have
> never had to write any.
>  
> Does anyone know of any resources online that might help?  Or any
> particularly good samples of API documentation I could use as a guide?  I am
> anxious to make a good impression at the interview and although they know I
> lack experience in this area, I want to knock up a dummy API doc extract to
> show them I can do it!
>  
> I'd appreciate any pointers!  (Sorry -- bad and unintentional pun....)



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

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l 

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.