bmad-method 4.28.0 → 4.29.1
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.
- package/CHANGELOG.md +14 -0
- package/bmad-core/agents/bmad-master.md +0 -2
- package/bmad-core/agents/bmad-orchestrator.md +0 -3
- package/bmad-core/core-config.yaml +1 -5
- package/bmad-core/data/bmad-kb.md +2 -2
- package/bmad-core/tasks/correct-course.md +9 -12
- package/bmad-core/tasks/create-brownfield-story.md +10 -61
- package/bmad-core/tasks/create-deep-research-prompt.md +5 -17
- package/bmad-core/tasks/create-next-story.md +3 -4
- package/bmad-core/tasks/document-project.md +37 -13
- package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +1 -1
- package/bmad-core/tasks/kb-mode-interaction.md +8 -3
- package/bmad-core/tasks/review-story.md +3 -3
- package/bmad-core/tasks/shard-doc.md +5 -9
- package/common/tasks/create-doc.md +4 -0
- package/dist/agents/analyst.txt +43 -31
- package/dist/agents/architect.txt +42 -30
- package/dist/agents/bmad-master.txt +61 -602
- package/dist/agents/bmad-orchestrator.txt +7 -548
- package/dist/agents/pm.txt +19 -38
- package/dist/agents/po.txt +14 -21
- package/dist/agents/qa.txt +3 -3
- package/dist/agents/sm.txt +11 -15
- package/dist/agents/ux-expert.txt +6 -18
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +5 -17
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +50 -579
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +5 -17
- package/dist/teams/team-all.txt +70 -607
- package/dist/teams/team-fullstack.txt +65 -601
- package/dist/teams/team-ide-minimal.txt +26 -575
- package/dist/teams/team-no-ui.txt +64 -600
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -0
- package/expansion-packs/bmad-creator-tools/config.yaml +1 -0
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -0
- package/package.json +1 -1
- package/tools/installer/lib/ide-setup.js +325 -12
- package/tools/installer/package.json +1 -1
- package/bmad-core/tasks/create-workflow-plan.md +0 -289
- package/bmad-core/tasks/doc-migration-task.md +0 -143
- package/bmad-core/tasks/update-workflow-plan.md +0 -248
- package/docs/template-markup-references.md +0 -86
|
@@ -64,7 +64,7 @@ persona:
|
|
|
64
64
|
- Process (*) commands immediately, All commands require * prefix when used (e.g., *help)
|
|
65
65
|
commands:
|
|
66
66
|
- help: Show these listed commands in a numbered list
|
|
67
|
-
- kb: Toggle KB mode off (default) or on, when on will load and reference the data/bmad-kb.md and converse with the user answering his questions with this informational resource
|
|
67
|
+
- kb: Toggle KB mode off (default) or on, when on will load and reference the .bmad-core/data/bmad-kb.md and converse with the user answering his questions with this informational resource
|
|
68
68
|
- task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
|
|
69
69
|
- create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
|
|
70
70
|
- execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
|
|
@@ -81,14 +81,12 @@ dependencies:
|
|
|
81
81
|
- correct-course.md
|
|
82
82
|
- create-deep-research-prompt.md
|
|
83
83
|
- create-doc.md
|
|
84
|
-
- create-workflow-plan.md
|
|
85
84
|
- document-project.md
|
|
86
85
|
- create-next-story.md
|
|
87
86
|
- execute-checklist.md
|
|
88
87
|
- generate-ai-frontend-prompt.md
|
|
89
88
|
- index-docs.md
|
|
90
89
|
- shard-doc.md
|
|
91
|
-
- update-workflow-plan.md
|
|
92
90
|
templates:
|
|
93
91
|
- architecture-tmpl.yaml
|
|
94
92
|
- brownfield-architecture-tmpl.yaml
|
|
@@ -246,7 +244,7 @@ Choose a number (0-8) or 9 to proceed:
|
|
|
246
244
|
==================== START: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
|
|
247
245
|
---
|
|
248
246
|
docOutputLocation: docs/brainstorming-session-results.md
|
|
249
|
-
template: brainstorming-output-tmpl
|
|
247
|
+
template: ".bmad-core/templates/brainstorming-output-tmpl.md"
|
|
250
248
|
---
|
|
251
249
|
|
|
252
250
|
# Facilitate Brainstorming Session Task
|
|
@@ -700,9 +698,9 @@ The story creation is successful when:
|
|
|
700
698
|
|
|
701
699
|
## Purpose
|
|
702
700
|
|
|
703
|
-
- Guide a structured response to a change trigger using the
|
|
701
|
+
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
|
704
702
|
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
|
705
|
-
- Explore potential solutions (e.g., adjust scope, rollback elements,
|
|
703
|
+
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
|
706
704
|
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
|
707
705
|
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
|
708
706
|
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
|
@@ -714,19 +712,16 @@ The story creation is successful when:
|
|
|
714
712
|
- **Acknowledge Task & Inputs:**
|
|
715
713
|
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
|
716
714
|
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
|
717
|
-
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the
|
|
715
|
+
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
|
|
718
716
|
- **Establish Interaction Mode:**
|
|
719
717
|
- Ask the user their preferred interaction mode for this task:
|
|
720
|
-
- **"Incrementally (Default & Recommended):** Shall we work through the
|
|
718
|
+
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
|
|
721
719
|
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
|
|
722
|
-
-
|
|
723
|
-
- Once the user chooses, confirm the selected mode (e.g., "Okay, we will proceed in Incremental mode."). This chosen mode will govern how subsequent steps in this task are executed.
|
|
724
|
-
- **Explain Process:** Briefly inform the user: "We will now use the `change-checklist` to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
|
725
|
-
<rule>When asking multiple questions or presenting multiple points for user input at once, number them clearly (e.g., 1., 2a., 2b.) to make it easier for the user to provide specific responses.</rule>
|
|
720
|
+
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
|
726
721
|
|
|
727
722
|
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
|
728
723
|
|
|
729
|
-
- Systematically work through Sections 1-4 of the
|
|
724
|
+
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
|
|
730
725
|
- For each checklist item or logical group of items (depending on interaction mode):
|
|
731
726
|
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
|
732
727
|
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
|
@@ -749,7 +744,7 @@ The story creation is successful when:
|
|
|
749
744
|
|
|
750
745
|
### 4. Generate "Sprint Change Proposal" with Edits
|
|
751
746
|
|
|
752
|
-
- Synthesize the complete
|
|
747
|
+
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
|
|
753
748
|
- The proposal must clearly present:
|
|
754
749
|
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
|
|
755
750
|
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
|
|
@@ -766,9 +761,9 @@ The story creation is successful when:
|
|
|
766
761
|
## Output Deliverables
|
|
767
762
|
|
|
768
763
|
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
|
769
|
-
- A summary of the
|
|
764
|
+
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
|
770
765
|
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
|
771
|
-
- **Implicit:** An annotated
|
|
766
|
+
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
|
772
767
|
==================== END: .bmad-core/tasks/correct-course.md ====================
|
|
773
768
|
|
|
774
769
|
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
|
|
@@ -788,7 +783,7 @@ Generate well-structured research prompts that:
|
|
|
788
783
|
|
|
789
784
|
## Research Type Selection
|
|
790
785
|
|
|
791
|
-
|
|
786
|
+
CRITICAL: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.
|
|
792
787
|
|
|
793
788
|
### 1. Research Focus Options
|
|
794
789
|
|
|
@@ -851,15 +846,13 @@ Present these numbered options to the user:
|
|
|
851
846
|
- Consider regulatory and legal implications
|
|
852
847
|
|
|
853
848
|
9. **Custom Research Focus**
|
|
854
|
-
|
|
849
|
+
|
|
855
850
|
- User-defined research objectives
|
|
856
851
|
- Specialized domain investigation
|
|
857
852
|
- Cross-functional research needs
|
|
858
853
|
|
|
859
854
|
### 2. Input Processing
|
|
860
855
|
|
|
861
|
-
[[LLM: Based on the selected research type and any provided inputs (project brief, brainstorming results, etc.), extract relevant context and constraints.]]
|
|
862
|
-
|
|
863
856
|
**If Project Brief provided:**
|
|
864
857
|
|
|
865
858
|
- Extract key product concepts and goals
|
|
@@ -892,11 +885,11 @@ Present these numbered options to the user:
|
|
|
892
885
|
|
|
893
886
|
### 3. Research Prompt Structure
|
|
894
887
|
|
|
895
|
-
|
|
888
|
+
CRITICAL: collaboratively develop a comprehensive research prompt with these components.
|
|
896
889
|
|
|
897
890
|
#### A. Research Objectives
|
|
898
891
|
|
|
899
|
-
|
|
892
|
+
CRITICAL: collaborate with the user to articulate clear, specific objectives for the research.
|
|
900
893
|
|
|
901
894
|
- Primary research goal and purpose
|
|
902
895
|
- Key decisions the research will inform
|
|
@@ -905,7 +898,7 @@ Present these numbered options to the user:
|
|
|
905
898
|
|
|
906
899
|
#### B. Research Questions
|
|
907
900
|
|
|
908
|
-
|
|
901
|
+
CRITICAL: collaborate with the user to develop specific, actionable research questions organized by theme.
|
|
909
902
|
|
|
910
903
|
**Core Questions:**
|
|
911
904
|
|
|
@@ -921,8 +914,6 @@ Present these numbered options to the user:
|
|
|
921
914
|
|
|
922
915
|
#### C. Research Methodology
|
|
923
916
|
|
|
924
|
-
[[LLM: Specify appropriate research methods based on the type and objectives.]]
|
|
925
|
-
|
|
926
917
|
**Data Collection Methods:**
|
|
927
918
|
|
|
928
919
|
- Secondary research sources
|
|
@@ -939,8 +930,6 @@ Present these numbered options to the user:
|
|
|
939
930
|
|
|
940
931
|
#### D. Output Requirements
|
|
941
932
|
|
|
942
|
-
[[LLM: Define how research findings should be structured and presented.]]
|
|
943
|
-
|
|
944
933
|
**Format Specifications:**
|
|
945
934
|
|
|
946
935
|
- Executive summary requirements
|
|
@@ -957,8 +946,6 @@ Present these numbered options to the user:
|
|
|
957
946
|
|
|
958
947
|
### 4. Prompt Generation
|
|
959
948
|
|
|
960
|
-
[[LLM: Synthesize all elements into a comprehensive, ready-to-use research prompt.]]
|
|
961
|
-
|
|
962
949
|
**Research Prompt Template:**
|
|
963
950
|
|
|
964
951
|
```markdown
|
|
@@ -1027,8 +1014,6 @@ Present these numbered options to the user:
|
|
|
1027
1014
|
|
|
1028
1015
|
### 5. Review and Refinement
|
|
1029
1016
|
|
|
1030
|
-
[[LLM: Present the draft research prompt for user review and refinement.]]
|
|
1031
|
-
|
|
1032
1017
|
1. **Present Complete Prompt**
|
|
1033
1018
|
|
|
1034
1019
|
- Show the full research prompt
|
|
@@ -1050,8 +1035,6 @@ Present these numbered options to the user:
|
|
|
1050
1035
|
|
|
1051
1036
|
### 6. Next Steps Guidance
|
|
1052
1037
|
|
|
1053
|
-
[[LLM: Provide clear guidance on how to use the research prompt.]]
|
|
1054
|
-
|
|
1055
1038
|
**Execution Options:**
|
|
1056
1039
|
|
|
1057
1040
|
1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
|
|
@@ -1157,298 +1140,6 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
|
1157
1140
|
- End with "Select 1-9 or just type your question/feedback:"
|
|
1158
1141
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
|
1159
1142
|
|
|
1160
|
-
==================== START: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
1161
|
-
# Create Workflow Plan Task
|
|
1162
|
-
|
|
1163
|
-
## Purpose
|
|
1164
|
-
|
|
1165
|
-
Guide users through workflow selection and create a detailed plan document that outlines the selected workflow steps, decision points, and expected outputs. This task helps users understand what will happen before starting a complex workflow and provides a checklist to track progress.
|
|
1166
|
-
|
|
1167
|
-
## Task Instructions
|
|
1168
|
-
|
|
1169
|
-
### 1. Understand User's Goal
|
|
1170
|
-
|
|
1171
|
-
[[LLM: Start with discovery questions to understand what the user wants to accomplish]]
|
|
1172
|
-
|
|
1173
|
-
Ask the user:
|
|
1174
|
-
|
|
1175
|
-
1. **Project Type**:
|
|
1176
|
-
- Are you starting a new project (greenfield) or enhancing an existing one (brownfield)?
|
|
1177
|
-
- What type of application? (web app, service/API, UI only, full-stack)
|
|
1178
|
-
|
|
1179
|
-
2. **For Greenfield**:
|
|
1180
|
-
- Do you need a quick prototype or production-ready application?
|
|
1181
|
-
- Will this have a UI component?
|
|
1182
|
-
- Single service or multiple services?
|
|
1183
|
-
|
|
1184
|
-
3. **For Brownfield**:
|
|
1185
|
-
- What's the scope of the enhancement?
|
|
1186
|
-
- Single bug fix or small feature (few hours)
|
|
1187
|
-
- Small enhancement (1-3 stories)
|
|
1188
|
-
- Major feature requiring coordination
|
|
1189
|
-
- Architectural changes or modernization
|
|
1190
|
-
- Do you have existing documentation?
|
|
1191
|
-
- Are you following existing patterns or introducing new ones?
|
|
1192
|
-
|
|
1193
|
-
### 2. Recommend Appropriate Workflow
|
|
1194
|
-
|
|
1195
|
-
Based on the answers, recommend:
|
|
1196
|
-
|
|
1197
|
-
**Greenfield Options:**
|
|
1198
|
-
|
|
1199
|
-
- `greenfield-fullstack` - Complete web application
|
|
1200
|
-
- `greenfield-service` - Backend API/service only
|
|
1201
|
-
- `greenfield-ui` - Frontend only
|
|
1202
|
-
|
|
1203
|
-
**Brownfield Options:**
|
|
1204
|
-
|
|
1205
|
-
- `brownfield-create-story` - Single small change
|
|
1206
|
-
- `brownfield-create-epic` - Small feature (1-3 stories)
|
|
1207
|
-
- `brownfield-fullstack` - Major enhancement
|
|
1208
|
-
|
|
1209
|
-
**Simplified Option:**
|
|
1210
|
-
|
|
1211
|
-
- For users unsure or wanting flexibility, suggest starting with individual agent tasks
|
|
1212
|
-
|
|
1213
|
-
### 3. Explain Selected Workflow
|
|
1214
|
-
|
|
1215
|
-
[[LLM: Once workflow is selected, provide clear explanation]]
|
|
1216
|
-
|
|
1217
|
-
For the selected workflow, explain:
|
|
1218
|
-
|
|
1219
|
-
1. **Overview**: What this workflow accomplishes
|
|
1220
|
-
2. **Duration**: Estimated time for planning phase
|
|
1221
|
-
3. **Outputs**: What documents will be created
|
|
1222
|
-
4. **Decision Points**: Where user input will be needed
|
|
1223
|
-
5. **Requirements**: What information should be ready
|
|
1224
|
-
|
|
1225
|
-
### 4. Create Workflow Plan Document
|
|
1226
|
-
|
|
1227
|
-
[[LLM: Generate a comprehensive plan document with the following structure]]
|
|
1228
|
-
|
|
1229
|
-
```markdown
|
|
1230
|
-
# Workflow Plan: {{Workflow Name}}
|
|
1231
|
-
|
|
1232
|
-
<!-- WORKFLOW-PLAN-META
|
|
1233
|
-
workflow-id: {{workflow-id}}
|
|
1234
|
-
status: active
|
|
1235
|
-
created: {{ISO-8601 timestamp}}
|
|
1236
|
-
updated: {{ISO-8601 timestamp}}
|
|
1237
|
-
version: 1.0
|
|
1238
|
-
-->
|
|
1239
|
-
|
|
1240
|
-
**Created Date**: {{current date}}
|
|
1241
|
-
**Project**: {{project name}}
|
|
1242
|
-
**Type**: {{greenfield/brownfield}}
|
|
1243
|
-
**Status**: Active
|
|
1244
|
-
**Estimated Planning Duration**: {{time estimate}}
|
|
1245
|
-
|
|
1246
|
-
## Objective
|
|
1247
|
-
|
|
1248
|
-
{{Clear description of what will be accomplished}}
|
|
1249
|
-
|
|
1250
|
-
## Selected Workflow
|
|
1251
|
-
|
|
1252
|
-
**Workflow**: `{{workflow-id}}`
|
|
1253
|
-
**Reason**: {{Why this workflow fits the user's needs}}
|
|
1254
|
-
|
|
1255
|
-
## Workflow Steps
|
|
1256
|
-
|
|
1257
|
-
### Planning Phase
|
|
1258
|
-
|
|
1259
|
-
- [ ] Step 1: {{step name}} <!-- step-id: 1.1, agent: {{agent}}, task: {{task}} -->
|
|
1260
|
-
- **Agent**: {{agent name}}
|
|
1261
|
-
- **Action**: {{what happens}}
|
|
1262
|
-
- **Output**: {{what's created}}
|
|
1263
|
-
- **User Input**: {{if any}}
|
|
1264
|
-
|
|
1265
|
-
- [ ] Step 2: {{step name}} <!-- step-id: 1.2, agent: {{agent}}, task: {{task}} -->
|
|
1266
|
-
- **Agent**: {{agent name}}
|
|
1267
|
-
- **Action**: {{what happens}}
|
|
1268
|
-
- **Output**: {{what's created}}
|
|
1269
|
-
- **Decision Point**: {{if any}} <!-- decision-id: D1 -->
|
|
1270
|
-
|
|
1271
|
-
{{Continue for all planning steps}}
|
|
1272
|
-
|
|
1273
|
-
### Development Phase (IDE)
|
|
1274
|
-
|
|
1275
|
-
- [ ] Document Sharding <!-- step-id: 2.1, agent: po, task: shard-doc -->
|
|
1276
|
-
- Prepare documents for story creation
|
|
1277
|
-
|
|
1278
|
-
- [ ] Story Development Cycle <!-- step-id: 2.2, repeats: true -->
|
|
1279
|
-
- [ ] Create story (SM agent) <!-- step-id: 2.2.1, agent: sm, task: create-next-story -->
|
|
1280
|
-
- [ ] Review story (optional) <!-- step-id: 2.2.2, agent: analyst, optional: true -->
|
|
1281
|
-
- [ ] Implement story (Dev agent) <!-- step-id: 2.2.3, agent: dev -->
|
|
1282
|
-
- [ ] QA review (optional) <!-- step-id: 2.2.4, agent: qa, optional: true -->
|
|
1283
|
-
- [ ] Repeat for all stories
|
|
1284
|
-
|
|
1285
|
-
- [ ] Epic Retrospective (optional) <!-- step-id: 2.3, agent: po, optional: true -->
|
|
1286
|
-
|
|
1287
|
-
## Key Decision Points
|
|
1288
|
-
|
|
1289
|
-
1. **{{Decision Name}}** (Step {{n}}): <!-- decision-id: D1, status: pending -->
|
|
1290
|
-
- Trigger: {{what causes this decision}}
|
|
1291
|
-
- Options: {{available choices}}
|
|
1292
|
-
- Impact: {{how it affects the workflow}}
|
|
1293
|
-
- Decision Made: _Pending_
|
|
1294
|
-
|
|
1295
|
-
{{List all decision points}}
|
|
1296
|
-
|
|
1297
|
-
## Expected Outputs
|
|
1298
|
-
|
|
1299
|
-
### Planning Documents
|
|
1300
|
-
- [ ] {{document 1}} - {{description}}
|
|
1301
|
-
- [ ] {{document 2}} - {{description}}
|
|
1302
|
-
{{etc...}}
|
|
1303
|
-
|
|
1304
|
-
### Development Artifacts
|
|
1305
|
-
- [ ] Stories in `docs/stories/`
|
|
1306
|
-
- [ ] Implementation code
|
|
1307
|
-
- [ ] Tests
|
|
1308
|
-
- [ ] Updated documentation
|
|
1309
|
-
|
|
1310
|
-
## Prerequisites Checklist
|
|
1311
|
-
|
|
1312
|
-
Before starting this workflow, ensure you have:
|
|
1313
|
-
|
|
1314
|
-
- [ ] {{prerequisite 1}}
|
|
1315
|
-
- [ ] {{prerequisite 2}}
|
|
1316
|
-
- [ ] {{prerequisite 3}}
|
|
1317
|
-
{{etc...}}
|
|
1318
|
-
|
|
1319
|
-
## Customization Options
|
|
1320
|
-
|
|
1321
|
-
Based on your project needs, you may:
|
|
1322
|
-
- Skip {{optional step}} if {{condition}}
|
|
1323
|
-
- Add {{additional step}} if {{condition}}
|
|
1324
|
-
- Choose {{alternative}} instead of {{default}}
|
|
1325
|
-
|
|
1326
|
-
## Risk Considerations
|
|
1327
|
-
|
|
1328
|
-
{{For brownfield only}}
|
|
1329
|
-
- Integration complexity: {{assessment}}
|
|
1330
|
-
- Rollback strategy: {{approach}}
|
|
1331
|
-
- Testing requirements: {{special needs}}
|
|
1332
|
-
|
|
1333
|
-
## Next Steps
|
|
1334
|
-
|
|
1335
|
-
1. Review this plan and confirm it matches your expectations
|
|
1336
|
-
2. Gather any missing prerequisites
|
|
1337
|
-
3. Start workflow with: `*task workflow {{workflow-id}}`
|
|
1338
|
-
4. Or begin with first agent: `@{{first-agent}}`
|
|
1339
|
-
|
|
1340
|
-
## Notes
|
|
1341
|
-
|
|
1342
|
-
{{Any additional context or warnings}}
|
|
1343
|
-
|
|
1344
|
-
---
|
|
1345
|
-
*This plan can be updated as you progress through the workflow. Check off completed items to track progress.*
|
|
1346
|
-
```
|
|
1347
|
-
|
|
1348
|
-
### 5. Save and Present Plan
|
|
1349
|
-
|
|
1350
|
-
1. Save the plan as `docs/workflow-plan.md`
|
|
1351
|
-
2. Inform user: "Workflow plan created at docs/workflow-plan.md"
|
|
1352
|
-
3. Offer options:
|
|
1353
|
-
- Review the plan together
|
|
1354
|
-
- Start the workflow now
|
|
1355
|
-
- Gather prerequisites first
|
|
1356
|
-
- Modify the plan
|
|
1357
|
-
|
|
1358
|
-
### 6. Plan Variations
|
|
1359
|
-
|
|
1360
|
-
[[LLM: Adjust plan detail based on workflow complexity]]
|
|
1361
|
-
|
|
1362
|
-
**For Simple Workflows** (create-story, create-epic):
|
|
1363
|
-
|
|
1364
|
-
- Simpler checklist format
|
|
1365
|
-
- Focus on immediate next steps
|
|
1366
|
-
- Less detailed explanations
|
|
1367
|
-
|
|
1368
|
-
**For Complex Workflows** (full greenfield/brownfield):
|
|
1369
|
-
|
|
1370
|
-
- Detailed step breakdowns
|
|
1371
|
-
- All decision points documented
|
|
1372
|
-
- Comprehensive output descriptions
|
|
1373
|
-
- Risk mitigation sections
|
|
1374
|
-
|
|
1375
|
-
**For Brownfield Workflows**:
|
|
1376
|
-
|
|
1377
|
-
- Include existing system impact analysis
|
|
1378
|
-
- Document integration checkpoints
|
|
1379
|
-
- Add rollback considerations
|
|
1380
|
-
- Note documentation dependencies
|
|
1381
|
-
|
|
1382
|
-
### 7. Interactive Planning Mode
|
|
1383
|
-
|
|
1384
|
-
[[LLM: If user wants to customize the workflow]]
|
|
1385
|
-
|
|
1386
|
-
If user wants to modify the standard workflow:
|
|
1387
|
-
|
|
1388
|
-
1. Present workflow steps as options
|
|
1389
|
-
2. Allow skipping optional steps
|
|
1390
|
-
3. Let user reorder certain steps
|
|
1391
|
-
4. Document customizations in plan
|
|
1392
|
-
5. Warn about dependencies if steps are skipped
|
|
1393
|
-
|
|
1394
|
-
### 8. Execution Guidance
|
|
1395
|
-
|
|
1396
|
-
After plan is created, provide clear guidance:
|
|
1397
|
-
|
|
1398
|
-
```text
|
|
1399
|
-
Your workflow plan is ready! Here's how to proceed:
|
|
1400
|
-
|
|
1401
|
-
1. **Review the plan**: Check that all steps align with your goals
|
|
1402
|
-
2. **Gather prerequisites**: Use the checklist to ensure you're ready
|
|
1403
|
-
3. **Start execution**:
|
|
1404
|
-
- Full workflow: `*task workflow {{workflow-id}}`
|
|
1405
|
-
- Step by step: Start with `@{{first-agent}}`
|
|
1406
|
-
4. **Track progress**: Check off steps in the plan as completed
|
|
1407
|
-
|
|
1408
|
-
Would you like to:
|
|
1409
|
-
a) Review the plan together
|
|
1410
|
-
b) Start the workflow now
|
|
1411
|
-
c) Gather prerequisites first
|
|
1412
|
-
d) Modify the plan
|
|
1413
|
-
```
|
|
1414
|
-
|
|
1415
|
-
## Success Criteria
|
|
1416
|
-
|
|
1417
|
-
The workflow plan is successful when:
|
|
1418
|
-
|
|
1419
|
-
1. User clearly understands what will happen
|
|
1420
|
-
2. All decision points are documented
|
|
1421
|
-
3. Prerequisites are identified
|
|
1422
|
-
4. Expected outputs are clear
|
|
1423
|
-
5. User feels confident to proceed
|
|
1424
|
-
6. Plan serves as useful progress tracker
|
|
1425
|
-
|
|
1426
|
-
## Integration with BMad Master and Orchestrator
|
|
1427
|
-
|
|
1428
|
-
When used by BMad Master or BMad Orchestrator, this task should:
|
|
1429
|
-
|
|
1430
|
-
1. Be offered when user asks about workflows
|
|
1431
|
-
2. Be suggested before starting complex workflows
|
|
1432
|
-
3. Create a plan that the agent can reference during execution
|
|
1433
|
-
4. Allow the agent to track progress against the plan
|
|
1434
|
-
|
|
1435
|
-
## Example Usage
|
|
1436
|
-
|
|
1437
|
-
```text
|
|
1438
|
-
User: "I need to add a payment system to my existing app"
|
|
1439
|
-
|
|
1440
|
-
BMad Orchestrator: "Let me help you create a workflow plan for that enhancement. I'll ask a few questions to recommend the best approach..."
|
|
1441
|
-
|
|
1442
|
-
[Runs through discovery questions]
|
|
1443
|
-
|
|
1444
|
-
BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack workflow. Let me create a detailed plan for you..."
|
|
1445
|
-
|
|
1446
|
-
[Creates and saves plan]
|
|
1447
|
-
|
|
1448
|
-
BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
|
|
1449
|
-
```
|
|
1450
|
-
==================== END: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
1451
|
-
|
|
1452
1143
|
==================== START: .bmad-core/tasks/document-project.md ====================
|
|
1453
1144
|
# Document an Existing Project
|
|
1454
1145
|
|
|
@@ -1460,9 +1151,9 @@ Generate comprehensive documentation for existing projects optimized for AI deve
|
|
|
1460
1151
|
|
|
1461
1152
|
### 1. Initial Project Analysis
|
|
1462
1153
|
|
|
1463
|
-
|
|
1154
|
+
**CRITICAL:** First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
|
1464
1155
|
|
|
1465
|
-
**IF PRD EXISTS**:
|
|
1156
|
+
**IF PRD EXISTS**:
|
|
1466
1157
|
|
|
1467
1158
|
- Review the PRD to understand what enhancement/feature is planned
|
|
1468
1159
|
- Identify which modules, services, or areas will be affected
|
|
@@ -1508,11 +1199,10 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
1508
1199
|
- Are there any existing documentation standards or formats you prefer?
|
|
1509
1200
|
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
|
1510
1201
|
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
|
1511
|
-
]]
|
|
1512
1202
|
|
|
1513
1203
|
### 2. Deep Codebase Analysis
|
|
1514
1204
|
|
|
1515
|
-
|
|
1205
|
+
CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
|
|
1516
1206
|
|
|
1517
1207
|
1. **Explore Key Areas**:
|
|
1518
1208
|
- Entry points (main files, index files, app initializers)
|
|
@@ -1535,13 +1225,14 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
1535
1225
|
- Document workarounds and technical debt
|
|
1536
1226
|
- Note areas that differ from standard patterns
|
|
1537
1227
|
|
|
1538
|
-
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement
|
|
1228
|
+
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement
|
|
1539
1229
|
|
|
1540
1230
|
### 3. Core Documentation Generation
|
|
1541
1231
|
|
|
1542
1232
|
[[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
|
|
1543
1233
|
|
|
1544
1234
|
**CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
|
|
1235
|
+
|
|
1545
1236
|
- Technical debt and workarounds
|
|
1546
1237
|
- Inconsistent patterns between different parts
|
|
1547
1238
|
- Legacy code that can't be changed
|
|
@@ -1553,13 +1244,16 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
1553
1244
|
# [Project Name] Brownfield Architecture Document
|
|
1554
1245
|
|
|
1555
1246
|
## Introduction
|
|
1247
|
+
|
|
1556
1248
|
This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
|
|
1557
1249
|
|
|
1558
1250
|
### Document Scope
|
|
1251
|
+
|
|
1559
1252
|
[If PRD provided: "Focused on areas relevant to: {enhancement description}"]
|
|
1560
1253
|
[If no PRD: "Comprehensive documentation of entire system"]
|
|
1561
1254
|
|
|
1562
1255
|
### Change Log
|
|
1256
|
+
|
|
1563
1257
|
| Date | Version | Description | Author |
|
|
1564
1258
|
|------|---------|-------------|--------|
|
|
1565
1259
|
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
|
@@ -1567,6 +1261,7 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1567
1261
|
## Quick Reference - Key Files and Entry Points
|
|
1568
1262
|
|
|
1569
1263
|
### Critical Files for Understanding the System
|
|
1264
|
+
|
|
1570
1265
|
- **Main Entry**: `src/index.js` (or actual entry point)
|
|
1571
1266
|
- **Configuration**: `config/app.config.js`, `.env.example`
|
|
1572
1267
|
- **Core Business Logic**: `src/services/`, `src/domain/`
|
|
@@ -1575,22 +1270,25 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1575
1270
|
- **Key Algorithms**: [List specific files with complex logic]
|
|
1576
1271
|
|
|
1577
1272
|
### If PRD Provided - Enhancement Impact Areas
|
|
1273
|
+
|
|
1578
1274
|
[Highlight which files/modules will be affected by the planned enhancement]
|
|
1579
1275
|
|
|
1580
1276
|
## High Level Architecture
|
|
1581
1277
|
|
|
1582
1278
|
### Technical Summary
|
|
1583
|
-
[Real assessment of architecture - mention if it's well-structured or has issues]
|
|
1584
1279
|
|
|
1585
1280
|
### Actual Tech Stack (from package.json/requirements.txt)
|
|
1281
|
+
|
|
1586
1282
|
| Category | Technology | Version | Notes |
|
|
1587
1283
|
|----------|------------|---------|--------|
|
|
1588
1284
|
| Runtime | Node.js | 16.x | [Any constraints] |
|
|
1589
1285
|
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
|
1590
1286
|
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
|
1591
|
-
|
|
1287
|
+
|
|
1288
|
+
etc...
|
|
1592
1289
|
|
|
1593
1290
|
### Repository Structure Reality Check
|
|
1291
|
+
|
|
1594
1292
|
- Type: [Monorepo/Polyrepo/Hybrid]
|
|
1595
1293
|
- Package Manager: [npm/yarn/pnpm]
|
|
1596
1294
|
- Notable: [Any unusual structure decisions]
|
|
@@ -1598,7 +1296,8 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
1598
1296
|
## Source Tree and Module Organization
|
|
1599
1297
|
|
|
1600
1298
|
### Project Structure (Actual)
|
|
1601
|
-
|
|
1299
|
+
|
|
1300
|
+
```text
|
|
1602
1301
|
project-root/
|
|
1603
1302
|
├── src/
|
|
1604
1303
|
│ ├── controllers/ # HTTP request handlers
|
|
@@ -1612,6 +1311,7 @@ project-root/
|
|
|
1612
1311
|
```
|
|
1613
1312
|
|
|
1614
1313
|
### Key Modules and Their Purpose
|
|
1314
|
+
|
|
1615
1315
|
- **User Management**: `src/services/userService.js` - Handles all user operations
|
|
1616
1316
|
- **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
|
|
1617
1317
|
- **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
|
|
@@ -1620,12 +1320,14 @@ project-root/
|
|
|
1620
1320
|
## Data Models and APIs
|
|
1621
1321
|
|
|
1622
1322
|
### Data Models
|
|
1323
|
+
|
|
1623
1324
|
Instead of duplicating, reference actual model files:
|
|
1624
1325
|
- **User Model**: See `src/models/User.js`
|
|
1625
1326
|
- **Order Model**: See `src/models/Order.js`
|
|
1626
1327
|
- **Related Types**: TypeScript definitions in `src/types/`
|
|
1627
1328
|
|
|
1628
1329
|
### API Specifications
|
|
1330
|
+
|
|
1629
1331
|
- **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
|
|
1630
1332
|
- **Postman Collection**: `docs/api/postman-collection.json`
|
|
1631
1333
|
- **Manual Endpoints**: [List any undocumented endpoints discovered]
|
|
@@ -1633,12 +1335,14 @@ Instead of duplicating, reference actual model files:
|
|
|
1633
1335
|
## Technical Debt and Known Issues
|
|
1634
1336
|
|
|
1635
1337
|
### Critical Technical Debt
|
|
1338
|
+
|
|
1636
1339
|
1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
|
|
1637
1340
|
2. **User Service**: Different pattern than other services, uses callbacks instead of promises
|
|
1638
1341
|
3. **Database Migrations**: Manually tracked, no proper migration tool
|
|
1639
1342
|
4. **[Other significant debt]**
|
|
1640
1343
|
|
|
1641
1344
|
### Workarounds and Gotchas
|
|
1345
|
+
|
|
1642
1346
|
- **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
|
|
1643
1347
|
- **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
|
|
1644
1348
|
- **[Other workarounds developers need to know]**
|
|
@@ -1646,13 +1350,16 @@ Instead of duplicating, reference actual model files:
|
|
|
1646
1350
|
## Integration Points and External Dependencies
|
|
1647
1351
|
|
|
1648
1352
|
### External Services
|
|
1353
|
+
|
|
1649
1354
|
| Service | Purpose | Integration Type | Key Files |
|
|
1650
1355
|
|---------|---------|------------------|-----------|
|
|
1651
1356
|
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
|
1652
1357
|
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
|
1653
|
-
|
|
1358
|
+
|
|
1359
|
+
etc...
|
|
1654
1360
|
|
|
1655
1361
|
### Internal Integration Points
|
|
1362
|
+
|
|
1656
1363
|
- **Frontend Communication**: REST API on port 3000, expects specific headers
|
|
1657
1364
|
- **Background Jobs**: Redis queue, see `src/workers/`
|
|
1658
1365
|
- **[Other integrations]**
|
|
@@ -1660,11 +1367,13 @@ Instead of duplicating, reference actual model files:
|
|
|
1660
1367
|
## Development and Deployment
|
|
1661
1368
|
|
|
1662
1369
|
### Local Development Setup
|
|
1370
|
+
|
|
1663
1371
|
1. Actual steps that work (not ideal steps)
|
|
1664
1372
|
2. Known issues with setup
|
|
1665
1373
|
3. Required environment variables (see `.env.example`)
|
|
1666
1374
|
|
|
1667
1375
|
### Build and Deployment Process
|
|
1376
|
+
|
|
1668
1377
|
- **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
|
|
1669
1378
|
- **Deployment**: Manual deployment via `scripts/deploy.sh`
|
|
1670
1379
|
- **Environments**: Dev, Staging, Prod (see `config/environments/`)
|
|
@@ -1672,12 +1381,14 @@ Instead of duplicating, reference actual model files:
|
|
|
1672
1381
|
## Testing Reality
|
|
1673
1382
|
|
|
1674
1383
|
### Current Test Coverage
|
|
1384
|
+
|
|
1675
1385
|
- Unit Tests: 60% coverage (Jest)
|
|
1676
1386
|
- Integration Tests: Minimal, in `tests/integration/`
|
|
1677
1387
|
- E2E Tests: None
|
|
1678
1388
|
- Manual Testing: Primary QA method
|
|
1679
1389
|
|
|
1680
1390
|
### Running Tests
|
|
1391
|
+
|
|
1681
1392
|
```bash
|
|
1682
1393
|
npm test # Runs unit tests
|
|
1683
1394
|
npm run test:integration # Runs integration tests (requires local DB)
|
|
@@ -1686,6 +1397,7 @@ npm run test:integration # Runs integration tests (requires local DB)
|
|
|
1686
1397
|
## If Enhancement PRD Provided - Impact Analysis
|
|
1687
1398
|
|
|
1688
1399
|
### Files That Will Need Modification
|
|
1400
|
+
|
|
1689
1401
|
Based on the enhancement requirements, these files will be affected:
|
|
1690
1402
|
- `src/services/userService.js` - Add new user fields
|
|
1691
1403
|
- `src/models/User.js` - Update schema
|
|
@@ -1693,11 +1405,13 @@ Based on the enhancement requirements, these files will be affected:
|
|
|
1693
1405
|
- [etc...]
|
|
1694
1406
|
|
|
1695
1407
|
### New Files/Modules Needed
|
|
1408
|
+
|
|
1696
1409
|
- `src/services/newFeatureService.js` - New business logic
|
|
1697
1410
|
- `src/models/NewFeature.js` - New data model
|
|
1698
1411
|
- [etc...]
|
|
1699
1412
|
|
|
1700
1413
|
### Integration Considerations
|
|
1414
|
+
|
|
1701
1415
|
- Will need to integrate with existing auth middleware
|
|
1702
1416
|
- Must follow existing response format in `src/utils/responseFormatter.js`
|
|
1703
1417
|
- [Other integration points]
|
|
@@ -1705,6 +1419,7 @@ Based on the enhancement requirements, these files will be affected:
|
|
|
1705
1419
|
## Appendix - Useful Commands and Scripts
|
|
1706
1420
|
|
|
1707
1421
|
### Frequently Used Commands
|
|
1422
|
+
|
|
1708
1423
|
```bash
|
|
1709
1424
|
npm run dev # Start development server
|
|
1710
1425
|
npm run build # Production build
|
|
@@ -1713,14 +1428,13 @@ npm run seed # Seed test data
|
|
|
1713
1428
|
```
|
|
1714
1429
|
|
|
1715
1430
|
### Debugging and Troubleshooting
|
|
1431
|
+
|
|
1716
1432
|
- **Logs**: Check `logs/app.log` for application logs
|
|
1717
1433
|
- **Debug Mode**: Set `DEBUG=app:*` for verbose logging
|
|
1718
1434
|
- **Common Issues**: See `docs/troubleshooting.md`]]
|
|
1719
1435
|
|
|
1720
1436
|
### 4. Document Delivery
|
|
1721
1437
|
|
|
1722
|
-
[[LLM: After generating the complete architecture document:
|
|
1723
|
-
|
|
1724
1438
|
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
|
1725
1439
|
- Present the entire document in one response (or multiple if too long)
|
|
1726
1440
|
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
|
@@ -1732,6 +1446,7 @@ npm run seed # Seed test data
|
|
|
1732
1446
|
- Can be sharded later using PO agent if desired
|
|
1733
1447
|
|
|
1734
1448
|
The document should be comprehensive enough that future agents can understand:
|
|
1449
|
+
|
|
1735
1450
|
- The actual state of the system (not idealized)
|
|
1736
1451
|
- Where to find key files and logic
|
|
1737
1452
|
- What technical debt exists
|
|
@@ -1740,7 +1455,7 @@ The document should be comprehensive enough that future agents can understand:
|
|
|
1740
1455
|
|
|
1741
1456
|
### 5. Quality Assurance
|
|
1742
1457
|
|
|
1743
|
-
|
|
1458
|
+
CRITICAL: Before finalizing the document:
|
|
1744
1459
|
|
|
1745
1460
|
1. **Accuracy Check**: Verify all technical details match the actual codebase
|
|
1746
1461
|
2. **Completeness Review**: Ensure all major system components are documented
|
|
@@ -1748,7 +1463,7 @@ The document should be comprehensive enough that future agents can understand:
|
|
|
1748
1463
|
4. **Clarity Assessment**: Check that explanations are clear for AI agents
|
|
1749
1464
|
5. **Navigation**: Ensure document has clear section structure for easy reference
|
|
1750
1465
|
|
|
1751
|
-
Apply the advanced elicitation task after major sections to refine based on user feedback.
|
|
1466
|
+
Apply the advanced elicitation task after major sections to refine based on user feedback.
|
|
1752
1467
|
|
|
1753
1468
|
## Success Criteria
|
|
1754
1469
|
|
|
@@ -1874,15 +1589,14 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
|
1874
1589
|
- Verify all source references are included for technical details
|
|
1875
1590
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
1876
1591
|
- Update status to "Draft" and save the story file
|
|
1877
|
-
-
|
|
1878
|
-
- Execute `tasks/execute-checklist` `checklists/story-draft-checklist`
|
|
1592
|
+
- Execute `.bmad-core/tasks/execute-checklist` `.bmad-core/checklists/story-draft-checklist`
|
|
1879
1593
|
- Provide summary to user including:
|
|
1880
1594
|
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
1881
1595
|
- Status: Draft
|
|
1882
1596
|
- Key technical components included from architecture docs
|
|
1883
1597
|
- Any deviations or conflicts noted between epic and architecture
|
|
1884
1598
|
- Checklist Results
|
|
1885
|
-
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task
|
|
1599
|
+
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `.bmad-core/tasks/validate-next-story`
|
|
1886
1600
|
==================== END: .bmad-core/tasks/create-next-story.md ====================
|
|
1887
1601
|
|
|
1888
1602
|
==================== START: .bmad-core/tasks/execute-checklist.md ====================
|
|
@@ -1990,7 +1704,7 @@ To generate a masterful, comprehensive, and optimized prompt that can be used wi
|
|
|
1990
1704
|
|
|
1991
1705
|
## Inputs
|
|
1992
1706
|
|
|
1993
|
-
- Completed UI/UX Specification (`front-end-spec`)
|
|
1707
|
+
- Completed UI/UX Specification (`front-end-spec.md`)
|
|
1994
1708
|
- Completed Frontend Architecture Document (`front-end-architecture`) or a full stack combined architecture such as `architecture.md`
|
|
1995
1709
|
- Main System Architecture Document (`architecture` - for API contracts and tech stack to give further context)
|
|
1996
1710
|
|
|
@@ -2228,20 +1942,20 @@ Would you like to proceed with documentation indexing? Please provide the requir
|
|
|
2228
1942
|
|
|
2229
1943
|
## Primary Method: Automatic with markdown-tree
|
|
2230
1944
|
|
|
2231
|
-
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
1945
|
+
[[LLM: First, check if markdownExploder is set to true in .bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
2232
1946
|
|
|
2233
1947
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
2234
1948
|
|
|
2235
1949
|
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
|
2236
1950
|
|
|
2237
1951
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
2238
|
-
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
1952
|
+
2. Or set markdownExploder to false in .bmad-core/core-config.yaml
|
|
2239
1953
|
|
|
2240
1954
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
2241
1955
|
|
|
2242
1956
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
2243
1957
|
|
|
2244
|
-
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
1958
|
+
1. Set markdownExploder to true in .bmad-core/core-config.yaml
|
|
2245
1959
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
2246
1960
|
|
|
2247
1961
|
I will now proceed with the manual sharding process."
|
|
@@ -2281,8 +1995,6 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
2281
1995
|
|
|
2282
1996
|
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
|
2283
1997
|
|
|
2284
|
-
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
|
2285
|
-
|
|
2286
1998
|
### Task Instructions
|
|
2287
1999
|
|
|
2288
2000
|
1. Identify Document and Target Location
|
|
@@ -2293,7 +2005,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
2293
2005
|
|
|
2294
2006
|
2. Parse and Extract Sections
|
|
2295
2007
|
|
|
2296
|
-
|
|
2008
|
+
CRITICAL AEGNT SHARDING RULES:
|
|
2297
2009
|
|
|
2298
2010
|
1. Read the entire document content
|
|
2299
2011
|
2. Identify all level 2 sections (## headings)
|
|
@@ -2354,8 +2066,6 @@ Create an `index.md` file in the sharded folder that:
|
|
|
2354
2066
|
|
|
2355
2067
|
### 5. Preserve Special Content
|
|
2356
2068
|
|
|
2357
|
-
[[LLM: Pay special attention to preserving:
|
|
2358
|
-
|
|
2359
2069
|
1. **Code blocks**: Must capture complete blocks including:
|
|
2360
2070
|
|
|
2361
2071
|
```language
|
|
@@ -2377,7 +2087,7 @@ Create an `index.md` file in the sharded folder that:
|
|
|
2377
2087
|
|
|
2378
2088
|
6. **Links and references**: Keep all markdown links intact
|
|
2379
2089
|
|
|
2380
|
-
7. **Template markup**: If documents contain {{placeholders}}
|
|
2090
|
+
7. **Template markup**: If documents contain {{placeholders}} ,preserve exactly
|
|
2381
2091
|
|
|
2382
2092
|
### 6. Validation
|
|
2383
2093
|
|
|
@@ -2411,257 +2121,6 @@ Document sharded successfully:
|
|
|
2411
2121
|
- Ensure the sharding is reversible (could reconstruct the original from shards)
|
|
2412
2122
|
==================== END: .bmad-core/tasks/shard-doc.md ====================
|
|
2413
2123
|
|
|
2414
|
-
==================== START: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
2415
|
-
# Update Workflow Plan Task
|
|
2416
|
-
|
|
2417
|
-
## Purpose
|
|
2418
|
-
|
|
2419
|
-
Update the status of steps in an active workflow plan, mark completions, add notes about deviations, and maintain an accurate record of workflow progress. This task can be called directly by users or automatically by other tasks upon completion.
|
|
2420
|
-
|
|
2421
|
-
## Task Instructions
|
|
2422
|
-
|
|
2423
|
-
### 0. Load Plan Configuration
|
|
2424
|
-
|
|
2425
|
-
[[LLM: First load core-config.yaml to get plan settings]]
|
|
2426
|
-
|
|
2427
|
-
Check workflow configuration:
|
|
2428
|
-
|
|
2429
|
-
- `workflow.planFile` - Location of the plan (default: docs/workflow-plan.md)
|
|
2430
|
-
- `workflow.trackProgress` - Whether tracking is enabled
|
|
2431
|
-
- `workflow.updateOnCompletion` - Whether to auto-update on task completion
|
|
2432
|
-
|
|
2433
|
-
If tracking is disabled, inform user and exit.
|
|
2434
|
-
|
|
2435
|
-
### 1. Verify Plan Exists
|
|
2436
|
-
|
|
2437
|
-
[[LLM: Check if workflow plan exists at configured location]]
|
|
2438
|
-
|
|
2439
|
-
If no plan exists:
|
|
2440
|
-
|
|
2441
|
-
```
|
|
2442
|
-
No active workflow plan found at {location}.
|
|
2443
|
-
Would you like to create one? Use *plan command.
|
|
2444
|
-
```
|
|
2445
|
-
|
|
2446
|
-
### 2. Determine Update Type
|
|
2447
|
-
|
|
2448
|
-
[[LLM: Ask user what type of update they want to make]]
|
|
2449
|
-
|
|
2450
|
-
Present options:
|
|
2451
|
-
|
|
2452
|
-
```
|
|
2453
|
-
What would you like to update in the workflow plan?
|
|
2454
|
-
|
|
2455
|
-
1. Mark step as complete
|
|
2456
|
-
2. Update current step
|
|
2457
|
-
3. Add deviation note
|
|
2458
|
-
4. Mark decision point resolution
|
|
2459
|
-
5. Update overall status
|
|
2460
|
-
6. View current plan status only
|
|
2461
|
-
|
|
2462
|
-
Please select an option (1-6):
|
|
2463
|
-
```
|
|
2464
|
-
|
|
2465
|
-
### 3. Parse Current Plan
|
|
2466
|
-
|
|
2467
|
-
[[LLM: Read and parse the plan to understand current state]]
|
|
2468
|
-
|
|
2469
|
-
Extract:
|
|
2470
|
-
|
|
2471
|
-
- All steps with their checkbox status
|
|
2472
|
-
- Step IDs from comments (if present)
|
|
2473
|
-
- Current completion percentage
|
|
2474
|
-
- Any existing deviation notes
|
|
2475
|
-
- Decision points and their status
|
|
2476
|
-
|
|
2477
|
-
### 4. Execute Updates
|
|
2478
|
-
|
|
2479
|
-
#### 4.1 Mark Step Complete
|
|
2480
|
-
|
|
2481
|
-
If user selected option 1:
|
|
2482
|
-
|
|
2483
|
-
1. Show numbered list of incomplete steps
|
|
2484
|
-
2. Ask which step to mark complete
|
|
2485
|
-
3. Update the checkbox from `[ ]` to `[x]`
|
|
2486
|
-
4. Add completion timestamp: `<!-- completed: YYYY-MM-DD HH:MM -->`
|
|
2487
|
-
5. If this was the current step, identify next step
|
|
2488
|
-
|
|
2489
|
-
#### 4.2 Update Current Step
|
|
2490
|
-
|
|
2491
|
-
If user selected option 2:
|
|
2492
|
-
|
|
2493
|
-
1. Show all steps with current status
|
|
2494
|
-
2. Ask which step is now current
|
|
2495
|
-
3. Add/move `<!-- current-step -->` marker
|
|
2496
|
-
4. Optionally add note about why sequence changed
|
|
2497
|
-
|
|
2498
|
-
#### 4.3 Add Deviation Note
|
|
2499
|
-
|
|
2500
|
-
If user selected option 3:
|
|
2501
|
-
|
|
2502
|
-
1. Ask for deviation description
|
|
2503
|
-
2. Ask which step this relates to (or general)
|
|
2504
|
-
3. Insert note in appropriate location:
|
|
2505
|
-
|
|
2506
|
-
```markdown
|
|
2507
|
-
> **Deviation Note** (YYYY-MM-DD): {user_note}
|
|
2508
|
-
> Related to: Step X.Y or General workflow
|
|
2509
|
-
```
|
|
2510
|
-
|
|
2511
|
-
#### 4.4 Mark Decision Resolution
|
|
2512
|
-
|
|
2513
|
-
If user selected option 4:
|
|
2514
|
-
|
|
2515
|
-
1. Show pending decision points
|
|
2516
|
-
2. Ask which decision was made
|
|
2517
|
-
3. Record the decision and chosen path
|
|
2518
|
-
4. Update related steps based on decision
|
|
2519
|
-
|
|
2520
|
-
#### 4.5 Update Overall Status
|
|
2521
|
-
|
|
2522
|
-
If user selected option 5:
|
|
2523
|
-
|
|
2524
|
-
1. Show current overall status
|
|
2525
|
-
2. Provide options:
|
|
2526
|
-
- Active (continuing with plan)
|
|
2527
|
-
- Paused (temporarily stopped)
|
|
2528
|
-
- Abandoned (no longer following)
|
|
2529
|
-
- Complete (all steps done)
|
|
2530
|
-
3. Update plan header with new status
|
|
2531
|
-
|
|
2532
|
-
### 5. Automatic Updates (When Called by Tasks)
|
|
2533
|
-
|
|
2534
|
-
[[LLM: When called automatically by another task]]
|
|
2535
|
-
|
|
2536
|
-
If called with parameters:
|
|
2537
|
-
|
|
2538
|
-
```
|
|
2539
|
-
task: {task_name}
|
|
2540
|
-
step_id: {step_identifier}
|
|
2541
|
-
status: complete|skipped|failed
|
|
2542
|
-
note: {optional_note}
|
|
2543
|
-
```
|
|
2544
|
-
|
|
2545
|
-
Automatically:
|
|
2546
|
-
|
|
2547
|
-
1. Find the corresponding step
|
|
2548
|
-
2. Update its status
|
|
2549
|
-
3. Add completion metadata
|
|
2550
|
-
4. Add note if provided
|
|
2551
|
-
5. Calculate new progress percentage
|
|
2552
|
-
|
|
2553
|
-
### 6. Generate Update Summary
|
|
2554
|
-
|
|
2555
|
-
After updates, show summary:
|
|
2556
|
-
|
|
2557
|
-
```
|
|
2558
|
-
✅ Workflow Plan Updated
|
|
2559
|
-
|
|
2560
|
-
Changes made:
|
|
2561
|
-
- {change_1}
|
|
2562
|
-
- {change_2}
|
|
2563
|
-
|
|
2564
|
-
New Status:
|
|
2565
|
-
- Progress: {X}% complete ({completed}/{total} steps)
|
|
2566
|
-
- Current Step: {current_step}
|
|
2567
|
-
- Next Recommended: {next_step}
|
|
2568
|
-
|
|
2569
|
-
Plan location: {file_path}
|
|
2570
|
-
```
|
|
2571
|
-
|
|
2572
|
-
### 7. Integration with Other Tasks
|
|
2573
|
-
|
|
2574
|
-
[[LLM: How other tasks should call this]]
|
|
2575
|
-
|
|
2576
|
-
Other tasks can integrate by:
|
|
2577
|
-
|
|
2578
|
-
1. **After Task Completion**:
|
|
2579
|
-
|
|
2580
|
-
```
|
|
2581
|
-
At end of task execution:
|
|
2582
|
-
- Check if task corresponds to a plan step
|
|
2583
|
-
- If yes, call update-workflow-plan with:
|
|
2584
|
-
- task: {current_task_name}
|
|
2585
|
-
- step_id: {matching_step}
|
|
2586
|
-
- status: complete
|
|
2587
|
-
```
|
|
2588
|
-
|
|
2589
|
-
2. **On Task Failure**:
|
|
2590
|
-
|
|
2591
|
-
```
|
|
2592
|
-
If task fails:
|
|
2593
|
-
- Call update-workflow-plan with:
|
|
2594
|
-
- task: {current_task_name}
|
|
2595
|
-
- status: failed
|
|
2596
|
-
- note: {failure_reason}
|
|
2597
|
-
```
|
|
2598
|
-
|
|
2599
|
-
### 8. Plan Status Display
|
|
2600
|
-
|
|
2601
|
-
[[LLM: When user selects view status only]]
|
|
2602
|
-
|
|
2603
|
-
Display comprehensive status:
|
|
2604
|
-
|
|
2605
|
-
```markdown
|
|
2606
|
-
📋 Workflow Plan Status
|
|
2607
|
-
━━━━━━━━━━━━━━━━━━━━
|
|
2608
|
-
Workflow: {workflow_name}
|
|
2609
|
-
Status: {Active|Paused|Complete}
|
|
2610
|
-
Progress: {X}% complete ({completed}/{total} steps)
|
|
2611
|
-
Last Updated: {timestamp}
|
|
2612
|
-
|
|
2613
|
-
✅ Completed Steps:
|
|
2614
|
-
- [x] Step 1.1: {description} (completed: {date})
|
|
2615
|
-
- [x] Step 1.2: {description} (completed: {date})
|
|
2616
|
-
|
|
2617
|
-
🔄 Current Step:
|
|
2618
|
-
- [ ] Step 2.1: {description} <!-- current-step -->
|
|
2619
|
-
Agent: {agent_name}
|
|
2620
|
-
Task: {task_name}
|
|
2621
|
-
|
|
2622
|
-
📌 Upcoming Steps:
|
|
2623
|
-
- [ ] Step 2.2: {description}
|
|
2624
|
-
- [ ] Step 3.1: {description}
|
|
2625
|
-
|
|
2626
|
-
⚠️ Deviations/Notes:
|
|
2627
|
-
{any_deviation_notes}
|
|
2628
|
-
|
|
2629
|
-
📊 Decision Points:
|
|
2630
|
-
- Decision 1: {status} - {choice_made}
|
|
2631
|
-
- Decision 2: Pending
|
|
2632
|
-
|
|
2633
|
-
💡 Next Action:
|
|
2634
|
-
Based on the plan, you should {recommended_action}
|
|
2635
|
-
```
|
|
2636
|
-
|
|
2637
|
-
## Success Criteria
|
|
2638
|
-
|
|
2639
|
-
The update is successful when:
|
|
2640
|
-
|
|
2641
|
-
1. Plan accurately reflects current workflow state
|
|
2642
|
-
2. All updates are clearly timestamped
|
|
2643
|
-
3. Deviations are documented with reasons
|
|
2644
|
-
4. Progress calculation is correct
|
|
2645
|
-
5. Next steps are clear to user
|
|
2646
|
-
6. Plan remains readable and well-formatted
|
|
2647
|
-
|
|
2648
|
-
## Error Handling
|
|
2649
|
-
|
|
2650
|
-
- **Plan file not found**: Offer to create new plan
|
|
2651
|
-
- **Malformed plan**: Attempt basic updates, warn user
|
|
2652
|
-
- **Write permission error**: Show changes that would be made
|
|
2653
|
-
- **Step not found**: Show available steps, ask for clarification
|
|
2654
|
-
- **Concurrent updates**: Implement simple locking or warn about conflicts
|
|
2655
|
-
|
|
2656
|
-
## Notes
|
|
2657
|
-
|
|
2658
|
-
- Always preserve plan history (don't delete old information)
|
|
2659
|
-
- Keep updates atomic to prevent corruption
|
|
2660
|
-
- Consider creating backup before major updates
|
|
2661
|
-
- Updates should enhance, not complicate, the workflow experience
|
|
2662
|
-
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
|
2663
|
-
==================== END: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
2664
|
-
|
|
2665
2124
|
==================== START: .bmad-core/templates/architecture-tmpl.yaml ====================
|
|
2666
2125
|
template:
|
|
2667
2126
|
id: architecture-template-v2
|