bmad-method 6.0.0-alpha.4 → 6.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. package/.claude/commands/bmad/bmm/agents/architect.md +0 -1
  2. package/.claude/commands/bmad/bmm/agents/sm.md +1 -1
  3. package/.claude/commands/bmad/bmm/agents/tech-writer.md +82 -0
  4. package/.claude/commands/bmad/bmm/workflows/README.md +1 -1
  5. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +15 -0
  6. package/.claude/commands/bmad/core/workflows/README.md +10 -0
  7. package/.claude/settings.local.json +4 -8
  8. package/CHANGELOG.md +305 -0
  9. package/README.md +88 -39
  10. package/bmad/_cfg/agent-manifest.csv +2 -1
  11. package/bmad/_cfg/agents/bmm-tech-writer.customize.yaml +42 -0
  12. package/bmad/_cfg/files-manifest.csv +40 -62
  13. package/bmad/_cfg/ides/claude-code.yaml +1 -1
  14. package/bmad/_cfg/manifest.yaml +4 -3
  15. package/bmad/_cfg/task-manifest.csv +4 -1
  16. package/bmad/_cfg/tool-manifest.csv +1 -0
  17. package/bmad/_cfg/workflow-manifest.csv +3 -1
  18. package/bmad/bmb/config.yaml +2 -2
  19. package/bmad/bmb/workflows/audit-workflow/instructions.md +1 -1
  20. package/bmad/bmm/README.md +79 -120
  21. package/bmad/bmm/README.md.bak +169 -0
  22. package/bmad/bmm/agents/analyst.md.bak +67 -0
  23. package/bmad/bmm/agents/architect.md +0 -1
  24. package/bmad/bmm/agents/architect.md.bak +73 -0
  25. package/bmad/bmm/agents/dev.md.bak +69 -0
  26. package/bmad/bmm/agents/pm.md.bak +76 -0
  27. package/bmad/bmm/agents/sm.md +1 -1
  28. package/bmad/bmm/agents/sm.md.bak +85 -0
  29. package/bmad/bmm/agents/tea.md.bak +72 -0
  30. package/bmad/bmm/agents/tech-writer.md +82 -0
  31. package/bmad/bmm/agents/ux-designer.md.bak +71 -0
  32. package/bmad/bmm/config.yaml +2 -2
  33. package/bmad/bmm/docs/README.md +235 -0
  34. package/bmad/bmm/docs/agents-guide.md +1057 -0
  35. package/bmad/bmm/docs/brownfield-guide.md +471 -972
  36. package/bmad/bmm/docs/enterprise-agentic-development.md +680 -0
  37. package/bmad/bmm/docs/faq.md +589 -0
  38. package/bmad/bmm/docs/glossary.md +321 -0
  39. package/bmad/bmm/docs/party-mode.md +224 -0
  40. package/bmad/bmm/docs/quick-spec-flow.md +64 -57
  41. package/bmad/bmm/docs/quick-start.md +72 -47
  42. package/bmad/bmm/docs/scale-adaptive-system.md +332 -778
  43. package/bmad/bmm/docs/troubleshooting.md +680 -0
  44. package/bmad/bmm/{workflows/3-solutioning/architecture/README.md → docs/workflow-architecture-reference.md} +130 -77
  45. package/bmad/bmm/{workflows/document-project/README.md → docs/workflow-document-project-reference.md} +45 -2
  46. package/bmad/bmm/docs/workflows-analysis.md +670 -0
  47. package/bmad/bmm/docs/workflows-implementation.md +1758 -0
  48. package/bmad/bmm/docs/workflows-planning.md +1086 -0
  49. package/bmad/bmm/docs/workflows-solutioning.md +726 -0
  50. package/bmad/bmm/tasks/daily-standup.xml +1 -1
  51. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml.bak +60 -0
  52. package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
  53. package/bmad/bmm/workflows/techdoc/documentation-standards.md +2 -1
  54. package/bmad/bmm/workflows/techdoc/documentation-standards.md.bak +238 -0
  55. package/bmad/bmm/workflows/workflow-status/init/instructions.md +623 -242
  56. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml.bak +27 -0
  57. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
  58. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
  59. package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
  60. package/{src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
  61. package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
  62. package/bmad/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  63. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
  64. package/bmad/cis/agents/brainstorming-coach.md.bak +62 -0
  65. package/bmad/cis/agents/creative-problem-solver.md.bak +62 -0
  66. package/bmad/cis/agents/design-thinking-coach.md.bak +62 -0
  67. package/bmad/cis/agents/innovation-strategist.md.bak +62 -0
  68. package/bmad/cis/agents/storyteller.md.bak +59 -0
  69. package/bmad/cis/config.yaml +2 -2
  70. package/bmad/core/agents/bmad-master.md.bak +15 -13
  71. package/bmad/core/config.yaml +2 -2
  72. package/bmad/core/tasks/workflow.xml +1 -11
  73. package/package.json +1 -1
  74. package/src/core/tasks/workflow.xml +1 -11
  75. package/src/modules/bmb/workflows/audit-workflow/instructions.md +1 -1
  76. package/src/modules/bmm/README.md +1 -1
  77. package/src/modules/bmm/agents/architect.agent.yaml +0 -4
  78. package/src/modules/bmm/agents/game-dev.agent.yaml +8 -12
  79. package/src/modules/bmm/agents/sm.agent.yaml +1 -1
  80. package/src/modules/bmm/agents/{paige.agent.yaml → tech-writer.agent.yaml} +4 -4
  81. package/src/modules/bmm/docs/README.md +9 -9
  82. package/src/modules/bmm/docs/agents-guide.md +46 -98
  83. package/src/modules/bmm/docs/brownfield-guide.md +211 -90
  84. package/src/modules/bmm/docs/enterprise-agentic-development.md +380 -740
  85. package/src/modules/bmm/docs/faq.md +10 -10
  86. package/src/modules/bmm/docs/glossary.md +36 -42
  87. package/src/modules/bmm/docs/party-mode.md +110 -1122
  88. package/src/modules/bmm/docs/quick-spec-flow.md +33 -33
  89. package/src/modules/bmm/docs/quick-start.md +29 -29
  90. package/src/modules/bmm/docs/scale-adaptive-system.md +303 -453
  91. package/src/modules/bmm/docs/troubleshooting.md +1 -1
  92. package/src/modules/bmm/docs/workflows-implementation.md +20 -21
  93. package/src/modules/bmm/docs/workflows-solutioning.md +1 -1
  94. package/src/modules/bmm/tasks/daily-standup.xml +1 -1
  95. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
  96. package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
  97. package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
  98. package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
  99. package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
  100. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
  101. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +2 -2
  102. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
  103. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
  104. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
  105. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
  106. package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
  107. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
  108. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
  109. package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
  110. package/src/modules/bmm/workflows/techdoc/documentation-standards.md +1 -1
  111. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +623 -242
  112. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
  113. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
  114. package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
  115. package/{bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
  116. package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
  117. package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  118. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
  119. package/bmad/bmm/tasks/retrospective.xml +0 -104
  120. package/bmad/bmm/testarch/README.md +0 -311
  121. package/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -113
  122. package/bmad/bmm/workflows/1-analysis/product-brief/README.md +0 -180
  123. package/bmad/bmm/workflows/1-analysis/research/README.md +0 -454
  124. package/bmad/bmm/workflows/2-plan-workflows/README.md +0 -258
  125. package/bmad/bmm/workflows/3-solutioning/README.md +0 -1
  126. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
  127. package/bmad/bmm/workflows/4-implementation/README.md +0 -221
  128. package/bmad/bmm/workflows/4-implementation/code-review/README.md +0 -69
  129. package/bmad/bmm/workflows/4-implementation/correct-course/README.md +0 -73
  130. package/bmad/bmm/workflows/4-implementation/create-story/README.md +0 -146
  131. package/bmad/bmm/workflows/4-implementation/dev-story/README.md +0 -206
  132. package/bmad/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
  133. package/bmad/bmm/workflows/4-implementation/retrospective/README.md +0 -77
  134. package/bmad/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
  135. package/bmad/bmm/workflows/4-implementation/story-context/README.md +0 -234
  136. package/bmad/bmm/workflows/README.md +0 -256
  137. package/bmad/bmm/workflows/document-project/templates/README.md +0 -38
  138. package/bmad/bmm/workflows/testarch/README.md +0 -26
  139. package/bmad/bmm/workflows/testarch/atdd/README.md +0 -672
  140. package/bmad/bmm/workflows/testarch/automate/README.md +0 -869
  141. package/bmad/bmm/workflows/testarch/ci/README.md +0 -493
  142. package/bmad/bmm/workflows/testarch/framework/README.md +0 -340
  143. package/bmad/bmm/workflows/testarch/nfr-assess/README.md +0 -469
  144. package/bmad/bmm/workflows/testarch/test-design/README.md +0 -493
  145. package/bmad/bmm/workflows/testarch/test-review/README.md +0 -775
  146. package/bmad/bmm/workflows/testarch/trace/README.md +0 -802
  147. package/bmad/bmm/workflows/workflow-status/README.md +0 -260
  148. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  149. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  150. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  151. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  152. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  153. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  154. package/src/modules/bmm/docs/brownfield-guide.md.backup +0 -1324
  155. package/src/modules/bmm/docs/workflows-testing.md +0 -1572
  156. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  157. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  158. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  159. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  160. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  161. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  162. /package/bmad/bmm/agents/{paige.md → paige.md.bak} +0 -0
@@ -1,77 +0,0 @@
1
- ---
2
- last-redoc-date: 2025-10-01
3
- ---
4
-
5
- # Retrospective Workflow
6
-
7
- The retrospective workflow is v6's learning capture mechanism, run by the Scrum Master (SM) after epic completion to systematically harvest insights, patterns, and improvements discovered during implementation. Unlike traditional retrospectives that focus primarily on process and team dynamics, this workflow performs deep technical and methodological analysis of the entire epic journey—from story creation through implementation to review—identifying what worked well, what could improve, and what patterns emerged. The retrospective produces actionable intelligence that informs future epics, improves workflow templates, and evolves the team's shared knowledge.
8
-
9
- This workflow represents a critical feedback loop in the v6 methodology. Each epic is an experiment in adaptive software development, and the retrospective is where we analyze the results of that experiment. The SM examines completed stories, review feedback, course corrections made, story-context effectiveness, technical decisions, and team collaboration patterns to extract transferable learning. This learning manifests as updates to workflow templates, new story-context patterns, refined estimation approaches, and documented best practices.
10
-
11
- The retrospective is not just a compliance ritual but a genuine opportunity for continuous improvement. By systematically analyzing what happened during the epic, the team builds institutional knowledge that makes each subsequent epic smoother, faster, and higher quality. The insights captured here directly improve future story creation, context generation, development efficiency, and review effectiveness.
12
-
13
- ## Usage
14
-
15
- ```bash
16
- # Conduct retrospective after epic completion
17
- bmad run retrospective
18
- ```
19
-
20
- The SM should run this workflow:
21
-
22
- - After all stories in an epic are completed
23
- - Before starting the next major epic
24
- - When significant learning has accumulated
25
- - As preparation for improving future epic execution
26
-
27
- ## Inputs
28
-
29
- **Required Context:**
30
-
31
- - **Epic Document**: Complete epic specification and goals
32
- - **All Story Documents**: Every story created for the epic
33
- - **Review Reports**: All review feedback and findings
34
- - **Course Corrections**: Any correct-course actions taken
35
- - **Story Contexts**: Generated expert guidance for each story
36
- - **Implementation Artifacts**: Code commits, test results, deployment records
37
-
38
- **Analysis Targets:**
39
-
40
- - Story creation accuracy and sizing
41
- - Story-context effectiveness and relevance
42
- - Implementation challenges and solutions
43
- - Review findings and patterns
44
- - Technical decisions and outcomes
45
- - Estimation accuracy
46
- - Team collaboration and communication
47
- - Workflow effectiveness
48
-
49
- ## Outputs
50
-
51
- **Primary Deliverable:**
52
-
53
- - **Retrospective Report** (`[epic-id]-retrospective.xml`): Comprehensive analysis including:
54
- - Executive summary of epic outcomes
55
- - Story-by-story analysis of what was learned
56
- - Technical insights and architecture learnings
57
- - Story-context effectiveness assessment
58
- - Process improvements identified
59
- - Patterns discovered (good and bad)
60
- - Recommendations for future epics
61
- - Metrics and statistics (velocity, cycle time, etc.)
62
-
63
- **Actionable Outputs:**
64
-
65
- - **Template Updates**: Improvements to workflow templates based on learning
66
- - **Pattern Library**: New story-context patterns for common scenarios
67
- - **Best Practices**: Documented approaches that worked well
68
- - **Gotchas**: Issues to avoid in future work
69
- - **Estimation Refinements**: Better story sizing guidance
70
- - **Process Changes**: Workflow adjustments for next epic
71
-
72
- **Artifacts:**
73
-
74
- - Epic marked as complete with retrospective attached
75
- - Knowledge base updated with new patterns
76
- - Workflow templates updated if needed
77
- - Team learning captured for onboarding
@@ -1,156 +0,0 @@
1
- # Sprint Planning Workflow
2
-
3
- ## Overview
4
-
5
- The sprint-planning workflow generates and manages the sprint status tracking file that serves as the single source of truth for Phase 4 implementation. It extracts all epics and stories from epic files and tracks their progress through the development lifecycle.
6
-
7
- In Agile terminology, this workflow facilitates **Sprint Planning** or **Sprint 0 Kickoff** - the transition from planning/architecture into actual development execution.
8
-
9
- ## Purpose
10
-
11
- This workflow creates a `sprint-status.yaml` file that:
12
-
13
- - Lists all epics, stories, and retrospectives in order
14
- - Tracks the current status of each item
15
- - Provides a clear view of what needs to be worked on next
16
- - Ensures only one story is in progress at a time
17
- - Maintains the development flow from backlog to done
18
-
19
- ## When to Use
20
-
21
- Run this workflow:
22
-
23
- 1. **Initially** - After Phase 3 (solutioning) is complete and epics are finalized
24
- 2. **After epic context creation** - To update epic status to 'contexted'
25
- 3. **Periodically** - To auto-detect newly created story files
26
- 4. **For status checks** - To see overall project progress
27
-
28
- ## Status State Machine
29
-
30
- ### Epic Flow
31
-
32
- ```
33
- backlog → contexted
34
- ```
35
-
36
- ### Story Flow
37
-
38
- ```
39
- backlog → drafted → ready-for-dev → in-progress → review → done
40
- ```
41
-
42
- ### Retrospective Flow
43
-
44
- ```
45
- optional ↔ completed
46
- ```
47
-
48
- ## Key Guidelines
49
-
50
- 1. **Epic Context Recommended**: Epics should be `contexted` before their stories can be `drafted`
51
- 2. **Flexible Parallelism**: Multiple stories can be `in-progress` based on team capacity
52
- 3. **Sequential Default**: Stories within an epic are typically worked in order, but parallel work is supported
53
- 4. **Review Flow**: Stories should go through `review` before `done`
54
- 5. **Learning Transfer**: SM typically drafts next story after previous is `done`, incorporating learnings
55
-
56
- ## File Locations
57
-
58
- ### Input Files
59
-
60
- - **Epic Files**: `{output_folder}/epic*.md` or `{output_folder}/epics.md`
61
- - **Epic Context**: `{output_folder}/epic-{n}-context.md`
62
- - **Story Files**: `{story_dir}/{epic}-{story}-{title}.md`
63
- - Example: `stories/1-1-user-authentication.md`
64
- - **Story Context**: `{story_dir}/{epic}-{story}-{title}-context.md`
65
- - Example: `stories/1-1-user-authentication-context.md`
66
-
67
- ### Output File
68
-
69
- - **Status File**: `{output_folder}/sprint-status.yaml`
70
-
71
- ## Usage by Agents
72
-
73
- ### SM (Scrum Master) Agent
74
-
75
- ```yaml
76
- Tasks:
77
- - Check sprint-status.yaml for stories in 'done' status
78
- - Identify next 'backlog' story to draft
79
- - Run create-story workflow
80
- - Update status to 'drafted'
81
- - Create story context
82
- - Update status to 'ready-for-dev'
83
- ```
84
-
85
- ### Developer Agent
86
-
87
- ```yaml
88
- Tasks:
89
- - Find stories with 'ready-for-dev' status
90
- - Update to 'in-progress' when starting
91
- - Implement the story
92
- - Update to 'review' when complete
93
- - Address review feedback
94
- - Update to 'done' after review
95
- ```
96
-
97
- ### Test Architect
98
-
99
- ```yaml
100
- Tasks:
101
- - Monitor stories entering 'review'
102
- - Track epic progress
103
- - Identify when retrospectives are needed
104
- ```
105
-
106
- ## Example Output
107
-
108
- ```yaml
109
- # Sprint Status
110
- # Generated: 2025-01-20
111
- # Project: MyPlantFamily
112
-
113
- development_status:
114
- epic-1: contexted
115
- 1-1-project-foundation: done
116
- 1-2-app-shell: done
117
- 1-3-user-authentication: in-progress
118
- 1-4-plant-data-model: ready-for-dev
119
- 1-5-add-plant-manual: drafted
120
- 1-6-photo-identification: backlog
121
- epic-1-retrospective: optional
122
-
123
- epic-2: contexted
124
- 2-1-personality-system: in-progress
125
- 2-2-chat-interface: drafted
126
- 2-3-llm-integration: backlog
127
- 2-4-reminder-system: backlog
128
- epic-2-retrospective: optional
129
- ```
130
-
131
- ## Integration with BMM Workflow
132
-
133
- This workflow is part of Phase 4 (Implementation) and integrates with:
134
-
135
- 1. **epic-tech-context** - Creates technical context for epics
136
- 2. **create-story** - Drafts individual story files
137
- 3. **story-context** - Adds implementation context to stories
138
- 4. **dev-story** - Developer implements the story
139
- 5. **code-review** - SM reviews implementation
140
- 6. **retrospective** - Optional epic retrospective
141
-
142
- ## Benefits
143
-
144
- - **Clear Visibility**: Everyone knows what's being worked on
145
- - **Flexible Capacity**: Supports both sequential and parallel work patterns
146
- - **Learning Transfer**: SM can incorporate learnings when drafting next story
147
- - **Progress Tracking**: Easy to see overall project status
148
- - **Automation Friendly**: Simple YAML format for agent updates
149
-
150
- ## Tips
151
-
152
- 1. **Initial Generation**: Run immediately after epics are finalized
153
- 2. **Regular Updates**: Agents should update status as they work
154
- 3. **Manual Override**: You can manually edit the file if needed
155
- 4. **Backup First**: The workflow backs up existing status before regenerating
156
- 5. **Validation**: The workflow validates legal status transitions
@@ -1,234 +0,0 @@
1
- # Story Context Assembly Workflow
2
-
3
- ## Overview
4
-
5
- Assembles a dynamic Story Context XML by pulling latest documentation and existing code/library artifacts relevant to a drafted story. Creates comprehensive development context for AI agents and developers working on specific stories.
6
-
7
- ## Key Features
8
-
9
- - **Automated Context Discovery** - Scans documentation and codebase for relevant artifacts
10
- - **XML Output Format** - Structured context optimized for LLM consumption
11
- - **Dependency Detection** - Identifies frameworks, packages, and technical dependencies
12
- - **Interface Mapping** - Locates existing APIs and interfaces to reuse
13
- - **Testing Integration** - Includes testing standards and generates test ideas
14
- - **Status Tracking** - Updates story status and maintains context references
15
-
16
- ## Usage
17
-
18
- ### Basic Invocation
19
-
20
- ```bash
21
- workflow story-context
22
- ```
23
-
24
- ### With Specific Story
25
-
26
- ```bash
27
- # Process specific story file
28
- workflow story-context --input /path/to/story.md
29
-
30
- # Using story path variable
31
- workflow story-context --story_path "docs/stories/1.2.feature-name.md"
32
- ```
33
-
34
- ### Configuration
35
-
36
- - **story_path**: Path to target story markdown file (defaults to latest.md)
37
- - **auto_update_status**: Whether to automatically update story status (default: false)
38
-
39
- ## Workflow Structure
40
-
41
- ### Files Included
42
-
43
- ```
44
- story-context/
45
- ├── workflow.yaml # Configuration and metadata
46
- ├── instructions.md # Step-by-step execution guide
47
- ├── context-template.xml # XML structure template
48
- ├── checklist.md # Validation criteria
49
- └── README.md # This file
50
- ```
51
-
52
- ## Workflow Process
53
-
54
- ### Phase 1: Story Analysis (Steps 1-2)
55
-
56
- - **Story Location**: Finds and loads target story markdown file
57
- - **Content Parsing**: Extracts epic ID, story ID, title, acceptance criteria, and tasks
58
- - **Template Initialization**: Creates initial XML context structure
59
- - **User Story Extraction**: Parses "As a... I want... So that..." components
60
-
61
- ### Phase 2: Documentation Discovery (Step 3)
62
-
63
- - **Keyword Analysis**: Identifies relevant terms from story content
64
- - **Document Scanning**: Searches docs and module documentation
65
- - **Authority Prioritization**: Prefers PRDs, architecture docs, and specs
66
- - **Context Extraction**: Captures relevant sections with snippets
67
-
68
- ### Phase 3: Code Analysis (Step 4)
69
-
70
- - **Symbol Search**: Finds relevant modules, functions, and components
71
- - **Interface Identification**: Locates existing APIs and interfaces
72
- - **Constraint Extraction**: Identifies development patterns and requirements
73
- - **Reuse Opportunities**: Highlights existing code to leverage
74
-
75
- ### Phase 4: Dependency Analysis (Step 5)
76
-
77
- - **Manifest Detection**: Scans for package.json, requirements.txt, go.mod, etc.
78
- - **Framework Identification**: Identifies Unity, Node.js, Python, Go ecosystems
79
- - **Version Tracking**: Captures dependency versions where available
80
- - **Configuration Discovery**: Finds relevant project configurations
81
-
82
- ### Phase 5: Testing Context (Step 6)
83
-
84
- - **Standards Extraction**: Identifies testing frameworks and patterns
85
- - **Location Mapping**: Documents where tests should be placed
86
- - **Test Ideas**: Generates initial test concepts for acceptance criteria
87
- - **Framework Integration**: Links to existing test infrastructure
88
-
89
- ### Phase 6: Validation and Updates (Steps 7-8)
90
-
91
- - **XML Validation**: Ensures proper structure and completeness
92
- - **Status Updates**: Changes story status from Draft to ContextReadyDraft
93
- - **Reference Tracking**: Adds context file reference to story document
94
- - **Quality Assurance**: Validates against workflow checklist
95
-
96
- ## Output
97
-
98
- ### Generated Files
99
-
100
- - **Primary output**: story-context-{epic_id}.{story_id}-{date}.xml
101
- - **Story updates**: Modified original story file with context references
102
-
103
- ### Output Structure
104
-
105
- ```xml
106
- <storyContext>
107
- <story>
108
- <basicInfo>
109
- <epicId>...</epicId>
110
- <storyId>...</storyId>
111
- <title>...</title>
112
- <status>...</status>
113
- </basicInfo>
114
- <userStory>
115
- <asA>...</asA>
116
- <iWant>...</iWant>
117
- <soThat>...</soThat>
118
- </userStory>
119
- <acceptanceCriteria>
120
- <criterion id="1">...</criterion>
121
- </acceptanceCriteria>
122
- <tasks>
123
- <task>...</task>
124
- </tasks>
125
- </story>
126
-
127
- <artifacts>
128
- <docs>
129
- <doc path="..." title="..." section="..." snippet="..."/>
130
- </docs>
131
- <code>
132
- <file path="..." kind="..." symbol="..." lines="..." reason="..."/>
133
- </code>
134
- <dependencies>
135
- <node>
136
- <package name="..." version="..."/>
137
- </node>
138
- </dependencies>
139
- </artifacts>
140
-
141
- <interfaces>
142
- <interface name="..." kind="..." signature="..." path="..."/>
143
- </interfaces>
144
-
145
- <constraints>
146
- <constraint>...</constraint>
147
- </constraints>
148
-
149
- <tests>
150
- <standards>...</standards>
151
- <locations>
152
- <location>...</location>
153
- </locations>
154
- <ideas>
155
- <idea ac="1">...</idea>
156
- </ideas>
157
- </tests>
158
- </storyContext>
159
- ```
160
-
161
- ## Requirements
162
-
163
- - **Story File**: Valid story markdown with proper structure (epic.story.title.md format)
164
- - **Repository Access**: Ability to scan documentation and source code
165
- - **Documentation**: Project documentation in standard locations (docs/, src/, etc.)
166
-
167
- ## Best Practices
168
-
169
- ### Before Starting
170
-
171
- 1. **Ensure Story Quality**: Verify story has clear acceptance criteria and tasks
172
- 2. **Update Documentation**: Ensure relevant docs are current and discoverable
173
- 3. **Clean Repository**: Remove obsolete code that might confuse context assembly
174
-
175
- ### During Execution
176
-
177
- 1. **Review Extracted Context**: Verify that discovered artifacts are actually relevant
178
- 2. **Check Interface Accuracy**: Ensure identified APIs and interfaces are current
179
- 3. **Validate Dependencies**: Confirm dependency information matches project state
180
-
181
- ### After Completion
182
-
183
- 1. **Review XML Output**: Validate the generated context makes sense
184
- 2. **Test with Developer**: Have a developer review context usefulness
185
- 3. **Update Story Status**: Verify story status was properly updated
186
-
187
- ## Troubleshooting
188
-
189
- ### Common Issues
190
-
191
- **Issue**: Context contains irrelevant or outdated information
192
-
193
- - **Solution**: Review keyword extraction and document filtering logic
194
- - **Check**: Ensure story title and acceptance criteria are specific and clear
195
-
196
- **Issue**: Missing relevant code or interfaces
197
-
198
- - **Solution**: Verify code search patterns and symbol extraction
199
- - **Check**: Ensure relevant code follows project naming conventions
200
-
201
- **Issue**: Dependency information is incomplete or wrong
202
-
203
- - **Solution**: Check for multiple package manifests or unusual project structure
204
- - **Check**: Verify dependency files are in expected locations and formats
205
-
206
- ## Customization
207
-
208
- To customize this workflow:
209
-
210
- 1. **Modify Search Patterns**: Update instructions.md to adjust code and doc discovery
211
- 2. **Extend XML Schema**: Customize context-template.xml for additional context types
212
- 3. **Add Validation**: Extend checklist.md with project-specific quality criteria
213
- 4. **Configure Dependencies**: Adjust dependency detection for specific tech stacks
214
-
215
- ## Version History
216
-
217
- - **v6.0.0** - XML-based context assembly with comprehensive artifact discovery
218
- - Multi-ecosystem dependency detection
219
- - Interface and constraint extraction
220
- - Testing context integration
221
- - Story status management
222
-
223
- ## Support
224
-
225
- For issues or questions:
226
-
227
- - Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
228
- - Validate output using `checklist.md`
229
- - Ensure story files follow expected markdown structure
230
- - Check that repository structure supports automated discovery
231
-
232
- ---
233
-
234
- _Part of the BMad Method v6 - BMM (Method) Module_