Is this feature ready to document? Using AI to assess source information

Developer source information passes through an AI evidence check, producing a readiness score, blockers and next actions for a technical writer’s final decision.

A feature can be ready for release and still be impossible to document properly. Let me explain. The technical writer might receive a completed development ticket, a few screenshots, and a message saying, “It works just like the previous version.” What is missing from that is the information needed to explain the feature accurately. Who… Read more »

Indicators that suggest something was written by AI

We researched the indicators that suggest something was written by AI. We then asked Claude to create an article about it, in that style. There’s nothing inherently wrong with using AI to write content. Use matters more than the tool itself. It depends on context, how (and the extent to which) it’s used, and the… Read more »

The blueprint for excellence: Applying technical communication principles to policies and procedures

In any organisation, policies and procedures are the backbone of operational consistency, quality, and compliance. However, their effectiveness hinges on how well they are written and communicated. Drawing inspiration from a framework for high-quality technical documentation, we can establish robust quality controls and assurance for these critical documents. This framework, originally developed by Gretchen Hargis… Read more »

Podcast 123: Document quality checklists

In this episode of the Cherryleaf Podcast, we look at different ways to measure and check the quality of the content we produce. Transcript In this episode of the podcast, we’re going to be looking at document quality, or specifically how we can check our content our technical writing content before it goes live. We… Read more »