API reference documentation is not usually considered sexy, but it can address a large number of minute decisions facing client developers. After recalling the base concepts of REST APIs, this session shows how to create a diagram that visualises the relationships between API operations and API definitions. The visualisation allows …

Domain models describe how users and stakeholders conceive part of a system or a product in useful detail. Domain models are artifacts, often UML drawings, that enable fruitful collaboration between business and technical people.

For technical communicators, domain models enable higher-level conversations with stakeholders and subject matter experts, inspiring documentation …

As part of the Farfetch F-Tech Talks, I reported on the tools and processes used at Farfetch to create and publish API documentation, and how they evolved over time.

The API documentation combines traditional DITA topics with API references generated automatically through Open API specifications. The generation of API references …