A List Apart

Menu

The Ten Essentials for Good API Documentation

· 4 Comments

Building an elegant API is not an end in itself; you need developers to use it. Your documentation needs to get them up to speed quickly with what your API is, what it does, and how to use it or you risk losing their attention. In this piece, Diana Lakatos offers a wealth of excellent advice on how to properly document an API.

More from A List Apart