Documenting SDK's

Subject: Documenting SDK's
From: Diane Evans <DianeE -at- LOCKSTREAM -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 5 Oct 2001 07:34:24 -0700

Thanks for the information that all of you gave me. It appears to boil down
to this (correct me if I am wrong):

- There is no standard way to document an SDK.
- There are no books explaining how to document an SDK.
- Only one firm,, has tackled the training issue.
Their book is a compilation of PowerPoint slides used during their
- Most people who document SDKs have learned on their own.

So, my fellow tech writer and I (yes, we have doubled the size of our
documentation team!) are going to dive in and hopefully put out something
acceptable. Again, thanks to all who responded to me.

Diane Evans
Information Developer
Lockstream, Inc.
425-709-6840 x 230

Ask for the moon, and settle for its reflection in the pond in your back


Planning to attend IPCC 01, October 24-27 in Santa Fe? Sign up by
October 3 and get a substantial discount! Program information,
online registration, and more on

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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 for more resources and info.

Previous by Author: Writing SDKs
Next by Author: RE: Replacing text in Word - macros
Previous by Thread: Re: Theory? (of Web design)
Next by Thread: Re: Documenting SDK's

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

Sponsored Ads