documentation-sync
Skill1 starsChanged 2 months agoApache-2.0View on GitHub
Keeps durable project documentation aligned with implementation and operating reality. Use when a change affects product behavior, architecture, data, APIs, configuration, environments, release procedures, commands, or other facts future maintainers need.
We split this skill into the rules it gives an agent
4 rules. 0 are common, 4 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
4
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 14
Update the smallest canonical location that owns the changed fact.
- Distinctive: line 18
Do not duplicate code that is already self-explanatory unless the information is required to operate, integrate with, migrate, or safely …
- Distinctive: line 20
Keep links, examples, command references, version references, and cross-document terminology consistent with the implementation.
- Distinctive: line 22
Remove or correct stale guidance when the same change makes it demonstrably wrong.
“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.
Files
Documentation sync
- Determine whether the change alters durable product behavior, architecture, data semantics, interfaces, configuration, operational procedures, release behavior, supported usage, or another fact that future maintainers need.
- Discover the project's existing canonical documentation,
AGENTS.md, ADRs, configuration, schemas, runbooks, API specifications, contribution guidance, or other source-of-truth locations. Do not invent a documentation hierarchy that the repository does not define. - Update the smallest canonical location that owns the changed fact. Avoid creating a new document when an established source already exists.
- Record durable facts, decisions, constraints, commands, assumptions, and operational requirements rather than narrating the implementation conversation.
- Do not duplicate code that is already self-explanatory unless the information is required to operate, integrate with, migrate, or safely modify the system.
- Keep links, examples, command references, version references, and cross-document terminology consistent with the implementation.
- Remove or correct stale guidance when the same change makes it demonstrably wrong. If authoritative sources contradict each other and the correct resolution is unclear, report the conflict rather than choosing silently.
- Include required documentation updates in the same logical change when practical so durable truth does not lag behind implementation.
Report which canonical documentation changed, what durable truth was updated, any contradictions found, or why no documentation update was necessary.
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- homarr-labs/homarr★ 5.3ksame name
- volantlabs/vellis★ 9same name
- dss-time/repo-doctor-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 repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- automation-cost-controlSkill
- backup-and-recovery-reviewSkill
- calculation-model-validationSkill
- change-reviewSkill
- compatibility-and-rolloutSkill
- continuous-improvementSkill
- cross-surface-consistencySkill
- delegation-strategySkill
- dependency-changeSkill
- environment-release-safetySkill
- high-risk-change-reviewSkill
- interface-qaSkill
- root-cause-debugSkill
- secret-exposure-responseSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.