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 »

Using MadCap Flare 2017 for company procedures – Quick review

We’ve been setting our staff the challenge of using some of the popular Help Authoring tools to create online company documents. We asked them to make some notes on the applications they used. Here are some of the notes relating to MadCap Flare 2017: “You soon become aware it’s a really powerful tool. Is this actually a… Read more »

Ellis will be speaking at MadWorld 2016

Cherryleaf’s Ellis Pratt will be speaking again at MadCap Software’s conference on technical communication and content strategy conference. MadWorld 2016 will be held between the 10th and 12th April 2016 at the Hilton San Diego Resort and Spa, in San Diego, California.

How does DITA compare to a Help Authoring Tool?

One of the key questions when considering moving to the DITA authoring standard is: how is it different from what I have today? If you create technical documentation using a Help Authoring Tool, such as Flare or RoboHelp, you’ll probably want to compare DITA to these. It’s not as easy a question to answer as… Read more »