Documentation Criteria

Beslutsmatris + mallar för när man ska skriva PRD, ADR, Design Doc och Work Plan

av shinpr · shinpr/claude-code-workflows

Testad · Fungerar ★ 9.2/10

Documentation Criteria — Beslutsmatris + mallar för när man ska skriva PRD, ADR, Design Doc och Work Plan

Vad den gör

Tillhandahåller en kriteriematris som mappar ändringsskala (file count, ADR conditions, feature type) till vilka planeringsdokument som krävs och i vilken ordning, plus sex referensmallar (PRD, ADR, UI Spec, Design Doc, Work Plan, Task) med deras lagringssökvägar, namngivningskonventioner och nödvändiga diagram. Utlöses vid skapande eller granskning av tekniska dokument eller vid beslut om vilka dokument en ändring kräver.

Testrapport

Hämtade den kanoniska SKILL.md på skills/documentation-criteria; frontmatter parsas med name+description och alla 3 stickprovskontrollerade mallar (prd/adr/design) returnerade HTTP 200; inga skript eller säkerhetsbrister. Klonade till en temporär HOME och bekräftade att SKILL.md hamnar på ~/.claude/skills/documentation-criteria/SKILL.md. För UTDATA ställde jag en uppgift (new backend feature, ~7 files, new external payment API) och skrev två artefakter: baslinjen kallade PRD "probably overkill" och nedgraderade ADR till en valfri anteckning, medan det färdighets-följda svaret tillämpade matrisen för att kräva PRD + en formell ADR med en minimijämförelse av 3 alternativ (external dependency = ADR Condition #4) plus exakta sökvägar, namngivningskonventioner och nödvändiga diagram som baslinjen utelämnade.

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

Installation

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.

Kommandon och exempelprompter

/documentation-criteriaBeslutsmatris + mallar för när man ska skriva PRD, ADR, Design Doc och Work Plan

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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

Läs hela rapporten →