documentation-maintenance
Skill0 starsChanged 4 months agoMITView on GitHub
Updates README, API docs, architecture notes, ADRs, and changelogs to match current code. Use when a code/configuration change invalidates documentation, or when writing an ADR or changelog entry; not for new requirements or maintaining a .shadow decision graph.
7 other projects use a version of this.
Adopted by
Most recently taken up by
- github/squadtheir own version, first seen Nov 8, 2026
- rluders/amarutheir own version, first seen Nov 1, 2026
- NewFuture/DDNStheir own version, first seen Oct 8, 2026
- gootf/software-agent-soptheir own version, first seen Aug 30, 2026
- affectionatec/agentic-engineeringtheir own version, first seen Jun 24, 2026
- Nick2bad4u/codex-skillstheir own version, first seen Jun 19, 2026
Other versions7 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 7
- NewFuture/DDNS★ 4.7ksame name
- github/squad★ 3.4ksame name
- affectionatec/agentic-engineering★ 5same name
- rluders/amaru★ 5same name
- gootf/software-agent-sop★ 2same name
- Bridev04/clauderail★ 0same name
- Nick2bad4u/codex-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository24 other files it gives its agents.
- AGENTS.mdAGENTS.md
- agent-tool-interface-designSkill
- codebase-explorationSkill
- code-reviewSkill
- copilot-cloud-agentSkill
- external-skill-reviewSkill
- git-and-pr-workflowSkill
- parallel-worktree-deliverySkill
- planning-and-task-breakdownSkill
- refactoring-and-dead-code-removalSkill
- repository-agent-bootstrapSkill
- requirements-and-spec-writingSkill
- security-reviewSkill
- shadow-architectureSkill
- shadow-dreamSkill
- shadow-driftSkill
- shadow-observeSkill
- skill-creatorSkill
- systematic-debuggingSkill
- test-driven-developmentSkill
- verification-before-completionSkill
- verification-disciplineSkill
- wayfinder-planningSkill
- web-research-and-verificationSkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 5 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 7 edited versions we read keep these.
5
Distinctive
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
- Very specific: line 21
Read applicable instructions and the change.
- Distinctive: line 24
Search likely documentation paths for changed names, commands, flags, paths, and values, including removed/renamed forms.
- Distinctive: line 28
Update, supersede, or delete stale passages instead of appending corrections.
- Distinctive: line 43
Check affected documented setup sequences and commands by running them safely or tracing each step exactly against current code.
- Distinctive: line 48
Read updated documents for internal consistency.
- Very specific: line 56
Stop when affected documents agree with code and applicable checks are accounted for.
- Distinctive: line 59
If a command or example cannot be checked, state the limitation and leave that claim unverified.
“Common” is measured: kept by at least 6 in 10 of the 7 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Documentation Maintenance
Contract
Inputs: the change or requested document, current implementation, and repository documentation conventions. Update affected documentation, not application behavior. Create only requested or change-required artifacts.
Workflow
- Read applicable instructions and the change. Identify affected README setup and commands, API signatures/errors/examples, architecture responsibilities and diagrams, ADRs, changelog, and nearby comments/docstrings.
- Search likely documentation paths for changed names, commands, flags, paths, and values, including removed/renamed forms. Batch related searches and widen only where references lead. Resolve every identified contradiction; do not launch a worker or audit unrelated architecture for a small documentation fix.
- Update, supersede, or delete stale passages instead of appending corrections. Explain relevant rationale and constraints, use terminology consistent with code, and use relative repository links. Verify claims against implementation, not an outdated change summary.
- Handle records only when applicable:
- ADR: for a significant, hard-to-undo decision or reversal, read the ADR template. Record context/forces, decision, rejected alternatives, consequences/trade-offs, stable number, date, and status (proposed, accepted, superseded, deprecated). Do not invent acceptance or rewrite an accepted decision; supersede with a new linked ADR.
- Changelog: for user-visible changes, read the entry format and add an unreleased entry using existing conventions. Classify as Added, Changed, Deprecated, Removed, Fixed, or Security; describe user impact and breaking-change migration. Skip purely internal, behavior-preserving changes unless policy requires it.
- Check affected documented setup sequences and commands by running them safely or tracing each step exactly against current code. Compile/run affected code examples when possible. Record which checks ran versus were only traced; never claim an unexecuted example runs. Respect authorization and environment limits rather than running destructive setup or installing speculatively.
- Read updated documents for internal consistency. For long documents, inspect edited sections, headings, and affected cross-references rather than rereading unrelated prose. Check relative links and search the affected documentation for stale identifiers. Run repository-required documentation gates; otherwise use existing focused link/example checks, not unrelated full application tests.
Stop and output
Stop when affected documents agree with code and applicable checks are accounted for. Report paths updated/superseded/deleted, ADR status changes, changelog entry, commands/examples and actual results, and unresolved documentation gaps. If a command or example cannot be checked, state the limitation and leave that claim unverified; do not silently declare it runnable.
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.

