prd-template.mdโข3.37 kB
# [Title] - [Brief Description]
**Created**: [YYYY-MM-DD]
**Author**: [Author Name or Session ID]
**Reference Commit**: [Git commit hash from when PRD was created]
**Branch**: [Current branch name]
**Related Tasks**: [Task IDs if applicable]
**Status**: Draft | In Review | Approved | Implemented
**Priority**: P0 (Critical) | P1 (High) | P2 (Medium) | P3 (Low)
## Executive Summary
[2-3 sentences summarizing the problem and proposed solution]
## Problem Statement
[Detailed description of the problem being solved, including:
- What is broken or missing
- Who is affected
- Why it needs to be fixed
- Current behavior vs expected behavior]
## Goals & Non-Goals
### Goals
- [What this PRD will accomplish]
- [Specific objectives]
- [Success metrics]
### Non-Goals
- [What this PRD will NOT address]
- [Out of scope items]
- [Future considerations]
## User Stories
1. **As a [user type]**, I want to [action] so that [benefit]
2. **As a [user type]**, I want to [action] so that [benefit]
## Proposed Solution
### Overview
[High-level description of the solution]
### Technical Design
[Detailed technical approach including:
- Architecture changes
- New components
- Data flow
- API changes
- Database changes]
### Code Locations
- **Primary Files**: [List main files to be modified]
- **New Files**: [List new files to be created]
- **Test Files**: [List test files needed]
### Implementation Plan
1. **Phase 1**: [First implementation step]
2. **Phase 2**: [Second implementation step]
3. **Phase 3**: [Third implementation step]
## Alternative Solutions Considered
### Option 1: [Alternative Name]
- **Description**: [What this alternative would do]
- **Pros**: [Benefits]
- **Cons**: [Drawbacks]
- **Reason Not Chosen**: [Why rejected]
### Option 2: [Alternative Name]
- **Description**: [What this alternative would do]
- **Pros**: [Benefits]
- **Cons**: [Drawbacks]
- **Reason Not Chosen**: [Why rejected]
## Testing Requirements
### Unit Tests
- [Test scenario 1]
- [Test scenario 2]
### Integration Tests
- [Test scenario 1]
- [Test scenario 2]
### Manual Testing
- [Test scenario 1]
- [Test scenario 2]
## Impact Analysis
### Breaking Changes
[List any breaking changes or "None"]
### Performance Impact
[Expected performance impact or "Minimal"]
### Security Considerations
[Security implications or "None identified"]
### Compatibility
[Backward/forward compatibility notes]
## Success Criteria
1. [Measurable success criterion 1]
2. [Measurable success criterion 2]
3. [Measurable success criterion 3]
## Rollout Plan
### Phase 1: Development
- Timeline: [X days/weeks]
- Resources: [Who will work on this]
### Phase 2: Testing
- Timeline: [X days/weeks]
- Resources: [Who will test]
### Phase 3: Deployment
- Timeline: [X days/weeks]
- Deployment strategy: [How to deploy]
- Rollback plan: [How to rollback if needed]
## Documentation Updates
- [ ] Update README
- [ ] Update API documentation
- [ ] Update user guides
- [ ] Update developer documentation
- [ ] Update CHANGELOG
## Open Questions
1. [Question that needs answering]
2. [Another question]
## References
- [Link to related PRDs]
- [Link to design documents]
- [Link to external resources]
## Revision History
| Date | Author | Changes |
|------|--------|---------|
| [YYYY-MM-DD] | [Name] | Initial draft |
| [YYYY-MM-DD] | [Name] | [What changed] |