Doc Writing

Gjør en skannet rutemanifest om til gruppert, malbasert Markdown API-dokumentasjon for et pipeline-trinn.

av huangjia2019 · huangjia2019/claude-code-engineering

Bestått ★ 9.2/10

Doc Writing — Gjør en skannet rutemanifest om til gruppert, malbasert Markdown API-dokumentasjon for et pipeline-trinn.

Hva den gjør

Genererer gruppert Markdown API-dokumentasjon fra et JSON-rutemanifest (method/path/file/line/middleware/type), ved å fylle ut en fast endpoint-doc.md-mal med parameter- og responstabeller og et lås-ikon for autentisering. Bygget som trinn 2 av en 3-trinns undervisningspipeline (route-scanner til doc-writer til quality-checker) fra et Claude Code-kursrepo, så det utløses spesifikt når et rutemanifest allerede finnes, ikke for åpne «skriv dokumentasjonen min»-forespørsler.

Testrapport

Ga den et manifest med 3 ruter fordelt på 2 kildefiler: den delte korrekt output i products-api.md og categories-api.md etter den medfølgende endpoint-doc.md-malen (med en ekte 🔒 auth-markør og parameter/respons-tabeller) pluss et maskinlesbart files_generated-manifest for neste pipeline-trinn — en baseline-kjøring produserte én flat, ugruppert fil uten manifest.

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

Installer

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-writingGjør en skannet rutemanifest om til gruppert, malbasert Markdown API-dokumentasjon for et pipeline-trinn.

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen 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