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 »
Tag: API documentation
Example project – API documentation portal using MadCap Flare
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 »
Our latest podcast – a round up of recent news in technical communications.
Example of API documentation portal using MadCap Flare
This post follows on from our Creating an API documentation portal with MadCap Flare and Swagger/OpenAPI post. It shows screenshots of a test project we created. We used Swagger’s “petstore” example API specification as the source content. We didn’t spend any time modifying the stylesheets – these are just proofs of concept. API documentation Home page… Read more »
Creating an API documentation portal with MadCap Flare and Swagger/OpenAPI
MadCap Software has published a whitepaper called The Definitive Guide to Creating API Documentation. It covers ten best practices for writers, and it describes how you can use MadCap Flare to implement these when you are writing API documentation. In this post, we’ll look at whether we can combine automatically generated REST API reference documentation with… Read more »