feat(enterprise): add requirement traceability to epics and readiness workflows
Implementation Readiness (D6): Added Enterprise track document discovery (StRS, SyRS, RTM) and comprehensive final assessment checks including StRS/SyRS completeness, RTM integrity, verification method assignment, cross-document consistency, and baseline status validation. Epics & Stories (D5): Added Enterprise track requirement traceability with source requirement ID references (StRS/SyRS/PRD) per story, verification method specification, and RTM forward coverage validation. Updated template with Enterprise traceability sections. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
e0b1b7cd9d
commit
e8f76504af
|
|
@ -81,6 +81,21 @@ Search for each document type using these patterns:
|
||||||
- Whole: `{planning_artifacts}/*ux*.md`
|
- Whole: `{planning_artifacts}/*ux*.md`
|
||||||
- Sharded: `{planning_artifacts}/*ux*/index.md` and related files
|
- Sharded: `{planning_artifacts}/*ux*/index.md` and related files
|
||||||
|
|
||||||
|
#### E. Enterprise Track Documents (if applicable)
|
||||||
|
|
||||||
|
Check the PRD frontmatter for `track: enterprise`. If Enterprise track:
|
||||||
|
|
||||||
|
- **StRS:** `{planning_artifacts}/*strs*.md`
|
||||||
|
- **SyRS:** `{planning_artifacts}/*syrs*.md`
|
||||||
|
- **RTM:** `{planning_artifacts}/*rtm*.md`
|
||||||
|
|
||||||
|
Flag missing Enterprise documents:
|
||||||
|
```
|
||||||
|
⚠️ ENTERPRISE TRACK: Required document not found
|
||||||
|
- StRS/SyRS/RTM document not found
|
||||||
|
- Enterprise track requires these for full readiness assessment
|
||||||
|
```
|
||||||
|
|
||||||
### 3. Organize Findings
|
### 3. Organize Findings
|
||||||
|
|
||||||
For each document type found:
|
For each document type found:
|
||||||
|
|
|
||||||
|
|
@ -63,6 +63,48 @@ Check the {outputFile} for sections added by previous steps:
|
||||||
- UX Alignment issues
|
- UX Alignment issues
|
||||||
- Epic Quality violations
|
- Epic Quality violations
|
||||||
|
|
||||||
|
### 2b. Enterprise Track Additional Checks (if applicable)
|
||||||
|
|
||||||
|
If the project is Enterprise track (check PRD frontmatter for `track: enterprise`), perform these additional validations:
|
||||||
|
|
||||||
|
**StRS Completeness:**
|
||||||
|
- [ ] StRS document exists and follows ISO 29148 Clause 7 structure
|
||||||
|
- [ ] All 7 major sections present (Introduction, References, Business Mgmt, Operational, User, System Concept, Constraints)
|
||||||
|
- [ ] StRS status is at least 'review' (check frontmatter)
|
||||||
|
|
||||||
|
**SyRS Completeness:**
|
||||||
|
- [ ] SyRS document exists and follows ISO 29148 Clause 8 structure
|
||||||
|
- [ ] System functional requirements mapped from PRD
|
||||||
|
- [ ] System interfaces defined
|
||||||
|
- [ ] Verification plan for each system requirement
|
||||||
|
- [ ] SyRS status is at least 'review' (check frontmatter)
|
||||||
|
|
||||||
|
**RTM Integrity:**
|
||||||
|
- [ ] RTM document exists with bidirectional traceability
|
||||||
|
- [ ] StRS → SyRS traceability present (forward coverage > 90%)
|
||||||
|
- [ ] SyRS → PRD traceability present (forward coverage > 90%)
|
||||||
|
- [ ] PRD → Stories traceability present (forward coverage > 95%)
|
||||||
|
- [ ] No orphan requirements at any level
|
||||||
|
- [ ] All requirement statuses documented
|
||||||
|
|
||||||
|
**Verification Method Assignment:**
|
||||||
|
- [ ] Every FR in PRD has a verification method assigned (Inspection / Analysis / Demonstration / Test)
|
||||||
|
- [ ] Every SyRS requirement has a verification method assigned
|
||||||
|
- [ ] Verification plan section exists in PRD
|
||||||
|
|
||||||
|
**Cross-Document Consistency:**
|
||||||
|
- [ ] StRS scope aligns with PRD scope
|
||||||
|
- [ ] SyRS interfaces match Architecture interfaces
|
||||||
|
- [ ] No terminology contradictions across documents
|
||||||
|
- [ ] Requirement priorities consistent across levels
|
||||||
|
|
||||||
|
**Baseline Status:**
|
||||||
|
- [ ] All requirement documents have version numbers in frontmatter
|
||||||
|
- [ ] Baseline version established (or ready to establish)
|
||||||
|
- [ ] Change history documented in each requirement document
|
||||||
|
|
||||||
|
Add Enterprise assessment findings to the report under a dedicated "Enterprise Track Assessment" section.
|
||||||
|
|
||||||
### 3. Add Final Assessment Section
|
### 3. Add Final Assessment Section
|
||||||
|
|
||||||
Append to {outputFile}:
|
Append to {outputFile}:
|
||||||
|
|
|
||||||
|
|
@ -91,6 +91,14 @@ Search for required documents using these patterns (sharded means a large docume
|
||||||
1. `{planning_artifacts}/*ux*.md` (whole document)
|
1. `{planning_artifacts}/*ux*.md` (whole document)
|
||||||
2. `{planning_artifacts}/*ux*/index.md` (sharded version)
|
2. `{planning_artifacts}/*ux*/index.md` (sharded version)
|
||||||
|
|
||||||
|
**Enterprise Track Documents (if PRD frontmatter has `track: enterprise`):**
|
||||||
|
|
||||||
|
1. **StRS:** `{planning_artifacts}/*strs*.md` - For requirement source traceability
|
||||||
|
2. **SyRS:** `{planning_artifacts}/*syrs*.md` - For system requirement references
|
||||||
|
3. **RTM:** `{planning_artifacts}/*rtm*.md` - For existing traceability matrix
|
||||||
|
|
||||||
|
If Enterprise track: these documents provide source requirement IDs that stories MUST reference.
|
||||||
|
|
||||||
Before proceeding, Ask the user if there are any other documents to include for analysis, and if anything found should be excluded. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
|
Before proceeding, Ask the user if there are any other documents to include for analysis, and if anything found should be excluded. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
|
||||||
|
|
||||||
### 3. Extract Functional Requirements (FRs)
|
### 3. Extract Functional Requirements (FRs)
|
||||||
|
|
|
||||||
|
|
@ -112,6 +112,20 @@ So that {value_benefit}.
|
||||||
**And** {additional_criteria}
|
**And** {additional_criteria}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**ENTERPRISE TRACK: REQUIREMENT TRACEABILITY**
|
||||||
|
|
||||||
|
If the project is Enterprise track (check PRD frontmatter for `track: enterprise`), each story MUST include a **Requirements Traceability** section after Acceptance Criteria:
|
||||||
|
|
||||||
|
```
|
||||||
|
**Requirements Traceability:**
|
||||||
|
- **PRD:** FR-AUTH-001, FR-AUTH-002
|
||||||
|
- **SyRS:** SYS-FUNC-001
|
||||||
|
- **StRS:** STK-BIZ-001
|
||||||
|
- **Verification:** Test
|
||||||
|
```
|
||||||
|
|
||||||
|
This links each story back to its source requirements at all levels. The verification method indicates how this story's requirements will be validated (Inspection / Analysis / Demonstration / Test).
|
||||||
|
|
||||||
**✅ GOOD STORY EXAMPLES:**
|
**✅ GOOD STORY EXAMPLES:**
|
||||||
|
|
||||||
_Epic 1: User Authentication_
|
_Epic 1: User Authentication_
|
||||||
|
|
|
||||||
|
|
@ -111,7 +111,27 @@ Review the complete epic and story breakdown to ensure EVERY FR is covered:
|
||||||
- Foundation stories only setup what's needed
|
- Foundation stories only setup what's needed
|
||||||
- No big upfront technical work
|
- No big upfront technical work
|
||||||
|
|
||||||
### 5. Dependency Validation (CRITICAL)
|
### 5. Enterprise Track: Requirements Traceability Validation
|
||||||
|
|
||||||
|
If the project is Enterprise track (check PRD frontmatter for `track: enterprise`):
|
||||||
|
|
||||||
|
**Requirement ID Reference Check:**
|
||||||
|
|
||||||
|
- [ ] Every story has a **Requirements Traceability** section
|
||||||
|
- [ ] Every story references at least one PRD FR by ID
|
||||||
|
- [ ] Every story references corresponding SyRS requirement ID (if SyRS exists)
|
||||||
|
- [ ] Every story references originating StRS requirement ID (if StRS exists)
|
||||||
|
- [ ] Every story specifies a verification method
|
||||||
|
|
||||||
|
**RTM Forward Coverage Check:**
|
||||||
|
|
||||||
|
- [ ] Every PRD FR is referenced by at least one story
|
||||||
|
- [ ] No stories reference non-existent requirement IDs
|
||||||
|
- [ ] FR Coverage Map is consistent with story requirement references
|
||||||
|
|
||||||
|
If traceability gaps found, list them as Critical findings and require resolution before completion.
|
||||||
|
|
||||||
|
### 6. Dependency Validation (CRITICAL)
|
||||||
|
|
||||||
**Epic Independence Check:**
|
**Epic Independence Check:**
|
||||||
|
|
||||||
|
|
@ -131,7 +151,7 @@ For each epic, review stories in order:
|
||||||
- ❌ WRONG: Story references features not yet implemented
|
- ❌ WRONG: Story references features not yet implemented
|
||||||
- ✅ RIGHT: Each story builds only on previous stories
|
- ✅ RIGHT: Each story builds only on previous stories
|
||||||
|
|
||||||
### 6. Complete and Save
|
### 7. Complete and Save
|
||||||
|
|
||||||
If all validations pass:
|
If all validations pass:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
stepsCompleted: []
|
stepsCompleted: []
|
||||||
inputDocuments: []
|
inputDocuments: []
|
||||||
|
track: "{{bmad|enterprise}}"
|
||||||
---
|
---
|
||||||
|
|
||||||
# {{project_name}} - Epic Breakdown
|
# {{project_name}} - Epic Breakdown
|
||||||
|
|
@ -27,6 +28,10 @@ This document provides the complete epic and story breakdown for {{project_name}
|
||||||
|
|
||||||
{{requirements_coverage_map}}
|
{{requirements_coverage_map}}
|
||||||
|
|
||||||
|
<!-- Enterprise Track Only: Requirements Traceability Summary -->
|
||||||
|
<!-- ### Requirements Traceability Summary -->
|
||||||
|
<!-- {{requirements_traceability_summary}} -->
|
||||||
|
|
||||||
## Epic List
|
## Epic List
|
||||||
|
|
||||||
{{epics_list}}
|
{{epics_list}}
|
||||||
|
|
@ -54,4 +59,11 @@ So that {{value_benefit}}.
|
||||||
**Then** {{expected_outcome}}
|
**Then** {{expected_outcome}}
|
||||||
**And** {{additional_criteria}}
|
**And** {{additional_criteria}}
|
||||||
|
|
||||||
|
<!-- Enterprise Track Only: Requirements Traceability per story -->
|
||||||
|
<!-- **Requirements Traceability:** -->
|
||||||
|
<!-- - **PRD:** {{prd_requirement_ids}} -->
|
||||||
|
<!-- - **SyRS:** {{syrs_requirement_ids}} -->
|
||||||
|
<!-- - **StRS:** {{strs_requirement_ids}} -->
|
||||||
|
<!-- - **Verification:** {{verification_method}} -->
|
||||||
|
|
||||||
<!-- End story repeat -->
|
<!-- End story repeat -->
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue