Blog

Insights on technical writing, documentation, and communication.

Posts in “API Documentation” 9 posts View all posts

Your API Reference Is Not Your API Documentation

Clinton De Young API Documentation

OpenAPI is an excellent reference, but a rendered spec is not documentation. A reference catalogs what endpoints exist; documentation teaches developers how to accomplish their goals. This post lays out five reasons reference-only docs fail your customers and what to write alongside your OpenAPI spec to fix it.