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.
The Government Digital Service has been working on establishing a standard design for its technical (i.e. developer) documentation. This content is for systems architects, developers and users of the GOV.UK platforms and APIs. You can see an example at: GOV.UK Platform as a Service Cherryleaf was given a preview of the new design a few months… Read more »
Here’s a trend that didn’t make our list of predictions for 2017 – having company policies and procedures accessible via an Application Programming Interface (API). API is a term used to describe mechanisms that allow an application to access data or functionality provided by another application, system or service. For example, if your policies and procedures were… Read more »
In a recent presentation, Twilio’s Jarod Reyes and Andrew Baker mentioned their plans to make Twilio’s developer documentation available as an API. They plan to start with an API for code samples, stored in a github repository. Making documentation available as an API means means users can create or remix their own versions of the documentation. For example, they could… Read more »