API docs for dummies

Subject: API docs for dummies
From: "Mark Lewin" <mlewin -at- supanet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 8 Jul 2004 15:39:57 +0100

Hi all

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

COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .

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.

Previous by Author: STC Evaluations (was Video Icon Placement)
Next by Author: RE: API docs for dummies
Previous by Thread: Re: Longhorn - Tech writing changes
Next by Thread: Re: API docs for dummies

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

Sponsored Ads