Code Documentation

A solid reference for writing documentation that developers will actually read. Covers the essentials: README templates with proper structure, JSDoc and OpenAPI formats for APIs, inline commenting guidelines that focus on the why over the what, and architecture decision records. The inline comment examples are especially useful, showing both good patterns (explaining business logic and workarounds) and bad ones (stating the obvious). Leans TypeScript but the principles apply anywhere. Good for standardizing documentation across a team or just getting unstuck when staring at a blank README.

skills.sh installs: 406
GitHub stars: 1.1K
last updated: Jun 3, 2026

View on GitHub

Install

$ npx -y skills add skillcreatorai/ai-agent-skills --skill code-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

Code Documentation

README Structure

Standard README Template

# 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