126 lines
2.6 KiB
Markdown
126 lines
2.6 KiB
Markdown
# <Document Title>
|
|
|
|
## Purpose
|
|
Describe why this requirement document exists and what decision or behavior it defines.
|
|
|
|
## Scope
|
|
Define what is included and excluded.
|
|
|
|
Included:
|
|
|
|
- <item>
|
|
- <item>
|
|
|
|
Excluded:
|
|
|
|
- <item>
|
|
- <item>
|
|
|
|
## Definitions
|
|
Define project-specific terms used in this document.
|
|
|
|
- `<term>`: <definition>
|
|
- `<term>`: <definition>
|
|
|
|
## Stakeholders
|
|
List roles responsible for implementation, approval, and operations.
|
|
|
|
- Product/Owner: <name or role>
|
|
- Engineering: <name or role>
|
|
- Operations: <name or role>
|
|
- QA/Test: <name or role>
|
|
|
|
## Preconditions
|
|
State assumptions that must be true before this requirement applies.
|
|
|
|
- <precondition>
|
|
- <precondition>
|
|
|
|
## Requirements
|
|
List clear, testable requirements.
|
|
|
|
### Functional Requirements
|
|
- FR-001: <requirement>
|
|
- FR-002: <requirement>
|
|
|
|
### Non-Functional Requirements
|
|
- NFR-001: <performance/security/reliability requirement>
|
|
- NFR-002: <operational requirement>
|
|
|
|
### Constraints
|
|
- C-001: <technical/process/policy constraint>
|
|
- C-002: <constraint>
|
|
|
|
## Data Requirements
|
|
Describe data model, persistence, retention, and migration expectations.
|
|
|
|
- <data requirement>
|
|
- <data requirement>
|
|
|
|
## Configuration Requirements
|
|
Describe configurable settings, defaults, validation, and permissions.
|
|
|
|
- <configuration requirement>
|
|
- <configuration requirement>
|
|
|
|
## Error Handling and Recovery
|
|
Define expected failure behavior and recovery paths.
|
|
|
|
- <error handling rule>
|
|
- <recovery rule>
|
|
|
|
## Security and Access
|
|
Define capability checks, secret handling, and least-privilege requirements.
|
|
|
|
- <security requirement>
|
|
- <access requirement>
|
|
|
|
## Operational Requirements
|
|
Describe deployment, monitoring, maintenance, and rollback expectations.
|
|
|
|
- <operational requirement>
|
|
- <operational requirement>
|
|
|
|
## Verification and Acceptance
|
|
Define how compliance will be validated.
|
|
|
|
### Test Cases
|
|
- TC-001: <test case>
|
|
- TC-002: <test case>
|
|
|
|
### Acceptance Criteria
|
|
- AC-001: <criterion>
|
|
- AC-002: <criterion>
|
|
|
|
## Dependencies
|
|
List dependencies on systems, services, plugins, APIs, or teams.
|
|
|
|
- <dependency>
|
|
- <dependency>
|
|
|
|
## Risks and Mitigations
|
|
Document known risks and planned mitigations.
|
|
|
|
- Risk: <risk>
|
|
Mitigation: <mitigation>
|
|
- Risk: <risk>
|
|
Mitigation: <mitigation>
|
|
|
|
## Open Questions
|
|
Track unresolved decisions.
|
|
|
|
- OQ-001: <question>
|
|
- OQ-002: <question>
|
|
|
|
## Change Log
|
|
Record meaningful revisions to the requirement.
|
|
|
|
- <YYYY-MM-DD> - <author/role> - <summary of change>
|
|
- <YYYY-MM-DD> - <author/role> - <summary of change>
|
|
|
|
## References
|
|
Link related requirement, documentation, test, or implementation files.
|
|
|
|
- <path or document>
|
|
- <path or document>
|