Documentation

AI documentation review before a reader finds the gap.

Documentation fails quietly. Nobody files a bug for a step that is missing, they just fail to complete the task and leave. Generated docs make this worse, because they read confidently even where they are guessing.

The work is the evidence that it held.

What generated documentation gets wrong

Model-written docs are typically strong on structure and tone and weak on truth. They invent plausible flags, describe an interface from an older version, and explain a workaround that was removed two releases ago. Nothing in the prose signals uncertainty, so the reader trusts all of it equally.

The second failure is omission: the prerequisite that everyone on the team knows and no generated page mentions, because it was never in the prompt.

What the review covers

Automated checks handle the mechanical layer; a human handles the rest.

  • Consistency: the same command, field or endpoint described two different ways in one document.
  • Completeness: prerequisites, permissions, versions and the step that only exists in someone's head.
  • Freshness: references to versions, screenshots and links that no longer resolve.
  • Voice: whether the page sounds like your product or like generic technical writing.
  • Risk: instructions that would destroy data, leak a secret or mislead an auditor if followed exactly.

When a person has to read it

A technical writer with the product in front of them catches what no rule can: the procedure that works on the author's machine, the diagram that contradicts the table below it, the sentence that is true but teaches the wrong mental model.

That reviewer is named on the page's record, with the changes they requested, so documentation gets the same traceability as code.

What the checks look for

  • Contradictions

    Two pages, or two sections, giving different answers to the same question.

  • Dead references

    Removed flags, renamed endpoints, broken links and stale screenshots.

  • Missing prerequisites

    Credentials, versions and permissions the reader needs before step one.

  • Unsafe instructions

    Commands that would wipe data or expose a secret if followed literally.

  • Unmarked uncertainty

    Places where the draft guessed, written in the same voice as the places it knows.

Questions this page usually raises

Which document types can be checked?
Markdown, HTML, plain text and structured docs such as READMEs, runbooks, API references and help-centre articles. Paste the source and the checks run in the browser.
Can it check documentation against our actual product?
The automated pass finds internal contradictions and stale patterns. Verifying statements against a live system needs a person who can open the product, which is what the reviewer does.
Is a full human review required for every page?
No. Most pages only need the offline pass. A person reads the pages where being wrong is expensive: onboarding, security, billing and anything a customer will follow step by step.

AI documentation review

Run the checks, then decide who needs to sign it.

The automated pass is free, needs no account and uploads nothing. Escalate to a named reviewer only where being wrong is expensive.