anrysysanrysys/tg-ai/.agents/skills/docs-maintenance/SKILL.md

docs-maintenance

Skill0 starsChanged 2 months agoMITView on GitHub

Run at the end of every task in this repository to keep the documentation true. Use when you have changed code, schema, tools, dependencies or operations and are about to report the task done.

5 other projects use a version of this.

Adopted by

Most recently taken up by

OrionicsLtd/claude-skillstheir own version, first seen Nov 8, 2026
OpenSelfHosting/skillstheir own version, first seen Oct 25, 2026
Seekers2001/docs-governancetheir own version, first seen Oct 13, 2026
qshanx/docs-governancetheir own version, first seen Oct 13, 2026
InternationalColorConsortium/iccDEVtheir own version, first seen Oct 8, 2026

Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
Seekers2001/docs-governance★ 320same name
qshanx/docs-governance★ 253same name
InternationalColorConsortium/iccDEV★ 187same name
OpenSelfHosting/skills★ 2same name
OrionicsLtd/claude-skills★ 1same 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 repository12 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- llms-full.txtllms.txt
- llms.txtllms.txt
- site/llms-full.txtllms.txt
- site/llms.txtllms.txt
- mcp-tool-authoringSkill
- telegram-safetySkill
- docs-maintenanceSkill
- mcp-tool-authoringSkill
- telegram-safetySkill

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

0
Common
Most of the 3 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
No matching row is a defect in that table - add the row now.
line 18
Very specific:
Do not pick a default. A scope question goes to task-queue.md and to the user.
line 57

“Common” is measured: kept by at least 6 in 10 of the 3 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.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

Documentation maintenance

The authority is docs/50-process/docs-maintenance-protocol.md. This is the condensed loop.

A task is not done until this has run.

The seven steps

Classify. Find your change in docs/00-index/documentation-map.md. No matching row is a defect in that table - add the row now.
Resolve. Take the union of matching rows, plus always docs/00-index/status.md and docs/90-history/CHANGELOG.md.
Glossary first. New or renamed concept? Update docs/00-index/glossary.md before anything else, then use that exact term everywhere.
Apply. Respect mutability: ADRs are append-only, SRS clauses are revised in place keeping their id, derived documents link rather than restate. Bump updated: in every file you touch. Register new identifiers in docs/00-index/id-registry.md.
Update state. Rewrite the stale lines in status.md (do not append), close finished tasks in task-queue.md, add one changelog line.
Verify. just docs-check, then confirm every new document is linked from docs/README.md.
Report. Emit the DOCS SYNC block.

Report block

DOCS SYNC
  Change type:    <from the documentation map>
  Updated:        <files>
  IDs added:      <identifiers>
  IDs superseded: <identifiers, or none>
  docs-check:     PASS|FAIL

Never

Never	Because
Defer updates to "one pass later"	Reconstruction from memory produces confident fiction
Edit an accepted ADR to reflect a new decision	Write a superseding ADR. The old record is the value
Restate a rule in a second document	It drifts in one of the copies
Add a document without a router link	Orphaned documents are invisible to the next session
Write `TODO: document this`	Write a `TASK-NNN` in the task queue instead

Missing a decision

Do not pick a default. A scope question goes to task-queue.md and to the user. A technical choice with real alternatives gets a status: draft ADR and a question. A safety question resolves to the more conservative option, with the reason recorded.

Download now (ZIP)

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

What did you use it for? e.g. Reviewing pull requests in a Rails app

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.

Check your setup, free