TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> I'd like to be directed to a good site / book / article about SDK
> documentation... what it IS, what it consists of, how to go about it, etc.
> Thanks!
You might want to join our API/SDK Tech Writers Yahoo group, Dennis. You can
join at http://groups.yahoo.com/group/nettechwriters/. The group is
specifically for those of us who do API and SDK documentation. If you post
your question there, I think you'll get some good feedback. However, there
isn't a lot to go on in general for this kind of documentation (no books
that I know of, for example). If you're worried about too much mail from the
list, don't be. We're very on target and we must be a busy group, because we
don't have oodles of traffic.
I will second Geoff's recommendation of Gordon and Gordon's workbook. It's
an excellent starting place. (I know Manny Gordon too, but I bought the
workbook before I met him, so I'm not too biased. ;-)
Finally, the archives in TechWr-L are a good place to look for information.
Over the years there have been many good posts about API and SDK writing.
HTH,
Lydia
---------------------------------------
Lydia Wong
Technical Writer
FarPoint Technologies, Inc.
www.fpoint.com
Moderator, API Tech Writing Yahoo Group
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here: http://www.ehelp.com/techwr-l
Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....
---
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.
