Docs

Most API documentation problems are not writing problems. They are structure problems. Format problems. Consistency problems. The kind that compound quietly until a developer opens your docs at 11pm and cannot tell whether the endpoint they’re reading is current, deprecated, or simply documented differently from the one before it. I have spent twenty years watching this happen across financial platforms, compliance systems, and SaaS products. The documentation itself was often fine. The system holding it together was not. ...

Technical writers build content. UX designers build interfaces. For twenty years, these two disciplines have operated in separate buildings, separate tools, separate reporting lines. That worked when documentation lived on a portal and the product lived on a screen. Users moved between two worlds: the application where they did their work, and the help center where they went when they got stuck. That world is ending. AI chatbots now pull documentation into the product and surface it as conversational answers. In-app guidance layers docs content directly onto the interface. Newer tools can expose your knowledge base as something an AI assistant can query directly. The documentation portal is no longer the destination. It is the backend data source for five different delivery surfaces, and neither the tech writer nor the UX designer fully owns the pipeline that connects them. ...

Documentation engineers build the infrastructure that ships products to readers. We wire up Git repos, configure linters, write CI/CD workflows, wrangle multi-format outputs, and maintain content taxonomies. We do all of this across a patchwork of tools that were never designed to work together. Copilot writes prose faster. GitBook gives you somewhere to publish. Vale catches style violations. But no single tool treats the pipeline from source to reader as one system. I went looking for one. I couldn’t find it. So I built a prototype to see what it would look like. This post is a build log. What I built, why I made the choices I made, and what I learned along the way. ...