code-4-document
Skill1 starsChanged 58 days agoNo licenceView on GitHub
Apply documentation improvements to production files in a GitHub PR, GitLab MR, or local branch according to the project's `4-document.md` rules. Unlike code-optimize, this skill WRITES changes to files. **Zero Comments Policy is absolute**: documentation is added ONLY for cases covered in `4-document.md` (OpenAPI annotations, JavaDoc for therapi, constants classes) — ordinary code gets no comments, no Javadoc, no inline annotations beyond what the rules mandate. Trigger when user says `/code-document`, 'document this PR/MR', 'apply doc rules to changed files', 'add OpenAPI docs', 'add documentation to changed files', or pastes a PR/MR URL and wants documentation applied.
In this repository15 other files it gives its agents.
- ast-grepSkill
- clean-codeSkill
- code-1-guideSkill
- code-2-testSkill
- code-3-optimizeSkill
- code-5-styleSkill
- code-6-approve-or-blockSkill
- deep-reviewSkill
- issue-writerSkill
- landing-page-studioSkill
- postmanSkill
- post-mortumSkill
- review-with-postmanSkill
- task-journalSkill
- user-storySkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
16 rules. About 0 are common, 10 are distinctive, and 6 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈10
Distinctive · estimate
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
No licence file, so all rights are reserved — read it at the source. We count its rules but don't quote them. Read them on GitHub.
≈ “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.
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.