Skip to main content
skill CX Codex

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add ilude/claude-code-config --skill code-documentation -a claude-code
Open on GitHub

What 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.py and flag comments that just restate the next line.
  • Write a docstring for calculate_fee covering arguments, return value and raised errors.
  • Add JSDoc to loadProfile and 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-code

2Manually: put the files in place

~/.claude/skills/code-documentation/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/code-documentation/

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.

code-documentation bytedance The code-documentation skill auto-generates README files, API references, architecture docs, and developer guides straight from your codebase. Use it to document projects, libraries, and APIs without manual effort. CX Codex +1 2,000installs code-documentation MoizIbnYousaf code-documentation — a skill that gives the agent fixed templates for READMEs, API reference, inline comments and architecture notes. CX Codex +1 571installs code-documentation aj-geddes code-documentation — a skill for Claude Code, Codex, Cursor, GitHub Copilot, and Gemini CLI that generates language-standard documentation: JSDoc, Python docstrings, JavaDoc, and inline comments. CX Codex +1 502installs lean-comments official github lean-comments — a GitHub Copilot skill that keeps source-code comments lean and meaningful. Kicks in when you add, edit, review or clean up comments, docstrings, TODO, FIXME, NOTE and other source commentary. CX Codex +1 17installs code-documenter https://github.com/Jeffallan code-documenter is a Claude Code skill that creates and validates code documentation, API specs, and guides, including docstrings, JSDoc, OpenAPI files, and documentation sites. CX Codex +1 6,200installs documentation-templates davila7 The documentation-templates skill provides outlines and templates for READMEs, API references, code comments, and project records. Use it when starting documentation or bringing existing pages into a clearer structure. CX Codex +1 305installs docs-guard amElnagdy docs-guard verifies README files, API docs, and docstrings against actual codebase implementation. It catches hallucinations, broken snippets, and outdated parameters. CX Codex +1 4,200installs storybook-component-documentation TheBushidoCollective Generates Storybook component documentation via autodocs, MDX pages and JSDoc comments. Useful when creating or updating UI library docs. CX Codex +1 166installs jsdoc-typescript-docs patricio0312rev jsdoc-typescript-docs — a skill that writes JSDoc comments across a TypeScript codebase and builds docs from them with TypeDoc. Handy when functions have piled up without descriptions. CX Codex +1 572installs

Project sponsors

Companies that keep this analytics open