documentation-pass
Skill1 starsChanged 4 months agoMITView on GitHub
Use when a documentation pass is needed or docs, README, guides, examples, changelogs, or public explanations may be stale before PR.
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
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
- Very specific: line 14
Verify docs against code/tests/commands.
- Distinctive: line 19
Stop when docs reflect implementation and verification passes.
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 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 Pass
Rule: documentation must match current implementation before PR.
Loop:
- Map implementation and docs.
- Delegate bounded scans if useful: stale claims, missing docs, broken examples.
- Update docs.
- Verify docs against code/tests/commands.
- Open PR.
Main agent owns edits, verification, and PR. Subagents only find, critique, or verify.
Stop when docs reflect implementation and verification passes.
Output: changed docs, evidence, PR link.
In this repository22 other files it gives its agents.
- pi/AGENTS.mdAGENTS.md
- agent-workflowsSkill
- architecture-securitySkill
- code-review-releaseSkill
- exploring-codebasesSkill
- find-skillsSkill
- frontend-webSkill
- githubSkill
- grill-meSkill
- grill-with-docsSkill
- improve-codebase-architectureSkill
- improveSkill
- product-design-writingSkill
- project-backlogSkill
- prototypeSkill
- red-teaming-decisionsSkill
- systems-backendSkill
- tddSkill
- testing-debugging-verificationSkill
- to-issuesSkill
- to-prdSkill
- triageSkill
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.