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 »
Category: API
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 »
Need a contract API documentation writer?
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.
GDS publishes its new design for technical documentation
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 »