Files
webref/.specify/templates/plan-template.md

2.4 KiB

Plan: [FEATURE_NAME]

Created: [YYYY-MM-DD]
Status: [Draft | Active | Completed | Obsolete]
Owner: [OWNER_NAME]

Overview

Brief description of what this plan aims to achieve and why it's important.

Objectives

  • Primary objective 1
  • Primary objective 2
  • Primary objective 3

Constitution Alignment Check

Before proceeding, verify alignment with constitutional principles:

  • Code Quality & Maintainability: How will this maintain/improve code quality?

    • Design follows single responsibility principle
    • Clear module boundaries defined
    • Dependencies justified and documented
  • Testing Discipline: What testing strategy will ensure correctness?

    • Unit test coverage plan (≥80%)
    • Integration test scenarios identified
    • Edge cases documented
  • User Experience Consistency: How does this impact users?

    • UI/API changes follow existing patterns
    • Error handling is user-friendly
    • Documentation plan complete
  • Performance & Efficiency: What are the performance implications?

    • Performance budget established
    • Algorithmic complexity analyzed
    • Resource usage estimated

Scope

In Scope

  • What will be built/changed
  • Explicit boundaries

Out of Scope

  • What will NOT be addressed
  • Deferred items for future work

Technical Approach

High-level technical strategy and architectural decisions.

Key Components

  1. Component A: Purpose and responsibilities
  2. Component B: Purpose and responsibilities
  3. Component C: Purpose and responsibilities

Dependencies

  • Internal dependencies (other modules/services)
  • External dependencies (libraries, APIs, services)

Risks & Mitigations

Risk Impact Probability Mitigation Strategy
Risk 1 High/Med/Low High/Med/Low How we'll address it

Implementation Phases

Phase 1: [Name] (Est: X days)

  • Milestone 1
  • Milestone 2

Phase 2: [Name] (Est: X days)

  • Milestone 3
  • Milestone 4

Success Criteria

Clear, measurable criteria for completion:

  • All tests passing with ≥80% coverage
  • Performance benchmarks met
  • Documentation complete
  • Code review approved
  • Production deployment successful

Open Questions

  • Question 1 that needs resolution
  • Question 2 that needs research

References

  • Link to specs
  • Related plans
  • External documentation