documentation-integrity
Skill1 starsChanged 53 days agoMITView on GitHub
Document implemented, verified reality in the repository's existing source of truth: READMEs, API references, ADRs, runbooks, migration notes, changelogs, and code comments. Use when documentation must be written, updated, or checked for drift; never document unverified capabilities.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- AL-JANEF/janefskillsword for word, first seen Sep 19, 2026
Other versions1 project uses a version of this.
Word for word · 1
- AL-JANEF/janefskills★ 1100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
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 repository25 other files it gives its agents.
- janefSkill
- forgeSkill
- accessibility-qualitySkill
- api-contractsSkill
- architecture-integritySkill
- context-efficiencySkill
- database-integritySkill
- delegation-disciplineSkill
- devops-reliabilitySkill
- frontend-design-qualitySkill
- git-disciplineSkill
- implementation-qualitySkill
- performance-scalabilitySkill
- review-defect-firstSkill
- root-cause-debuggingSkill
- testing-verificationSkill
- ui-ux-qualitySkill
- auth-hardeningSkill
- secrets-guardSkill
- security-auditSkill
- security-loggingSkill
- skill-security-auditSkill
- threat-modelSkill
- variant-huntSkill
- vuln-auditSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 5 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
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 13
Document implemented and verified reality, not intent.
- Distinctive: line 17
Update the repository's existing source of truth instead of creating a competing document.
- Distinctive: line 19
Update API contracts, examples, migration notes, operational runbooks, and configuration guidance when those surfaces change, in the same …
- Distinctive: line 20
Keep documentation concise, searchable, version-consistent, and explicit about invariants, ownership, failure behavior, and recovery where …
- Distinctive: line 22
Never claim capabilities, guarantees, compatibility, or performance that were not verified.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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
Documentation Integrity
Document implemented and verified reality, not intent. A document that promises unverified behavior is a defect.
Rules
- Update the repository's existing source of truth instead of creating a competing document. If there is no obvious location, ask before adding a top-level file.
- Record material architecture changes in the established ADR or design mechanism (
architecture-integrity). - Update API contracts, examples, migration notes, operational runbooks, and configuration guidance when those surfaces change, in the same change.
- Keep documentation concise, searchable, version-consistent, and explicit about invariants, ownership, failure behavior, and recovery where relevant.
- Repair stale documentation encountered in the changed scope when it would mislead future maintainers; mention, do not silently rewrite, stale docs outside the scope.
- Never claim capabilities, guarantees, compatibility, or performance that were not verified. Mark illustrative examples as illustrative.
- Comments explain why, not what; remove comments that restate the code or that are no longer true.
Verification
Cross-check documented commands, paths, and behavior against the code or an actual run. Verify links and examples. State what was verified and what is documented from design only.
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.