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 »
Tag: documentation
New e-learning course: Managing documentation projects with AI
Whilst AI is changing documentation work, organisations are seeing very different results. The most successful results come when you know what you ultimately want AI to achieve, and what “good” looks like. In an organisational context, you also need to know where AI belongs in the process, and how to keep control of quality. That… Read more »
The prince of user documentation – lessons from Machiavelli
In 1513, Niccolò Machiavelli sat in exile and wrote the most ruthlessly practical guide to power ever committed to paper. He wasn’t interested in how things should work. He was interested in how they do. Five centuries later, most SaaS companies treat their user documentation as an afterthought: a support cost to minimise, a page… Read more »
Our next Managing and mastering documentation projects with AI course: April 2026
We’ve scheduled our next Managing and mastering documentation projects with AI course. It will be held on the mornings of 13th and 14th April 2026. We’ve extended the second day by half an hour. It’s now 3.5 hours long, so that we can fit in more content. It helps documentation project managers use AI for… Read more »
Automating llms.txt generation for multi-version documentation sites
Developer portals and knowledge bases often contain documentation for multiple product versions, including legacy ones that are no longer actively maintained. When LLMs try to extract information from these sites, they can struggle to identify which content is current and relevant. The llms.txt file offers a solution by providing LLMs with clear signposts to the… Read more »
