Re: the dearth of documents on documenting APIs and SDKs

Subject: Re: the dearth of documents on documenting APIs and SDKs
From: Scott Wahl <wahl_scott -at- yahoo -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 10 Jul 2001 08:42:43 -0700 (PDT)

Hi Mandy,

Perhaps one of us will take up the challenge ;-)

In the meantime, the best way to learn is to read
other published API and SDK documentation, and
programming guides in general.

Then talk to programmers about their experiences: what
type of information have they found useful or useless?

Finally, talk to customer support folks who support
third-party developers using SDKs: what is the source
of most customer problems? What sort of information
are they looking for?

./Scott

--- Mandy Wells <mwells -at- valadeo -dot- com> wrote:
> And I, too, have looked high and low for a book on
> writing APIs and SDKs [snip] there is nothing [snip]
for writing APIs and SDKs.
>
> Why is that? And, why haven't one of you brilliant
> API/SDK documenters
> documented the process [snip]

__________________________________________________
Do You Yahoo!?
Get personalized email addresses from Yahoo! Mail
http://personal.mail.yahoo.com/

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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com


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


References:
the dearth of documents on documenting APIs and SDKs: From: Mandy Wells

Previous by Author: Re: Summary: A/An
Next by Author: Re: The action of creating a JAR file
Previous by Thread: the dearth of documents on documenting APIs and SDKs
Next by Thread: RE: the dearth of documents on documenting APIs and SDKs


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


Sponsored Ads