// 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.
| name | documentation-criteria |
| description | 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. |
| Condition | Required Documents | Creation Order |
|---|---|---|
| New Feature Addition | PRD â [ADR] â Design Doc â Work Plan | After PRD approval |
| ADR Conditions Met (see below) | ADR â Design Doc â Work Plan | Start immediately |
| 6+ Files | ADR â Design Doc â Work Plan (Required) | Start immediately |
| 3-5 Files | Design Doc â Work Plan (Recommended) | Start immediately |
| 1-2 Files | None | Direct implementation |
Contract A { Contract B { Contract C { field: T } } }
Purpose: Define business requirements and user value
Includes:
Excludes:
Purpose: Record technical decision rationale and background
Includes:
Excludes:
Purpose: Define technical implementation methods in detail
Includes:
Required Structural Elements:
Change Impact Map:
Change Target: [Component/Feature]
Direct Impact: [Files/Functions]
Indirect Impact: [Data format/Processing time]
No Ripple Effect: [Unaffected features]
Interface Change Matrix:
Existing: [Function/method/operation name]
New: [Function/method/operation name]
Conversion Required: [Yes/No]
Compatibility Method: [Approach]
Excludes:
Purpose: Implementation task management and progress tracking
Includes:
Excludes:
Phase Division Criteria:
Three Elements of Task Completion Definition:
| Document | Path | Naming Convention | Template |
|---|---|---|---|
| PRD | docs/prd/ | [feature-name]-prd.md | prd-template.md |
| ADR | docs/adr/ | ADR-[4-digits]-[title].md | adr-template.md |
| Design Doc | docs/design/ | [feature-name]-design.md | design-template.md |
| Work Plan | docs/plans/ | YYYYMMDD-{type}-{description}.md | plan-template.md |
*Note: Work plans are excluded by .gitignore
Proposed â Accepted â Deprecated/Superseded/Rejected
Required diagrams for each document (using mermaid notation):
| Document | Required Diagrams | Purpose |
|---|---|---|
| PRD | User journey diagram, Scope boundary diagram | Clarify user experience and scope |
| ADR | Option comparison diagram (when needed) | Visualize trade-offs |
| Design Doc | Architecture diagram, Data flow diagram | Understand technical structure |
| Work Plan | Phase structure diagram, Task dependency diagram | Clarify implementation order |