107 lines
2.3 KiB
Markdown
107 lines
2.3 KiB
Markdown
# Feature: {{FEATURE_NAME}}
|
|
|
|
## Overview
|
|
|
|
{{Brief description of the feature and its value}}
|
|
|
|
## Problem Statement
|
|
|
|
{{What problem does this solve? Who benefits?}}
|
|
|
|
## User Stories
|
|
|
|
- As a {{user type}}, I want {{action}} so that {{benefit}}
|
|
- As a {{user type}}, I want {{action}} so that {{benefit}}
|
|
|
|
## Functional Requirements
|
|
|
|
### Core Requirements (Must Have)
|
|
|
|
1. {{Requirement 1}}
|
|
2. {{Requirement 2}}
|
|
3. {{Requirement 3}}
|
|
|
|
### Secondary Requirements (Nice to Have)
|
|
|
|
1. {{Requirement 1}}
|
|
2. {{Requirement 2}}
|
|
|
|
## Technical Requirements
|
|
|
|
### Files to Modify
|
|
|
|
| File | Changes |
|
|
|------|---------|
|
|
| `{{path/to/file1}}` | {{What to change}} |
|
|
| `{{path/to/file2}}` | {{What to change}} |
|
|
|
|
### New Files to Create
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| `{{path/to/new/file}}` | {{What this file does}} |
|
|
|
|
### Dependencies
|
|
|
|
- {{Existing module/library to use}}
|
|
- {{New dependency if needed}}
|
|
|
|
### Database Changes
|
|
|
|
{{None / Describe any schema changes, migrations, or queries}}
|
|
|
|
### API Changes
|
|
|
|
{{None / Describe new endpoints or modifications to existing ones}}
|
|
|
|
## Design Decisions
|
|
|
|
### Chosen Approach
|
|
|
|
{{Why this approach was selected}}
|
|
|
|
### Alternatives Considered
|
|
|
|
| Alternative | Pros | Cons | Why Not Chosen |
|
|
|-------------|------|------|----------------|
|
|
| {{Option A}} | {{Pros}} | {{Cons}} | {{Reason}} |
|
|
| {{Option B}} | {{Pros}} | {{Cons}} | {{Reason}} |
|
|
|
|
## Acceptance Criteria
|
|
|
|
- [ ] {{Testable criterion 1}}
|
|
- [ ] {{Testable criterion 2}}
|
|
- [ ] {{Testable criterion 3}}
|
|
- [ ] {{Testable criterion 4}}
|
|
|
|
## Out of Scope
|
|
|
|
The following are explicitly NOT included in this feature:
|
|
|
|
- {{Item 1}}
|
|
- {{Item 2}}
|
|
- {{Future enhancement to consider later}}
|
|
|
|
## Risks and Mitigations
|
|
|
|
| Risk | Likelihood | Impact | Mitigation |
|
|
|------|------------|--------|------------|
|
|
| {{Risk 1}} | Low/Medium/High | Low/Medium/High | {{How to mitigate}} |
|
|
| {{Risk 2}} | Low/Medium/High | Low/Medium/High | {{How to mitigate}} |
|
|
|
|
## Open Questions
|
|
|
|
- [ ] {{Question that needs clarification}}
|
|
- [ ] {{Another open question}}
|
|
|
|
## Estimated Complexity
|
|
|
|
**{{Low / Medium / High}}**
|
|
|
|
Justification: {{Brief explanation of complexity assessment}}
|
|
|
|
---
|
|
|
|
*Generated by Auto-Build spec-writer*
|
|
*Date: {{TIMESTAMP}}*
|