# Documentation

> Generate and update technical documentation

- Skill: `majiayu000/documentation-3` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds add majiayu000/documentation-3`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/documentation-3/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/documentation-3

---


# Documentation Generator

## When to Use
Use this skill when writing or updating documentation.

## Documentation Types

### 1. API Documentation
- Endpoint description
- Request/response examples
- Error codes
- Authentication requirements

### 2. README
- Project overview
- Installation steps
- Quick start guide
- Configuration options

### 3. Architecture Docs
- System overview
- Component diagram
- Data flow
- Decision records

### 4. Code Comments
- Why, not what
- Complex algorithm explanations
- Public API documentation

## Format Guidelines
- Use clear headings hierarchy
- Include code examples
- Add diagrams where helpful
- Keep it up to date with code

## Template: Function Documentation
```typescript
/**
 * Brief description of what the function does.
 *
 * @param paramName - Description of parameter
 * @returns Description of return value
 * @throws ErrorType - When this error occurs
 *
 * @example
 * const result = functionName(arg);
 */
```