Book on Documenting APIs/SDKs

Subject: Book on Documenting APIs/SDKs
From: tgr -at- lanminds -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 05 May 2003 17:39:32 -0700

Thanks to my tireless efforts to find resources about documenting APIs and SDKs, I have come across a book on the subject by a self-published technical writer and trainer in the San Francisco Bay Area. I know there have been occasional discussions on the topic of such resources and the lack of them. So, I pass along a link to the author's web site where you can download a sample of the book in PDF format. It is written by and for a technical writer and it explains what a technical writer needs to understand and do to present information useful to developers. I have no association with the author and make no claims about it, other than that it seems to fill an important niche.

If anyone knows of other tech-writer specific books on this subject, I would love to learn about them. Please share.

- t

I can't understand why people are frightened of new ideas. I'm frightened of the old ones.

- John Cage, avant-garde composer, poet, essayist, painter, pianist


Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.
Order RoboHelp today:

ATTENTION FrameMaker Users: Fill-out the following survey to receive a chance to win a FREE RoboScreenCapture.
FM users only please:

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: about
Next by Author: RE: Graphics within FrameMaker
Previous by Thread: Re: Excel 2000 file size.
Next by Thread: Re: Book on Documenting APIs/SDKs

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

Sponsored Ads