readme-maintenance
Skill2 starsChanged 5 months agoApache-2.0View on GitHub
Patterns for keeping READMEs accurate as code evolves. Focused on structural consistency, not prose style. Use when editing a README with ASCII tree diagrams, version callouts, config examples, or cross-document line ranges. Avoids generic "write clearly" advice — targets the concrete rot patterns that accumulate in docs-heavy repos.
In this repository16 other files it gives its agents.
- architecture-decision-recordsSkill
- atlas-add-toolSkill
- atlas-build-bundleSkill
- atlas-ci-releaseSkill
- atlas-optimization-patternsSkill
- atlas-rag-evaluationSkill
- embedding-strategiesSkill
- hybrid-search-implementationSkill
- mcp-builderSkill
- python-code-styleSkill
- python-observabilitySkill
- python-resilienceSkill
- python-testing-patternsSkill
- python-type-safetySkill
- skill-creatorSkill
- uv-package-managerSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
15 rules. About 0 are common, 13 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈13
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 25
Search the README for every occurrence of the changed concept.
- Distinctive: line 36
After editing any heading, grep the README for the old anchor text and update every cross-reference.
- Distinctive: line 51
Verify every file in the diagram still exists
- Distinctive: line 52
Verify every file in the project that matters is listed
- Distinctive: line 77
Update the example to match the actual schema
- Distinctive: line 78
If examples reference specific paths, verify those paths still exist
- Distinctive: line 82
After changing a CLI tool's flags or output format:
- Distinctive: line 85
Verify every flag used still exists
- Distinctive: line 86
If the README claims a command produces specific output, verify that
- Very specific: line 90
If the README has a navigation outline with [L42-57]-style line ranges, they will shift on every edit.
- Very specific: line 94
After all edits are done, get the current line count: wc -l README.md
- Distinctive: line 96
Update every range in the outline
- Distinctive: line 100
When editing a README, do this in order:
- Distinctive: line 104
Search the README for every mention of the changed concepts.
- Distinctive: line 106
After edits, update the file outline (if any) and table of contents.
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
When to use
- Adding/removing/renaming a file in the project — is the tree diagram still right?
- Changing a CLI flag, config key, or command signature — are all code blocks updated?
- Bumping a version — does the "current version" note need updating?
- Changing architecture (e.g., swapping build strategy) — are all prose claims still true?
- Adding or removing a section — does the table of contents still match?
- Editing the README at all — always check for stale claims while you're there.
Rot patterns to catch
1. Stale prose claims
Assertions about how the system works that were true at vN but wrong at vN+1. Search the README for every occurrence of the changed concept.
Common culprits:
- Build/deploy strategy — "CI does X" after CI was rewritten
- Default behavior — "the server auto-selects Y" after the default was changed to Z
- Dependency claims — "requires pandas" after it was removed
- Status labels —
[planned]on something now implemented, or vice versa
2. Broken section references
Internal links [§5.3](#53-smoke-test-ci) break when section headings change.
After editing any heading, grep the README for the old anchor text and update
every cross-reference.
3. Version note rot
Many READMEs have a "current version" callout box. This should be updated on every release — at minimum the version number and a one-line summary of what changed. If you bump the version in pyproject.toml but not the README note, it's wrong.
4. ASCII tree diagram drift
Directory structure diagrams (├── foo.py description) rot silently because
they look right at a glance. After any file add/remove/rename:
- Verify every file in the diagram still exists
- Verify every file in the project that matters is listed
Align descriptions vertically — pick a column position for descriptions and pad every filename to it. Use monospace alignment: the longest filename in the diagram sets the column for its nesting level.
Bad (misaligned):
├── foo.py Does X ├── bar.py Does Y ├── baz-long-name.py Does ZGood (aligned):
├── foo.py Does X ├── bar.py Does Y ├── baz-long-name.py Does Z
5. Configuration block drift
JSON, YAML, and TOML blocks in READMEs are often copied from config files during writing and never updated. After changing a config schema:
- Grep the README for any code block containing the changed key
- Update the example to match the actual schema
- If examples reference specific paths, verify those paths still exist
6. Command output / flag drift
After changing a CLI tool's flags or output format:
- Find all
```bashblocks in the README that invoke the tool - Verify every flag used still exists
- If the README claims a command produces specific output, verify that
7. File outline line range drift
If the README has a navigation outline with [L42-57]-style line ranges,
they will shift on every edit. Update them whenever the file length changes
or content moves. One reliable approach:
- After all edits are done, get the current line count:
wc -l README.md - Grep for each section heading to get its new line number
- Update every range in the outline
Recommended workflow
When editing a README, do this in order:
- Understand what changed in the code (
git diffif it's a code change, otherwise ask the user what the new behavior is). - Search the README for every mention of the changed concepts.
- Make all edits.
- After edits, update the file outline (if any) and table of contents.
- Re-read the changed sections one final time to catch anything missed.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

