RE: "Documenting APIs and SDKs" review?

["Lydia Wong" <lydiaw -at- fpoint -dot- com>]

Carol asked about Gordon and Gordon's workbook based on their "Documenting
APIs and SDKs" workshop. We purchased the book, and I do recommend it. It's
a very nicely designed set of PowerPoint slides from their workshop. We
think it will be invaluable for training new writers here to document our
products' APIs. Gordon and Gordon has money-back guarantee. If you purchase
it and find it doesn't suit your needs, you can return it.

Do note that it is not a textbook, though. It's slides from their
presentation. Therefore, it doesn't have a narrative flow. However, it's
very well organized, and is a nice entry point for someone needing to learn
the basics of what's involved in API documentation. Also, it has an
excellent glossary and list of resources. There's even some humor in it!

HTH. Please feel free to contact me off-list if you have more questions
about the workbook.

Lydia
__________________
Lydia Wong
Technical Writer
FarPoint Technologies, Inc.
www.fpoint.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.