Documentation Criteria

Beslissingsmatrix + sjablonen voor wanneer PRD, ADR, Design Doc en Work Plan te schrijven

Door shinpr · shinpr/claude-code-workflows

Getest · Werkt ★ 9.2/10

Documentation Criteria — Beslissingsmatrix + sjablonen voor wanneer PRD, ADR, Design Doc en Work Plan te schrijven

Wat het doet

Biedt een criteriabasis die de schaal van de wijziging (aantal bestanden, ADR-voorwaarden, feature-type) koppelt aan welke planningsdocumenten vereist zijn en in welke volgorde, plus zes referentiesjablonen (PRD, ADR, UI Spec, Design Doc, Work Plan, Task) met hun opslagpaden, naamgevingsconventies en vereiste diagrammen. Activeert bij het maken of beoordelen van technische documenten of bij het beslissen welke documenten een wijziging vereist.

Testrapport

De canonieke SKILL.md opgehaald op skills/documentation-criteria; frontmatter parseert met naam+beschrijving en alle 3 steekproefsgewijs gecontroleerde sjablonen (prd/adr/design) retourneerden HTTP 200; geen scripts of beveiligingsrisico's. Gekloond naar een tijdelijke HOME en bevestigd dat SKILL.md landt op ~/.claude/skills/documentation-criteria/SKILL.md. Voor OUTPUT heb ik één taak gesteld (nieuwe backend-feature, ~7 bestanden, nieuwe externe betalings-API) en twee artefacten geschreven: de basislijn noemde PRD "waarschijnlijk overbodig" en degradeerde de ADR tot een optionele notitie, terwijl het door de vaardigheid gevolgde antwoord de matrix toepaste om PRD + een formele ADR met een minimale 3-optie vergelijking (externe afhankelijkheid = ADR Condition #4) plus exacte paden, naamgevingsconventies en vereiste diagrammen die de basislijn weglaten, te verplichten.

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

Installatie

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.

Commando's en voorbeeldprompts

  • /documentation-criteriaBeslissingsmatrix + sjablonen voor wanneer PRD, ADR, Design Doc en Work Plan te schrijven

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

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