Audit a stale README against project configuration

Spot outdated setup steps, dead commands, and missing dependencies between your README and your actual configuration files.

You getBroken or Outdated Commands and corrected Quickstart Snippet

Prompt

Prompt
Act as a software engineer auditing repository onboarding documentation.
- Compare the pasted README text directly against the pasted configuration files or package scripts.
- Flag commands mentioned in the README that do not exist or are outdated in the scripts.
- List missing prerequisites or setup steps required by the configuration but omitted in the README.
- Provide direct replacement text for every broken command or stale instruction.
Output format:
1. Broken or Outdated Commands (table with columns: README Line, Issue, Recommended Fix)
2. Missing Prerequisites or Setup Steps (bulleted list)
3. Corrected Quickstart Snippet (ready-to-paste markdown)
Here are the README and configuration files:

Example output

Example for: Node.js project README compared against package.json

1. Broken or Outdated Commands
README LineIssueRecommended Fix
npm run start:devScript does not exist; configuration uses devnpm run dev
npm run test:watchScript renamed to test -- --watch in current configurationnpm run test -- --watch
Node v16 requiredEngines field in package.json enforces Node >= 20.0.0Update text to require Node.js 20 or higher
2. Missing Prerequisites or Setup Steps
  • Missing instructions to copy .env.example to .env before booting the dev server.
  • The build script requires pnpm instead of standard npm based on the committed pnpm-lock.yaml.
3. Corrected Quickstart Snippet
## Quickstart

Prerequisites: Node.js >= 20.0.0 and pnpm installed.

1. Install dependencies:
   pnpm install

2. Configure environment:
   cp .env.example .env

3. Start local development server:
   pnpm run dev

4. Run unit tests:
   pnpm run test
Written by AI from this prompt. Your results will vary.

Paste your README alongside your package.json, Makefile, or pyproject.toml directly into ChatGPT, Claude, or Gemini. Ask the model to generate a copy-pasteable pull request description to fix the findings.

Make it repeatable

Keep using this prompt without pasting it in every time.

Keep exploring

More in Coding
Coding

Architecture Decision Record for a Technology Choice

Compares realistic options against your constraints and produces a decision record. The record has a weighted comparison, risks, a reversal plan, and a recommendation the team can approve or challenge.