Doc writing

Skill huangjia2019/claude-code-engineering/04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing

This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏《Claude Code 工程化实战》的官方配套示例仓库，目标就是： 👉 把 Claude Code 从“对话式编码工具”，变成可设计、可复用、可治理的工程系统。

Install

npx -y skills add huangjia2019/claude-code-engineering --skill doc-writing

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.

What its author says it does

Copied from the file, not written here

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

SKILL.md

1.3 KB, as published. Nobody here has run it

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:

{
  "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).