Doc Writing

Zet een gescand route-manifest om in gegroepeerde, sjabloongebaseerde Markdown-API-docs voor een pipeline-stage.

Door huangjia2019 · huangjia2019/claude-code-engineering

Getest · Werkt ★ 9.2/10

Doc Writing — Zet een gescand route-manifest om in gegroepeerde, sjabloongebaseerde Markdown-API-docs voor een pipeline-stage.

Wat het doet

Genereert gegroepeerde Markdown-API-documentatie uit een JSON-route-manifest (method/path/file/line/middleware/type), waarbij een vast endpoint-doc.md-sjabloon wordt ingevuld met parameter- en response-tabellen en een auth-slotpictogram. Gebouwd als stage 2 van een 3-stage lespijplijn (route-scanner naar doc-writer naar quality-checker) uit een Claude Code-cursusrepo, en triggert daarom specifiek zodra er al een route-manifest bestaat, niet bij open 'schrijf mijn docs'-verzoeken.

Testrapport

Voedde het een manifest van 3 routes verspreid over 2 bronbestanden: het splitste de output correct in products-api.md en categories-api.md volgens het gebundelde endpoint-doc.md-sjabloon (met een echte 🔒 auth-markering en parameter-/response-tabellen), plus een machineleesbaar files_generated-manifest voor de volgende pipeline-stage — een pass zonder skill leverde één plat, ongegroepeerd bestand op zonder manifest.

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

Installatie

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

Commando's en voorbeeldprompts

  • /doc-writingZet een gescand route-manifest om in gegroepeerde, sjabloongebaseerde Markdown-API-docs voor een pipeline-stage.

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

  • 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