Back to prompt library

Check whether the docs still match the code

The docs say one thing and the code does another.

When to use it When the docs haven't been updated in a long time

What you get

A prioritized, evidence-backed report of where the docs have drifted.

Before you start

  • Code and docs are in the same workspace

Steps

  1. Pick the install, architecture, config, release and troubleshooting docs
  2. Map each claim to code or a script
  3. Separate what's wrong, what's missing and what's just worded in an outdated way
  4. Rank by impact on users

Deliverables

  • Drift report
  • Evidence links
  • Revision plan

Done when

  • Every finding cites both the doc and the implementation
  • No guesses fill in for what the code does

Paste this into your agent

Do a read-only check of this project's docs against the implementation. Focus on install, architecture, public behavior, config, deployment and troubleshooting. For each mismatch, cite the doc location and the implementation evidence, explain the impact, and propose the smallest fix. Do not edit any files. Stop once you've produced the above; don't go on to anything else.