mirror of
https://github.com/azaion/gps-denied-desktop.git
synced 2026-04-23 07:06:36 +00:00
Update 2.2_gen_epics.md
epic format described
This commit is contained in:
@@ -25,15 +25,44 @@
|
||||
|
||||
## Output
|
||||
Epic format:
|
||||
- Integration tests
|
||||
- Summary
|
||||
- Detailed description
|
||||
- Input data for this specific test scenario
|
||||
- Expected result
|
||||
- Maximum expected time to get result
|
||||
- Epic Name [Component] – [Outcome]
|
||||
- Example: Data Ingestion – Near-real-time pipeline
|
||||
- Epic Summary (1–2 sentences)
|
||||
- What we are building + why it matters
|
||||
- Problem / Context
|
||||
- Current state, pain points, constraints, business opportunities, Links to architecture decision records or diagrams
|
||||
- Scope. Detailed description
|
||||
- In Scope. Bullet list of capabilities (not tasks)
|
||||
- Out-of-scope. Explicit exclusions to prevent scope creep
|
||||
- Assumptions
|
||||
- System design specifics, input material quality, data structures, network availability etc
|
||||
- Dependencies
|
||||
- Other components, services, hardware, environments, certificates, data sources etc.
|
||||
- Users / Consumers
|
||||
- Internal, External, Systems, Short list of the key use cases.
|
||||
- Requirements
|
||||
- Functional - API expectations, events, data handling, idempotency, retry behavior etc
|
||||
- Non-functional -Availability, latency, throughput, scalability, processing limits, data retention etc
|
||||
- Security/Compliance - Authentication, encryption, secrets, logging, SOC2/ISO is applicable
|
||||
- Design & Architecture (links)
|
||||
- High-level diagram link , Data flow, sequence diagrams, schemas etc
|
||||
- Definition of Done (Epic-level)
|
||||
- Feature list per epic scope
|
||||
- Automated tests (unit/integration/e2e) + minimum coverage threshold met
|
||||
- Runbooks if applicable
|
||||
- Documentation updated
|
||||
- Acceptance Criteria (measurable)
|
||||
- Risks & Mitigations
|
||||
- Top 5 risks (technical + delivery) with mitigation owners or systems involved
|
||||
- Label epic
|
||||
- component:<name>
|
||||
- env:prod|stg
|
||||
- type:platform|data|integration
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Jira Issue Breakdown
|
||||
- Create consistent child issues under the epic
|
||||
- Spikes
|
||||
- Tasks
|
||||
- Technical enablers
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user