I'm a technical writer passionate about the docs-as-code approach and the API world. I work at Box, where I create developer documentation and tighten my relationship with APIs and code. I'm also a co-organizer of MeetContentKRK, where content creators from Kraków (and beyond) can meet to exchange their knowledge and ideas.
The topic of API documentation increasingly sparks interest among both developers and tech writers, raising questions such as: * How to properly render API specification to make it informative? * What makes a good API documentation framework from a tech writer's perspective? * How to adjust the framework to the ever-changing needs of (API) documentation? To answer them, let's have a closer look at the customized documentation framework used at Box to explore how a bunch of YAML files becomes a fully-documented API specification. As we go through the process, I will discuss both tools and documentation approaches we use to create great specs and docs.
