~linuxgoose/engineering-templates

94f0a21dde86ccb73036e1272dca50152101f2c4 — Jordan Robinson 3 months ago e230c48
add feature request template
1 files changed, 137 insertions(+), 0 deletions(-)

A templates/feature-request.md
A templates/feature-request.md => templates/feature-request.md +137 -0
@@ 0,0 1,137 @@
# Feature Request - Solution Design

## Overview
**Request ID:** [Ticket/Request number]  
**Title:** [Feature name]  
**Requestor:** [Team/stakeholder]  
**Status:** [Draft/Review/Approved/In Progress]  
**Created:** [Date]  
**Last Updated:** [Date]

## Problem Statement
Describe the business problem or opportunity. What pain point does this feature address? What value will it deliver?

## Success Criteria
List measurable outcomes that define success for this feature:
- Criterion 1
- Criterion 2
- Criterion 3

## Proposed Solution

### Architecture Overview
High-level description of how the feature will be implemented. Include diagrams or ASCII art if helpful.

### Technical Approach
Detailed explanation of the implementation strategy, including:
- Technology stack decisions
- Key algorithms or patterns
- Data structures and models
- Integration points with existing systems

### Component Breakdown
Describe each major component and its responsibilities:

**Component 1: [Name]**
- Purpose
- Key functions
- Dependencies
- Interface

**Component 2: [Name]**
- Purpose
- Key functions
- Dependencies
- Interface

### Data Model Changes
Describe any new or modified database schemas, APIs, or data structures. Include field definitions and constraints.

## API / Interface Specifications
Define new endpoints, methods, or interfaces:

```
Endpoint: [Path]
Method: [GET/POST/PUT/DELETE]
Parameters: [List parameters]
Response: [Expected response format]
Error codes: [Relevant error responses]
```

## Performance Considerations
- Expected load/scale
- Performance targets and metrics
- Optimization strategies
- Caching approach (if applicable)

## Security & Compliance
- Authentication/authorization requirements
- Data privacy considerations
- Compliance requirements (GDPR, HIPAA, etc.)
- Security review needed: [Yes/No]

## Dependencies & Risks

### Internal Dependencies
- Services that must be modified or coordinated with
- Teams involved
- Blockers or prerequisites

### External Dependencies
- Third-party services or libraries
- Version compatibility requirements

### Risks & Mitigations
| Risk | Likelihood | Impact | Mitigation |
|------|-----------|--------|-----------|
| [Risk 1] | [High/Medium/Low] | [High/Medium/Low] | [Plan] |
| [Risk 2] | [High/Medium/Low] | [High/Medium/Low] | [Plan] |

## Implementation Plan

### Phase 1: [Phase name]
- Tasks and subtasks
- Owner
- Estimated effort
- Dependencies

### Phase 2: [Phase name]
- Tasks and subtasks
- Owner
- Estimated effort
- Dependencies

## Testing Strategy
- Unit test approach
- Integration test coverage
- End-to-end test scenarios
- Load/performance testing requirements
- QA sign-off criteria

## Deployment & Rollout
- Deployment strategy (blue-green, canary, etc.)
- Rollback procedure
- Monitoring and alerts
- Communication plan

## Monitoring & Observability
- Key metrics to track
- Logging and tracing approach
- Alert conditions
- Dashboard requirements

## Documentation & Knowledge Transfer
- Code documentation needed
- User documentation/guides
- Training requirements
- Knowledge transfer plan

## Alternatives Considered
Brief explanation of other approaches evaluated and why this solution was chosen.

## Approval & Sign-off
| Role | Name | Date |
|------|------|------|
| Lead Architect | | |
| Tech Lead | | |
| Product Lead | | |
\ No newline at end of file