Re: writing an SDK

Subject: Re: writing an SDK
From: Susan W. Gallagher <sgallagher5 -at- cox -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 11 Apr 2005 20:16:44 -0400


Actually, APIs and SDKs don't look like much of anything.
You've just become the UI. <g>

Start by reading "Yesterday API was just another acronym;
today I have to document one!" at this link:

http://members.cox.net/susanwg/susanwg/api.html

(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!
-Sue Gallagher

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



Previous by Author: Re: "Transparent to the User"
Next by Author: Re: Re: writing an SDK
Previous by Thread: writing an SDK
Next by Thread: Re: writing an SDK


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

Sponsored Ads


Sponsored Ads