Last year, we blogged about creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare). Since then, a number of people have contacted us to ask for more details on ways to do this. We’ve put together a video outlining the different approaches and issues. This approach can work with… Read more »
We’re running another Question of the Week on social media. This week’s question is: What are the common mistakes organisations make with their API documentation? We plan to follow this up at a later stage with suggestions on how to prevent or fix these mistakes. We’ve had some great answers since we posted it in… Read more »
In this episode of the Cherryleaf Podcast, we talk to Stella Crowhurst, Content Strategy Director at Worldpay. We discuss: How Worldpay reduced complexity in the developer experience by combining multiple properties in a single portal. How Worldpay uses Lean methods to develop documentation within an Agile development environment. The new tool Worldpay is building in-house that… Read more »
Below is a transcript of our podcast episode Delivering technical documentation via an API: Welcome to the Cherryleaf podcast. In this episode, we’re going to look at documentation APIs. In a previous podcast we looked at trends in technical communication, and we were debating whether to include documentation via an API as one of the… Read more »
In this episode of the Cherryleaf Podcast, we look at delivering technical documentation via an API.