From the Cherryleaf podcast: The UK Parliament is one of the oldest organisations in the world. So how do you deliver a strategy to a body that has over 700 years of content? Cherryleaf’s Ellis Pratt interviewed Rosie Hatton, Strategy Digital Lead at the Parliamentary Digital Service, to find out. Topics covered: What is Parliament? 1’56”… Read more »
Cherryleaf Blog
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 »
API documentation: the undiscovered country
Recording from UAEurope 2017 conference. With many software developers now spending their time developing APIs, there’s an increasing demand for API documentation writers. It’s a fast changing field, with emerging information design patterns and authoring tools. It’s also different from end user documentation, and this means many Technical Communicators are uncertain if and how they… Read more »