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.
(There's also a paper on OO terms and technolgy there if
you need it.)
Read a book or take a class to learn the programming language
that you need to document. If it's C++ or Java, there are
free good books available at www.bruceeckle.com
Join the nettechwriters group on Yahoo.
Welcome to the club! Good luck!
> From: Siliconwriter <siliconwriter -at- comcast -dot- net>
> Date: 2005/04/11 Mon PM 07:02:10 EDT
> To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
> Subject: writing an SDK
> I'm starting a new job. The first thing they want me to write is an
> SDK. I've never written one. I don't even know what they look like,
> even though I've been documenting software for years. Most of my work
> has been in support of GUIs and CLIs, but I've never been assigned an
> SDK or an API. Any suggestions where to start? Thanks.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: 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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.