The API Experience
API documentation is a user experience problem.
Most API documentation is written from the inside out: here is what we built, here are its parameters. Developers read it from the outside in: here is what I am trying to do, show me the shortest safe path. My documentation is structured for the second reader.
That means every endpoint answers four questions in order: what does this do, what do I send, what comes back, and what happens when it fails. The last question is the one most documentation skips, and it is the one that costs the most support tickets. A developer who can diagnose a 401 from the docs alone never opens a ticket at all.
It also means writing two registers of the same truth. The technical view carries the exact contract: schemas, types, status codes. The human view carries the intent: what this is for, when to reach for it, what to check first. The demo below shows both, toggle between them.
This endpoint is fictional. The standards are not: they are the ones I applied to the WOPA API documentation at Accenture and the KHEMEIA developer guides at Cyient.