Doc Writing

Zamienia zeskanowany manifest tras w pogrupowaną, szablonową dokumentację API w Markdownie dla etapu pipeline'u.

Autor: huangjia2019 · huangjia2019/claude-code-engineering

Testowano · Działa ★ 9.2/10

Doc Writing — Zamienia zeskanowany manifest tras w pogrupowaną, szablonową dokumentację API w Markdownie dla etapu pipeline'u.

Co robi ten skill

Generuje pogrupowaną dokumentację API w Markdownie z manifestu tras JSON (metoda/ścieżka/plik/linia/middleware/typ), wypełniając stały szablon endpoint-doc.md tabelami parametrów i odpowiedzi oraz ikoną kłódki dla autoryzacji. Zbudowany jako etap 2 z 3-etapowego nauczającego pipeline'u (route-scanner -> doc-writer -> quality-checker) z repo kursu Claude Code, więc uruchamia się konkretnie wtedy, gdy manifest tras już istnieje, a nie przy otwartych prośbach typu „napisz mi dokumentację”.

Raport z testu

Podano mu manifest 3 tras w 2 plikach źródłowych: poprawnie podzielił wynik na products-api.md i categories-api.md wg dołączonego szablonu endpoint-doc.md (z prawdziwym znacznikiem autoryzacji 🔒 i tabelami parametrów/odpowiedzi) plus czytelny dla maszyny manifest files_generated dla kolejnego etapu pipeline'u — baseline stworzył jeden płaski, niepogrupowany plik bez manifestu.

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

Instalacja

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

Komendy i przykładowe prompty

  • /doc-writingZamienia zeskanowany manifest tras w pogrupowaną, szablonową dokumentację API w Markdownie dla etapu pipeline'u.

Skille uruchamiają się na zwykłe polecenia — bez komend do zapamiętania. Po instalacji aktywują go prompty takie jak te (po angielsku):

  • 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