Periodically on the Zone page, we post free resources we hope will be of interest to technical writers interested in documenting APIs.
Jim gave a talk, “Documenting APIs: Your First Week on the Job” and the PowerPoint slides from the Silicon Valley STC Chapter meeting are available for download.
“When I Grow Up, I Want to Write API Docs” is a basic presentation about documenting APIs that Jim gives at STC regional conferences and chapter meetings.
Our book Documenting APIs: Writing Developer Documentation for Java APIs and SDKS is in its second printing. We are fulfilling orders now.
Please note that due to the deep discounts demanded by places such as Amazon, we are only selling the book through our web site, speaking engagements, and at conferences.
Included free of charge with the book is a 26-page study guide that covers the first three chapters. The study guide covers conceptual basics (including what is an API), an overview of developer documentation, and setting up your environment.
“Chapter 2 was WONDERFUL!!! I had so many 'aha moments', I quit counting them.”
Karen L. Hassan, TrueBaseline Corporation
Pittsburgh, PA
“I really like the fact that you have real source code projects for real applications
(like the TAFT project). You go through the exact steps to set it up and compile it, and
I get to see all the pieces of the code and what they do. This is great!”
Mark Giffin, Mark Giffin Consulting, Inc.
Los Angeles, CA