ros/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-01-30 04:32:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update test-design workflow to generate two documents for system-level mode (#1367)

Browse Source 
* docs: update test-design workflow to generate two documents for system-level mode

* addressed pr comments
This commit is contained in:
Murat K Ozcan
2026-01-22 14:29:33 -06:00
committed by GitHub
parent 9b9f43fcb9
commit 6eb7c34752
15 changed files with 1274 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/how-to/brownfield/use-tea-for-enterprise.md
View File

@@ -114,10 +114,9 @@ Focus areas:
- Performance requirements (SLA: P99 <200ms)
- Compliance (HIPAA PHI handling, audit logging)
Output: test-design-system.md with:
- Security testing strategy
- Compliance requirement → test mapping
- Performance testing plan
Output: TWO documents (system-level):
- `test-design-architecture.md`: Security gaps, compliance requirements, performance SLOs for Architecture team
- `test-design-qa.md`: Security testing strategy, compliance test mapping, performance testing plan for QA team
- Audit logging validation
```

55
docs/how-to/workflows/run-test-design.md
View File

@@ -55,20 +55,44 @@ For epic-level:
### 5. Review the Output
TEA generates a comprehensive test design document.
TEA generates test design document(s) based on mode.
## What You Get
**System-Level Output (`test-design-system.md`):**
- Testability review of architecture
- ADR → test mapping
- Architecturally Significant Requirements (ASRs)
- Environment needs
- Test infrastructure recommendations
**System-Level Output (TWO Documents):**
**Epic-Level Output (`test-design-epic-N.md`):**
TEA produces two focused documents for system-level mode:
1. **`test-design-architecture.md`** (for Architecture/Dev teams)
- Purpose: Architectural concerns, testability gaps, NFR requirements
- Quick Guide with 🚨 BLOCKERS / ⚠️ HIGH PRIORITY / 📋 INFO ONLY
- Risk assessment (high/medium/low-priority with scoring)
- Testability concerns and architectural gaps
- Risk mitigation plans for high-priority risks (≥6)
- Assumptions and dependencies
2. **`test-design-qa.md`** (for QA team)
- Purpose: Test execution recipe, coverage plan, Sprint 0 setup
- Quick Reference for QA (Before You Start, Execution Order, Need Help)
- System architecture summary
- Test environment requirements (moved up - early in doc)
- Testability assessment (prerequisites checklist)
- Test levels strategy (unit/integration/E2E split)
- Test coverage plan (P0/P1/P2/P3 with detailed scenarios + checkboxes)
- Sprint 0 setup requirements (blockers, infrastructure, environments)
- NFR readiness summary
**Why Two Documents?**
- **Architecture teams** can scan blockers in <5 min (Quick Guide format)
- **QA teams** have actionable test recipes (step-by-step with checklists)
- **No redundancy** between documents (cross-references instead of duplication)
- **Clear separation** of concerns (what to deliver vs how to test)
**Epic-Level Output (ONE Document):**
**`test-design-epic-N.md`** (combined risk assessment + test plan)
- Risk assessment for the epic
- Test priorities
- Test priorities (P0-P3)
- Coverage plan
- Regression hotspots (for brownfield)
- Integration risks
@@ -82,12 +106,25 @@ TEA generates a comprehensive test design document.
| **Brownfield** | System-level + existing test baseline | Regression hotspots, integration risks |
| **Enterprise** | Compliance-aware testability | Security/performance/compliance focus |
## Examples
**System-Level (Two Documents):**
- `cluster-search/cluster-search-test-design-architecture.md` - Architecture doc with Quick Guide
- `cluster-search/cluster-search-test-design-qa.md` - QA doc with test scenarios
**Key Pattern:**
- Architecture doc: "ASR-1: OAuth 2.1 required (see QA doc for 12 test scenarios)"
- QA doc: "OAuth tests: 12 P0 scenarios (see Architecture doc R-001 for risk details)"
- No duplication, just cross-references
## Tips
- **Run system-level right after architecture** — Early testability review
- **Run epic-level at the start of each epic** — Targeted test planning
- **Update if ADRs change** — Keep test design aligned
- **Use output to guide other workflows** — Feeds into `*atdd` and `*automate`
- **Architecture teams review Architecture doc** — Focus on blockers and mitigation plans
- **QA teams use QA doc as implementation guide** — Follow test scenarios and Sprint 0 checklist
## Next Steps