What Makes Good API Documentation: An Example-Based Approach

Summary

We'll take a tour through API documentation land, comparing the features and usability of different API doc sets. Interoperability is important, and making an easy-to-use API available can be a significant component of a company's success. Based on my own research, plus consultation with software engineers, product managers, and other technical writers, I will discuss what makes excellent API documentation. Here are some samples of great API documentation features that I have found.