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.
Back in July, we looked at creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare) . We done some further testing. We’ve created two new examples for API documentation that had been generated with the Stripe API look and feel and imported into Flare: Example A – Replacing… Read more »
Note: This post follows on from two previous posts on creating a unified API documentation portal: Creating an API documentation portal with MadCap Flare and Swagger/OpenAPI Example of API documentation portal using MadCap Flare We’ve just uploaded an example project of an API documentation portal created using MadCap Flare: API documentation portal home page Swagger… Read more »
If you are looking to document your API, we have a super contract API documentation writer coming available in the next two weeks. Contact us if you’d like to learn more.