Skip to main content

One post tagged with "API documentation"

Posts about writing and structuring API documentation

View All Tags

Documenting PIX: lessons from scaling API docs for Brazil's instant-payments rail

· 12 min read
Technical Writer · Docs-as-Code · API Documentation

PIX moves more money in a month than the United Kingdom's Faster Payments scheme moves in a quarter. It went from zero to one billion monthly transactions in twelve months. It is national infrastructure, free to consumers, mandatory for banks, and operated by a central bank that publishes the spec in Portuguese.

I owned the official PIX API documentation at Itaú Unibanco (via Zup Innovation, 2022–2024) — 37+ endpoint references, integration guides, release notes, and migration docs on a Bitbucket docs-as-code pipeline, for the PSP API serving the world's most-adopted instant-payments rail. This post is what I learned writing those docs at scale — five things that don't show up in Google's developer-docs guide, that I had to learn the way most documentation lessons get learned: by writing the wrong version first.