code-documentation

Community

Write self-explaining code with clear docs.

Authorilude
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill promotes self-documenting code and focuses comments on WHY rather than WHAT.

Core Features & Use Cases

  • Comment philosophy: when to add comments (explain rationale, complex logic, API contracts).
  • Anti-patterns: avoid obvious, redundant, or outdated comments.
  • Good examples: show how to write meaningful docstrings and inline comments.

Quick Start

Review a function's comments and add a docstring for non-obvious behavior where needed.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: code-documentation
Download link: https://github.com/ilude/claude-code-config/archive/main.zip#code-documentation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository