# Doc Writing

Generate API documentation from a route manifest.

- Repository: https://github.com/huangjia2019/claude-code-engineering (1147 stars)
- Category: Writing
- License: see repository
- Last updated: 2026-07-23
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add huangjia2019/claude-code-engineering --skill doc-writing -g -a claude-code -y`
Codex: `npx skills add huangjia2019/claude-code-engineering --skill doc-writing -g -a codex -y`
Cursor: `npx skills add huangjia2019/claude-code-engineering --skill doc-writing -g -a cursor -y`
Gemini CLI: `npx skills add huangjia2019/claude-code-engineering --skill doc-writing -g -a gemini-cli -y`

## Description

Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Doc Writing Skill

Generate structured API documentation from a route manifest.

## Input

You will receive a route manifest (JSON array) from the previous pipeline stage.
Each entry contains: method, path, file, line, middleware, type.

## Process

### Step 1: Read Source Code

For each route in the manifest, read the source file to understand:
- Request parameters (path, query, body)
- Response format
- Error handling
- Business logic summary

### Step 2: Generate Documentation

Use the template at `templates/endpoint-doc.md` for each route group.

Group routes by their source file (e.g., all product routes together).

### Step 3: Write Files

Write one markdown file per route group to the `docs/` directory:
- `docs/products-api.md`
- `docs/categories-api.md`
- etc.

## Output

Return a manifest of generated documentation files:

```json
{
  "files_generated": ["docs/products-api.md", "docs/categories-api.md"],
  "routes_documented": 8,
  "routes_skipped": [],
  "warnings": []
}
```

This manifest will be consumed by the next pipeline stage (quality-checking).