Code Documentation
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
Install
npx skills add MoizIbnYousaf/ai-agent-skills --skill code-documentationgit clone --depth 1 https://github.com/MoizIbnYousaf/ai-agent-skills.git /tmp/ai-agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/ai-agent-skills/skills/code-documentation ~/.claude/skills/code-documentationPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# Code Documentation
## README Structure
### Standard README Template
```markdown
# Project Name
Brief description of what this project does.
## Quick Start
\`\`\`bash
npm install
npm run dev
\`\`\`
## Installation
Detailed installation instructions...
## Usage
\`\`\`typescript
import { something } from 'project';
// Example usage
const result = something.doThing();
\`\`\`
## API Reference
### `functionName(param: Type): ReturnType`
Description of what the function does.
**Parameters:**
- `param` - Description of parameter
**Returns:** Description of return value
**Example:**
\`\`\`typescript
const result = functionName('value');
\`\`\`
## Configuration
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `option1` | `string` | `'default'` | What it does |
## Contributing
How to contribute...
## License
MIT
```
## API Documentation
### JSDoc/TSDoc Style
```typescript
/**
* Creates a new user account.
*
* @param userData - The user data for account creation
* @param options - Optional configuration
* @returns The created user object
* @throws {ValidationError} If email is invalid
* @example
* ```ts
* const user = await createUser({
* email: 'user@example.com',
* name: 'John'
* });Details
- Skill name
code-documentation- Repository
- MoizIbnYousaf/ai-agent-skills
- Path
skills/code-documentation/SKILL.md- License
- MIT
- Repo updated
- 21 September 2026
- Listed in
- heilcheng/awesome-agent-skills
FAQ
What does the Code Documentation skill do?
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
How do I install the Code Documentation skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add MoizIbnYousaf/ai-agent-skills --skill code-documentation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Code Documentation popular?
It lives in MoizIbnYousaf/ai-agent-skills, which has 1,160 GitHub stars and 137 forks, and is included in 1 curated skill list.
Related skills
Content Research Writer
1.2kMoizIbnYousaf/ai-agent-skills
Conducts research, adds citations, and improves writing quality. Research topics thoroughly and produce well-cited content.
Changelog Generator
1.2kMoizIbnYousaf/ai-agent-skills
Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
Ask Questions If Underspecified
1.2kMoizIbnYousaf/ai-agent-skills
Clarify requirements before implementing. Do not use automatically, only when invoked explicitly.
Review a Skill
1.2kMoizIbnYousaf/ai-agent-skills
Use when evaluating whether a skill belongs in a library. Preview content, check frontmatter, validate structure, and decide whether to keep, curate, or remove.
Build Workspace Docs
1.2kMoizIbnYousaf/ai-agent-skills
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
Data Storytelling
2krmyndharis/antigravity-skills
Transform data into compelling narratives using visualization, context, and persuasive structure. Use when presenting analytics to stakeholders, creating data reports, or building executive presentations.
Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.