Your API changes, but the documentation doesn’t always keep pace. Examples stop working. Guides miss new prerequisites. Support answers the same questions because the published instructions leave users stuck. We’ve published a practical guide to maintaining and improving existing API documentation. It’s for teams responsible for a developer portal that needs attention, whether the immediate… Read more »
Category: API
Spot what’s wrong with how this feature got documented
We’ve built an online exercise: Three teams. Three sets of docs for the same feature. Zero agreement on which one is correct. See if you can spot where this documentation process falls apart? The exercise is embedded below or you can use this link to the exercise.
How to plan a developer portal and learning site around user goals
A developer portal and a learning site do different jobs. Documentation helps someone complete a task or find a precise answer. A learning site takes them from their current level of knowledge to a defined capability. Many organisations put both types of content into the same website without planning how they fit together. The result… Read more »
Why developer portals fail (Hint: It’s probably your docs)
You’ve invested time, resources, and a good chunk of your budget into building a shiny new developer portal. It’s meant to be the gateway to your APIs, the hub for innovation, the key to unlocking a vibrant developer ecosystem. Yet, weeks or months later, analytics show a ghost town. Adoption is sluggish, support tickets are… Read more »
How we helped Tisane Labs transform their developer documentation
We’re delighted to share a new case study highlighting our recent work with Tisane Labs. This isn’t just a typical project overview; it’s a testimonial from Tisane Labs themselves, detailing their experience collaborating with us on two key documentation initiatives. Our first project involved creating user-friendly manuals for several of their plugins. The second was… Read more »