documentation-criteria

Featured

Documentation creation criteria including PRD, ADR, Design Doc, and Work Plan requirements with templates. Use when creating or reviewing technical documents, or determining which documents are required.

AI & Automation 664 stars 101 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
94
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Documentation Creation Criteria ## Templates - **[prd-template.md](references/prd-template.md)** - Product Requirements Document template - **[adr-template.md](references/adr-template.md)** - Architecture Decision Record template - **[ui-spec-template.md](references/ui-spec-template.md)** - UI Specification template (frontend/fullstack features) - **[design-template.md](references/design-template.md)** - Technical Design Document template - **[plan-template.md](references/plan-template.md)** - Work Plan template - **[task-template.md](references/task-template.md)** - Task file template for implementation tasks ## Creation Decision Matrix | Condition | Required Documents | Creation Order | |-----------|-------------------|----------------| | New Feature Addition (backend) | PRD → [ADR] → Design Doc → Work Plan | After PRD approval | | New Feature Addition (frontend/fullstack) | PRD → **UI Spec** → [ADR] → Design Doc → Work Plan | UI Spec before Design Doc | | ADR Conditions Met (see below) | ADR → Design Doc → Work Plan | Start immediately | | 6+ Files | [ADR if conditions apply] → Design Doc → Work Plan (Design Doc + Work Plan required) | Start immediately | | 3-5 Files | Design Doc → Work Plan (Required) | Start immediately | | 1-2 Files | None | Direct implementation | ### Structural Escalation File count measures size, not structural impact, so a two-file change can still carry architecture-level consequences. When any ADR Creation Condition below applies, the sca...

Details

Author
shinpr
Repository
shinpr/claude-code-workflows
Created
10 months ago
Last Updated
2 weeks ago
Language
JavaScript
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category