documentation-criteria
Documentation Criteria provides decision matrices and templates to identify which technical documents your feature or change requires. Use it to navigate PRD, ADR, UI Spec, Design Doc, and Work Plan creation based on scope, complexity, and architectural impact.
Documentation Criteria helps you determine which technical documents—PRD, ADR, Design Doc, Work Plan—are required for your feature or change.
AI-generated summary based on this skill's SKILL.md
Install
shinpr/claude-code-workflows/documentation-criteria · repository language: JavaScript
git clone https://github.com/shinpr/claude-code-workflows
cp -r claude-code-workflows/skills/documentation-criteria ~/.claude/skills/documentation-criterianpx skillfed install shinpr/claude-code-workflows/documentation-criteriaFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
When do I need an ADR architecture decision record?
Documentation Criteria helps you determine when an Architecture Decision Record is mandatory for your project. An ADR is typically required when your feature or change involves significant architectural decisions, system design choices, or technical trade-offs that affect multiple components or future development. Use Documentation Criteria's decision matrices to assess your feature's scope and complexity, then follow the provided ADR template to document the decision, context, and rationale.
What technical documentation templates does Documentation Criteria provide?
Documentation Criteria offers templates for five key technical documents: Product Requirements Document (PRD), Architecture Decision Record (ADR), Design Doc, UI Specification, and Work Plan. Each template is tailored to guide you through the essential sections and content structure needed for that document type. Access all templates directly within Documentation Criteria to ensure consistency across your technical projects.
How many documents do I need for my project?
Documentation Criteria provides a decision matrix to help you determine exactly which documents your project requires based on scope, complexity, and architectural impact. Not every project needs all five document types—Documentation Criteria guides you through the assessment process so you create only the necessary documentation without over-documenting or missing critical specs.
What's the correct creation order and dependencies for technical docs?
Documentation Criteria clarifies the creation order and dependencies between technical documents. Typically, the PRD establishes requirements first, followed by architectural decisions (ADR if needed), then design specifications and UI specs, with the Work Plan coordinating execution. Documentation Criteria's templates and guidelines show how each document builds on previous ones to ensure logical flow and consistency.
How do I determine which technical documents are required for a feature?
Documentation Criteria provides decision matrices and acceptance criteria to help you determine which technical documents your feature requires. Assess your feature's scope, complexity, and architectural impact using Documentation Criteria's framework, then follow the recommended document set. The tool also includes verification strategy requirements to ensure your documentation meets quality standards.
What should a design doc template for software features include?
Documentation Criteria's design doc template guides you through essential sections including problem statement, proposed solution, architectural overview, implementation details, dependencies, and trade-offs. The template helps you structure technical specifications clearly so stakeholders and developers understand the feature's design rationale and can execute implementation confidently.
SKILL.md
rendered from the published skill — quoted content, verbatim
Documentation Creation Criteria
Templates
- prd-template.md - Product Requirements Document template
- adr-template.md - Architecture Decision Record template
- ui-spec-template.md - UI Specification template (frontend/fullstack features)
- design-template.md - Technical Design Document template
- plan-template.md - Work Plan template
- 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 |
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 7 files
skills/documentation-criteria/SKILL.md
skills/documentation-criteria/references/adr-template.md
skills/documentation-criteria/references/design-template.md
skills/documentation-criteria/references/plan-template.md
skills/documentation-criteria/references/prd-template.md
skills/documentation-criteria/references/task-template.md
skills/documentation-criteria/references/ui-spec-template.md