Documentation Criteria

Rozhodovací matice + šablony pro to, kdy psát PRD, ADR, Design Doc a Work Plan

od shinpr · shinpr/claude-code-workflows

Otestováno · Funguje ★ 9.2/10

Documentation Criteria — Rozhodovací matice + šablony pro to, kdy psát PRD, ADR, Design Doc a Work Plan

Co umí

Poskytuje matici kritérií mapující rozsah změny (počet souborů, podmínky ADR, typ funkce) na to, které plánovací dokumenty jsou vyžadovány a v jakém pořadí, plus šest referenčních šablon (PRD, ADR, UI Spec, Design Doc, Work Plan, Task) s jejich úložnými cestami, konvencemi pojmenování a požadovanými diagramy. Spouští se při vytváření nebo revizi technických dokumentů nebo při rozhodování, které dokumenty změna vyžaduje.

Testovací report

Načteno kanonické SKILL.md z skills/documentation-criteria; frontmatter se parsuje s name+description a všechny 3 namátkově zkontrolované šablony (prd/adr/design) vrátily HTTP 200; bez skriptů nebo bezpečnostních rizik. Naklonováno do dočasného HOME a potvrzeno, že SKILL.md se nachází v ~/.claude/skills/documentation-criteria/SKILL.md. Pro OUTPUT jsem zadal jeden úkol (new backend feature, ~7 files, new external payment API) a vytvořil dva artefakty: základní označil PRD za „probably overkill“ a snížil ADR na optional note, zatímco odpověď podle dovednosti aplikovala matici k nařízení PRD + formal ADR s minimum 3-option comparison (external dependency = ADR Condition #4) plus exact paths, naming conventions, a required diagrams the baseline omitted.

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

Instalace

git clone --depth 1 https://github.com/shinpr/claude-code-workflows.git /tmp/documentation-criteria-src
mkdir -p ~/.claude/skills
cp -R /tmp/documentation-criteria-src/skills/documentation-criteria ~/.claude/skills/documentation-criteria
# Pure markdown skill: SKILL.md + 6 reference templates in references/. No scripts, deps, or API keys.
# Repo ships several copies (dev-skills/, dev-workflows*/); skills/documentation-criteria is the canonical standalone one.

Příkazy a ukázkové prompty

/documentation-criteriaRozhodovací matice + šablony pro to, kdy psát PRD, ADR, Design Doc a Work Plan

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

Which documents does this feature require
Create an ADR for this architecture decision
Review this design doc against our criteria

Kompletní testovací report (anglicky) →