Developing API Documentation
13 Nov 2010Peter Gruenbaum of SDK Bridge shared an article in the company's November newsletter that resonated with some of the work I've been doing recently -- creating API documentation for the Mimeo Connect REST Print API. The article is titled A Coder's Guide to Writing API Documentation and appeared in MSDN Magazine. Gruenbaum says that writing good API documentation requires the four components:
- Overview: Explaining what advantages developers have in using the platform, and in some cases, providing an architectural description of the platform.
- Getting started: Helping the developer get started, in the form of step-by-step tutorials or simpler walkthroughs.
- Sample code: Providing well-commented code samples that developers can build on.
- Reference material: Providing detailed information about each class, member, function or XML element.