docs: initialize engineering starter kit
This commit is contained in:
@@ -0,0 +1,62 @@
|
||||
# Feature: {{FEATURE_NAME}}
|
||||
|
||||
## Objective
|
||||
|
||||
{{FEATURE_OBJECTIVE}}
|
||||
|
||||
## User Or System Value
|
||||
|
||||
{{USER_OR_SYSTEM_VALUE}}
|
||||
|
||||
## Requirements
|
||||
|
||||
- {{REQUIREMENT_1}}
|
||||
- {{REQUIREMENT_2}}
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- {{NON_GOAL_1}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] {{ACCEPTANCE_CRITERION_1}}
|
||||
- [ ] {{ACCEPTANCE_CRITERION_2}}
|
||||
|
||||
## Architecture Notes
|
||||
|
||||
- Affected modules: {{AFFECTED_MODULES}}
|
||||
- Dependency concerns: {{DEPENDENCY_CONCERNS}}
|
||||
- Data ownership: {{DATA_OWNERSHIP}}
|
||||
- Related ADRs: {{RELATED_ADRS}}
|
||||
|
||||
## API Or Interface Changes
|
||||
|
||||
{{API_OR_INTERFACE_CHANGES}}
|
||||
|
||||
## Data Changes
|
||||
|
||||
{{DATA_CHANGES}}
|
||||
|
||||
## Security And Authorization
|
||||
|
||||
{{SECURITY_AND_AUTHORIZATION}}
|
||||
|
||||
## Testing Plan
|
||||
|
||||
- Unit: {{UNIT_TEST_PLAN}}
|
||||
- Integration: {{INTEGRATION_TEST_PLAN}}
|
||||
- End-to-end: {{E2E_TEST_PLAN}}
|
||||
- Manual: {{MANUAL_TEST_PLAN}}
|
||||
|
||||
## Rollout Plan
|
||||
|
||||
{{ROLLOUT_PLAN}}
|
||||
|
||||
## Risks
|
||||
|
||||
- {{RISK_1}}
|
||||
- {{RISK_2}}
|
||||
|
||||
## Open Questions
|
||||
|
||||
- {{OPEN_QUESTION}}
|
||||
Reference in New Issue
Block a user