Overexplain We know how easy it is to lean on really handy tools—such as auto-generating tools, and dynamic templates—but you can't outsource the work.
Documentation needs to include explanations, overviews, and clarifications that need to be detailed in plain English.
API documentation has to be more than bare necessities like methods and endpoints.
It needs examples, summaries and fleshed out explanations.
They make assumptions about API consumers' knowledge base and how much they're willing to put up with to get a good understanding of how the API works.
But your API consumers aren't so different from a standard software user, even if they are developers.
But if you create a dynamic layout from the get-go, it will be easier for your users to navigate, and for you to expand as you scale your documentation. We know that developers don't want to do design work just to get their documentation out there, so we've created pre-built dynamic templates you can choose from.
Most importantly, keep the user experience front-of-mind.
Begin with a dynamic layout Post-2009, a static layout hints at an outdated product.
And once they became known for their thorough and remarkably clear documentation, they had a reputation to uphold.
They recently updated the design again, with an even nicer UI.
Browsing through this redesigned website, you'll find more quickstarts, more REST resources, and more error handling.