Doc Writing

Omdanner et scannet route-manifest til grupperet, skabelonbaseret Markdown API-dokumentation for et pipeline-trin.

Af huangjia2019 · huangjia2019/claude-code-engineering

Testet · Virker ★ 9.2/10

Doc Writing — Omdanner et scannet route-manifest til grupperet, skabelonbaseret Markdown API-dokumentation for et pipeline-trin.

Hvad det gør

Genererer grupperet Markdown API-dokumentation ud fra et JSON route-manifest (method/path/file/line/middleware/type) ved at udfylde en fast endpoint-doc.md-skabelon med parameter- og respons-tabeller samt et auth-lås-ikon. Bygget som trin 2 af en 3-trins undervisningspipeline (route-scanner til doc-writer til quality-checker) fra et Claude Code-kursus-repo, så det trigges specifikt, når et route-manifest allerede findes, snarere end ved åbne 'skriv min dokumentation'-forespørgsler.

Testrapport

Fodrede det med et 3-route manifest på tværs af 2 kildefiler: det opdelte korrekt output i products-api.md og categories-api.md efter den medfølgende endpoint-doc.md-skabelon (med en rigtig 🔒 auth-markør og parameter/respons-tabeller) plus et maskinlæsbart files_generated-manifest til næste pipeline-trin — en baseline-kørsel producerede én flad, ugrupperet fil uden manifest.

Testet: 2026-07-13 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/huangjia2019/claude-code-engineering
cd claude-code-engineering
mkdir -p ~/.claude/skills
cp -r 04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing ~/.claude/skills/doc-writing

Kommandoer og eksempelprompter

  • /doc-writingOmdanner et scannet route-manifest til grupperet, skabelonbaseret Markdown API-dokumentation for et pipeline-trin.

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen aktiverer prompter som disse skillen (på engelsk):

  • Generate Markdown API docs from this route manifest JSON we scanned
  • Fill in the endpoint doc template with params and response tables for these routes
  • Write grouped API reference docs from the scanned route list with auth icons