Update 2.2_gen_epics.md

epic format described
This commit is contained in:
Dennis Popov
2025-11-27 00:48:35 +01:00
committed by GitHub
parent f8390329cd
commit a329ad084c
+40 -11
View File
@@ -25,15 +25,44 @@
## Output ## Output
Epic format: Epic format:
- Integration tests - Epic Name [Component] [Outcome]
- Summary - Example: Data Ingestion Near-real-time pipeline
- Detailed description - Epic Summary (12 sentences)
- Input data for this specific test scenario - What we are building + why it matters
- Expected result - Problem / Context
- Maximum expected time to get result - 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 - Jira Issue Breakdown
- Create consistent child issues under the epic
- Spikes
## Notes - Tasks
- Technical enablers