---
name: Doc Writing
slug: doc-writing
category: Writing
description: Doc Writing generates markdown API documentation from a route manifest. Use it when you have discovered routes and need grouped endpoint docs written from source code.
github: "https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing"
language: JavaScript
stars: 1077
forks: 379
install: "npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing ~/.claude/skills/doc-writing"
installs_to: ~/.claude/skills/doc-writing
source_path: 04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing/SKILL.md
collection_size: 13
category_size: 1012
collection_url: "https://dirskills.com/collections/huangjia2019/claude-code-engineering"
added: 2026-08-21T05:13:31.134Z
last_synced: 2026-08-21T05:13:31.134Z
canonical_url: "https://dirskills.com/skills/doc-writing"
---

# Doc Writing

Doc Writing generates markdown API documentation from a route manifest. Use it when you have discovered routes and need grouped endpoint docs written from source code.

**Install:**

```bash
npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing ~/.claude/skills/doc-writing
```

## README

# 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).