AI apps for improving documentation – created by Technical Writers

Cherryleaf has developed a series of apps that use AI to improve the quality and efficiency of documentation.
They are:

Below, you’ll find a brief description of what they do, together with some screenshots. We have further apps in development.

Human and LLM content optimiser app

Your documents aren’t just reference materials. Today, they’re also training data for AI. We’ve developed an AI tool that reviews and optimises draft content for both humans and LLMs.

Screenshot of an AI and human audience content optimiser app

How it works

  1. Paste or upload a document
  2. Get an instant report. It
    • Evaluates readability for both audiences
    • Identifies potential issues
    • Suggests specific improvements
  3. You also have the option for the app to implement the recommended improvements.

The objective is to enable you to write content that works for both human readers and AI systems (i.e. they interpret and represent your message accurately).

Reader simulator

Reader Simulator is tool for evaluating documentation through the lens of simulated AI user personas. This helps you check you are meeting the needs of the different types of users.

 

Screenshot from our policy and procedure document persona evaluation tool

Diátaxis apps

The Diátaxis framework, developed by Daniele Proceda, is a systematic approach to organising documentation. Diátaxis can transform your portal from a simple content repository into a purposeful, user-centric information system designed for developer success.

The Diátaxis Auditor is an app that acts as a smart content auditor. It analyses documentation using the Diátaxis framework, classifying content into Tutorials, How-to Guides, Reference, and Explanation.

Diataxis Auditor app screenshot : upload a document

Diataxis Auditor app screenshot : displays the analysis and recommendations

The Diátaxis Transformer is an app that splits content into the four distinct Diátaxis outputs. It also scans the text for tonal inconsistencies. For example: where how-to and reference content have been jumbled up in a single topic.

Screenshot from a Diataxis migration AI app recommending changes to topics

Policy audit simulator

The Policy Audit Simulator is an AI-driven app that simulates an audit of policy and procedure documents.

screenshot of an policy audit simulator app

Procedure to training content converter

The Procedure To Training Content Converter creates training content from policies and procedures documents.

screenshot of a procedure to training content converter app

Delivery formats

Audit and report option

We analyse an agreed number of pages for a fixed price. You receive a findings report, plus an optional debrief.

We’d be happy to run a small sample through it first, so you could see the type of results.

Audit plus consultancy option

  1. Analyse your content
  2. Deliver a findings report, with detailed classification and gap analysis, plus an optional debrief
  3. Deliver strategic recommendations for your migration

App deployed as a custom provision

Deploy the app on a secure cloud service as a custom provision. Clients get login credentials for a specific timeframe or content quota.

Build your own version

We show how to create some of these and similar apps on our “Managing and maintaining policy and procedure documents with AI“.

Contact us

Ready to get started?

Email:

info@cherryleaf.com

We’re happy to discuss your specific needs via Microsoft Teams, Zoom, GoToMeeting, or your preferred video conferencing platform.