code-documentation · ilude — Claude Code skill: what it does, how to install
code-documentation is a Claude Code skill that teaches an agent to write self-explanatory code and comment only on reasons, for refactoring or API documentation.
no license 4 installs ★ 8 updated 2025-12-30
npx skills add ilude/claude-code-config --skill code-documentation -a claude-codeWhat code-documentation does
The skill lays down one rule and sticks to it: name things well, structure the code, and keep comments for the reasons a decision was made. Most of the guidance goes to the failure modes — lines that restate the code below them, stale notes, decorative banners, commented-out blocks and changelogs kept in source.
A four-step check settles whether a comment is warranted at all: is the code already clear, would a rename do the job, does the note explain why rather than what, will it still help whoever reads this file later. Docstring and JSDoc templates come with worked examples in Python and JavaScript/TypeScript, covering parameters, return values, thrown errors and a sample call.
What ships is text the model reads. So the change shows up in the code your agent writes, not in a report over an existing file. It activates on the topic itself: mention comments, docstrings or API documentation in the conversation and the guidance kicks in.
What it helps with
- stop the agent from commenting every other line
- record why a fee is calculated this way
- document a public function's parameters and errors
- strip commented-out code and changelog notes from a file
- settle a team argument about when a comment is warranted
Example prompts for the agent
- Go through
billing.pyand flag comments that just restate the next line. - Write a docstring for
calculate_feecovering arguments, return value and raised errors. - Add JSDoc to
loadProfileand spell out what each option does.
How to install code-documentation
1Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a claude-code2Manually: put the files in place
~/.claude/skills/code-documentation/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/code-documentation/
1Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a codex2Manually: put the files in place
.agents/skills/code-documentation/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a cursor2Manually: put the files in place
.cursor/skills/code-documentation/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install ilude/claude-code-config skills/code-documentation2Manually: put the files in place
.github/skills/code-documentation/SKILL.md1Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a gemini-cli2Platform CLI
gemini skills install https://github.com/ilude/claude-code-config --path skills/code-documentationManually: put the files in place
.devin/skills/code-documentation/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add ilude/claude-code-config --skill code-documentation -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about code-documentation
How do I install code-documentation in Claude Code?
Run npx skills add ilude/claude-code-config --skill code-documentation -a claude-code. The skill file lands at ~/.claude/skills/code-documentation/SKILL.md.
What does code-documentation do?
It gives a coding agent rules for comments and docs: explain the reasoning in code instead of restating lines, and cut the noise. The file covers anti-patterns, a four-step decision path and docstring and JSDoc examples.
When does the skill activate?
On its own, as soon as comments, docstrings, JSDoc or API documentation come up in the conversation.
Similar skills
All skills for Writing and docs →code-documentation by other authors comes first.