Here are the responses we received when we asked, what are were the common mistakes organisations make with their API documentation: Thinking the auto-generated API reference is sufficient documentation. Shauna Too many docs, not enough code samples. Laura L. Too many “hello world” code samples; Not enough that accomplish something useful. Scott S. Not seeing… Read more »
Tag: API documentation
We’re running another Question of the Week on social media. This week’s question is: What are the common mistakes organisations make with their API documentation? We plan to follow this up at a later stage with suggestions on how to prevent or fix these mistakes. We’ve had some great answers since we posted it in… Read more »
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 »
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.