The DevPortal Awards bring together the API community to recognize, celebrate and learn from the world’s greatest developer portals and their API documentation. Ellis is one of the judges. In this episode of the Cherryleaf Podcast, he talks about the criteria the awards use to assess the different developer portals. Transcript 00:00:02 Hello and… Read more »
Category: API
What people said were the common mistakes organisations make with their API documentation
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 »
Common mistakes organisations make with their 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 »
Delivering technical documentation via an API
In this episode of the Cherryleaf Podcast, we look at delivering technical documentation via an API.
Docs Like Code – Interview with Anne Gentle
Here is early access to the latest episode on the Cherryleaf Podcast – Interview with Anne Gentle, author of Docs Like Code and Product Manager at Cisco. It will be published on the podcast channel on Monday. Topics covered: What is docs as code? Why do it? When might this approach might be applicable? The limitations… Read more »