Doc Writing

Přemění naskenovaný manifest rout na seskupenou, šablonovanou Markdown dokumentaci API pro fázi pipeline.

od huangjia2019 · huangjia2019/claude-code-engineering

Otestováno · Funguje ★ 9.2/10

Doc Writing — Přemění naskenovaný manifest rout na seskupenou, šablonovanou Markdown dokumentaci API pro fázi pipeline.

Co umí

Generuje seskupenou Markdown dokumentaci API z JSON manifestu rout (metoda/cesta/soubor/řádek/middleware/typ), přičemž vyplňuje pevnou šablonu endpoint-doc.md s tabulkami parametrů a odpovědí a ikonou zámku pro autentizaci. Postaven jako 2. fáze třífázové výukové pipeline (route-scanner → doc-writer → quality-checker) z výukového repozitáře Claude Code, takže se spouští konkrétně poté, co manifest rout již existuje, ne pro obecné žádosti typu „napiš mi dokumentaci".

Testovací report

Zadal jsem manifest se 3 routami napříč 2 zdrojovými soubory: výstup správně rozdělil na products-api.md a categories-api.md podle přiložené šablony endpoint-doc.md (se skutečnou značkou 🔒 pro autentizaci a tabulkami parametrů/odpovědí), plus strojově čitelný manifest files_generated pro další fázi pipeline — základní průchod vytvořil jeden plochý, neseskupený soubor bez manifestu.

Testováno: 2026-07-13 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

  • /doc-writingPřemění naskenovaný manifest rout na seskupenou, šablonovanou Markdown dokumentaci API pro fázi pipeline.

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

  • 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