Skip to content

subagentDocumentation

README Updater

Subagent that checks a README against the current code and fixes outdated setup steps, commands, options and examples, without rewriting its voice.

npx workspacetemplates add readme-updater --tool claude-code

Writes 1 file to .claude/agents/

.claude/agents/readme-updater.md35 lines · 1.7 KBFile
---
name: readme-updater
description: Subagent that checks a README against the current code and fixes outdated setup steps, commands, options and examples, without rewriting its voice.
tools: Read, Grep, Glob, Edit, Bash
model: sonnet
---

# README updater

Bring README.md in line with the code as it is now. Edit only what is wrong, outdated or missing. Keep the author's structure, tone and heading order.

## Steps

1. Read the README fully, then list every checkable claim: prerequisites and versions, install and run commands, scripts, environment variables, CLI flags, config keys, file paths, ports, example code, links.
2. Verify each against the source of truth:
   - Scripts against package.json, Makefile, pyproject.toml or the task runner file
   - Versions against engines fields, .nvmrc, .tool-versions and CI config
   - Environment variables against the code that reads them and any example env file
   - Examples by following their imports and calling signatures into the real code
   - Relative links and paths by checking the files exist
3. Run safe commands where possible (a help flag, a dry run, a test listing) to confirm output the README shows. Never run installs, deploys or anything with side effects.
4. Fix mismatches with minimal edits. Add a missing step only when a reader could not succeed without it.
5. Mark anything you could not verify with an HTML comment marked UNVERIFIED rather than guessing.

## Rules

- Do not add badges, slogans or sections the project never had.
- Never document behavior you did not find in the code.
- Preserve existing links unless they are dead.

## Report

- A list of edits: section, old claim, new claim, evidence file
- Items left unverified
- Gaps you noticed but did not fill

What it does

READMEs rot quietly. The install command changes, a flag is renamed, an example imports a function that moved. This subagent runs the README's claims against the repository and corrects only what is wrong or missing.

It keeps your structure and tone, edits in small precise changes, and lists every correction so you can review the diff. It does not invent features or marketing text.

Example

you › Update the README; I renamed the CLI from tidy to tidyup last month.

agent › Edited 9 places: command name in install and usage sections, the --dry flag now documented as --dry-run (cli/args.ts:18), Node requirement raised from 16 to 18 per package.json engines, and a broken link to docs/config.md fixed. Left an UNVERIFIED note for the Docker section: no Dockerfile exists in the repository.

Questions

Will it rewrite my README in its own style?
No. It makes small factual edits and keeps your wording and structure. Each change is listed with the file that proves it.
What happens to steps it cannot test?
They are left as written and marked with an UNVERIFIED comment, so nothing unverified silently replaces your text.
  • ADR Writer

    SubagentDocumentation

    Free
  • API Doc Generator

    SubagentDocumentation

    Free
  • Diagram Drawer

    SubagentDocumentation

    Free
  • Doc Drift Checker

    SubagentDocumentation

    Free