mirror of
https://github.com/azaion/admin.git
synced 2026-04-22 22:06:33 +00:00
Oleksandr Bezdieniezhnykh
105 lines
3.1 KiB
Markdown
105 lines
3.1 KiB
Markdown
# Final Planning Report Template
|
|
|
|
Use this template after completing all 6 steps and the quality checklist. Save as `_docs/02_document/FINAL_report.md`.
|
|
|
|
---
|
|
|
|
```markdown
|
|
# [System Name] — Planning Report
|
|
|
|
## Executive Summary
|
|
|
|
[2-3 sentences: what was planned, the core architectural approach, and the key outcome (number of components, epics, estimated effort)]
|
|
|
|
## Problem Statement
|
|
|
|
[Brief restatement from problem.md — transformed, not copy-pasted]
|
|
|
|
## Architecture Overview
|
|
|
|
[Key architectural decisions and technology stack summary. Reference `architecture.md` for full details.]
|
|
|
|
**Technology stack**: [language, framework, database, hosting — one line]
|
|
|
|
**Deployment**: [environment strategy — one line]
|
|
|
|
## Component Summary
|
|
|
|
| # | Component | Purpose | Dependencies | Epic |
|
|
|---|-----------|---------|-------------|------|
|
|
| 01 | [name] | [one-line purpose] | — | [Jira ID] |
|
|
| 02 | [name] | [one-line purpose] | 01 | [Jira ID] |
|
|
| ... | | | | |
|
|
|
|
**Implementation order** (based on dependency graph):
|
|
1. [Phase 1: components that can start immediately]
|
|
2. [Phase 2: components that depend on Phase 1]
|
|
3. [Phase 3: ...]
|
|
|
|
## System Flows
|
|
|
|
| Flow | Description | Key Components |
|
|
|------|-------------|---------------|
|
|
| [name] | [one-line summary] | [component list] |
|
|
|
|
[Reference `system-flows.md` for full diagrams and details.]
|
|
|
|
## Risk Summary
|
|
|
|
| Level | Count | Key Risks |
|
|
|-------|-------|-----------|
|
|
| Critical | [N] | [brief list] |
|
|
| High | [N] | [brief list] |
|
|
| Medium | [N] | — |
|
|
| Low | [N] | — |
|
|
|
|
**Iterations completed**: [N]
|
|
**All Critical/High risks mitigated**: Yes / No — [details if No]
|
|
|
|
[Reference `risk_mitigations.md` for full register.]
|
|
|
|
## Test Coverage
|
|
|
|
| Component | Integration | Performance | Security | Acceptance | AC Coverage |
|
|
|-----------|-------------|-------------|----------|------------|-------------|
|
|
| [name] | [N tests] | [N tests] | [N tests] | [N tests] | [X/Y ACs] |
|
|
| ... | | | | | |
|
|
|
|
**Overall acceptance criteria coverage**: [X / Y total ACs covered] ([percentage]%)
|
|
|
|
## Epic Roadmap
|
|
|
|
| Order | Epic | Component | Effort | Dependencies |
|
|
|-------|------|-----------|--------|-------------|
|
|
| 1 | [Jira ID]: [name] | [component] | [S/M/L/XL] | — |
|
|
| 2 | [Jira ID]: [name] | [component] | [S/M/L/XL] | Epic 1 |
|
|
| ... | | | | |
|
|
|
|
**Total estimated effort**: [sum or range]
|
|
|
|
## Key Decisions Made
|
|
|
|
| # | Decision | Rationale | Alternatives Rejected |
|
|
|---|----------|-----------|----------------------|
|
|
| 1 | [decision] | [why] | [what was rejected] |
|
|
| 2 | | | |
|
|
|
|
## Open Questions
|
|
|
|
| # | Question | Impact | Assigned To |
|
|
|---|----------|--------|-------------|
|
|
| 1 | [unresolved question] | [what it blocks or affects] | [who should answer] |
|
|
|
|
## Artifact Index
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| `architecture.md` | System architecture |
|
|
| `system-flows.md` | System flows and diagrams |
|
|
| `components/01_[name]/description.md` | Component spec |
|
|
| `components/01_[name]/tests.md` | Test spec |
|
|
| `risk_mitigations.md` | Risk register |
|
|
| `diagrams/components.drawio` | Component diagram |
|
|
| `diagrams/flows/flow_[name].md` | Flow diagrams |
|
|
```
|