Doc Writing
Omvandlar ett skannat routemanifest till grupperad, mallbaserad Markdown-API-dokumentation för ett pipelinesteg.
Testad · Fungerar
Vad den gör
Genererar grupperad Markdown-API-dokumentation från ett JSON-routemanifest (method/path/file/line/middleware/type), som fyller i en fast endpoint-doc.md-mall med parameter- och svarstabeller och en autentiseringslåsikon. Byggd som steg 2 av en 3-stegs undervisningspipeline (route-scanner till doc-writer till quality-checker) från ett Claude Code-kursrepo, så den triggas specifikt när ett routemanifest redan finns, snarare än för öppna 'skriv min dokumentation'-förfrågningar.
Testrapport
Matade den med ett manifest med 3 routes över 2 källfiler: den delade korrekt upp resultatet i products-api.md och categories-api.md enligt den medföljande endpoint-doc.md-mallen (med en riktig 🔒-autentiseringsmarkering och parameter-/svarstabeller) plus ett maskinläsbart files_generated-manifest för nästa pipelinesteg — en baslinjekörning producerade en enda platt, ogrupperad fil utan manifest.
Testad: 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
Kommandon och exempelprompter
/doc-writingOmvandlar ett skannat routemanifest till grupperad, mallbaserad Markdown-API-dokumentation för ett pipelinesteg.
Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):
Generate Markdown API docs from this route manifest JSON we scannedFill in the endpoint doc template with params and response tables for these routesWrite grouped API reference docs from the scanned route list with auth icons