Doc Writing

Verwandelt ein gescanntes Route-Manifest in gruppierte, templatebasierte Markdown-API-Docs für eine Pipeline-Stufe.

von huangjia2019 · huangjia2019/claude-code-engineering

Getestet · Funktioniert ★ 9.2/10

Doc Writing — Verwandelt ein gescanntes Route-Manifest in gruppierte, templatebasierte Markdown-API-Docs für eine Pipeline-Stufe.

Was es kann

Erzeugt gruppierte Markdown-API-Dokumentation aus einem JSON-Route-Manifest (Method/Path/File/Line/Middleware/Type), das ein festes endpoint-doc.md-Template mit Parameter- und Response-Tabellen sowie einem Auth-Schloss-Icon befüllt. Als Stufe 2 einer 3-stufigen Lehr-Pipeline (route-scanner zu doc-writer zu quality-checker) aus einem Claude-Code-Kursrepo gebaut, reagiert er also spezifisch, sobald bereits ein Route-Manifest existiert, statt auf offene 'Schreib meine Docs'-Anfragen.

Testbericht

Gefüttert mit einem 3-Route-Manifest über 2 Quelldateien: Er teilte die Ausgabe korrekt in products-api.md und categories-api.md nach dem gebündelten endpoint-doc.md-Template (mit echtem 🔒-Auth-Marker und Parameter-/Response-Tabellen) plus einem maschinenlesbaren files_generated-Manifest für die nächste Pipeline-Stufe — ein Baseline-Durchlauf erzeugte eine flache, ungruppierte Datei ohne Manifest.

Getestet am: 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

Befehle & Beispiel-Prompts

  • /doc-writingVerwandelt ein gescanntes Route-Manifest in gruppierte, templatebasierte Markdown-API-Docs für eine Pipeline-Stufe.

Skills reagieren auf normale Anfragen — keine Slash-Befehle nötig. Nach der Installation aktivieren Prompts wie diese den Skill (auf Englisch):

  • 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