The slides of Jim's presentation “Documenting APIs: Your First Week on the Job” given November 15, 2006 to the San Francisco STC Chapter are available for download.
The Zone is where we provide resources, information, and announcements for our clients, students, and other members of the Bitzone community.
Available now from this website:
Documenting APIs
Writing Developer Documentation for Java™ APIs and SDKs
by James F. Bisso and Victoria Maki
Documenting APIs—the definitive guide to writing developer documentation—includes over 300 pages of tips, techniques, and guidance on documenting Java APIs.
Here is the table of contents from the Documenting APIs book and some sample PDF files.
Table of Contents
Chapter 1 How Do Humans and Computers Communicate?
Chapter 2 An Introduction to Developer Documentation
Chapter 3 Setting Up Your Environment
Chapter 4 How Much Programming Do You Need?
Chapter 5 Researching an API Project
Chapter 6 Java Practicum
Chapter 7 Writing Quality Developer Documentation
Chapter 8 Succeeding on the Job
Chapter 9 Creating Style Guidelines for Developer Documentation
Chapter 10 Writing the Guides
Chapter 11 About the TAFT Project
Chapter 12 Functional Specification for TAFT
Chapter 13 The TAFT Reference Guide
Chapter 14 The TAFT Programmer's Guide
Appendix A Glossary of Acronyms and Terms
Appendix B Java Keywords
Appendix C Java Tools
Index
“When I Grow Up, I Want to Write API Docs” is a basic presentation about documenting APIs that Jim gave a few years ago at STC regional conferences and chapter meetings.
We compiled a three-page “Documenting APIs and OOP Resource List” and it is available for download.