bmad-method 4.10.2 → 4.11.0

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.
@@ -109,14 +109,14 @@ To identify the next logical story based on project progress and epic definition
109
109
  2. Run the BMAD installer against your project to upgrade and add the file automatically
110
110
  Please add and configure core-config.yml before proceeding."
111
111
  - Extract the following key configurations:
112
- - `dev-story-location`: Where to save story files
112
+ - `devStoryLocation`: Where to save story files
113
113
  - `prd.prdSharded`: Whether PRD is sharded or monolithic
114
- - `prd.prd-file`: Location of monolithic PRD (if not sharded)
114
+ - `prd.prdFile`: Location of monolithic PRD (if not sharded)
115
115
  - `prd.prdShardedLocation`: Location of sharded epic files
116
116
  - `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
117
117
  - `architecture.architectureVersion`: Architecture document version
118
118
  - `architecture.architectureSharded`: Whether architecture is sharded
119
- - `architecture.architecture-file`: Location of monolithic architecture
119
+ - `architecture.architectureFile`: Location of monolithic architecture
120
120
  - `architecture.architectureShardedLocation`: Location of sharded architecture files
121
121
 
122
122
  ### 1. Identify Next Story for Preparation
@@ -125,11 +125,11 @@ To identify the next logical story based on project progress and epic definition
125
125
 
126
126
  - Based on `prdSharded` from config:
127
127
  - **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
128
- - **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
128
+ - **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
129
129
 
130
130
  #### 1.2 Review Existing Stories
131
131
 
132
- - Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
132
+ - Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
133
133
  - If the directory exists and has at least 1 file, find the highest-numbered story file.
134
134
  - **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
135
135
  - Verify its `Status` is 'Done' (or equivalent).
@@ -149,12 +149,40 @@ To identify the next logical story based on project progress and epic definition
149
149
  ```
150
150
 
151
151
  - Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
152
- - If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
153
- - Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
152
+ - If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and parse it to find ALL stories in that epic. **ALWAYS select the next sequential story** (e.g., if last was 2.2, next MUST be 2.3).
153
+ - If the next sequential story has unmet prerequisites, present this to the user:
154
+
155
+ ```plaintext
156
+ ALERT: Next story has unmet prerequisites:
157
+ Story: {epicNum}.{storyNum} - {Story Title}
158
+ Prerequisites not met: [list specific prerequisites]
159
+
160
+ Would you like to:
161
+ 1. Create the story anyway (mark prerequisites as pending)
162
+ 2. Skip to a different story (requires your specific instruction)
163
+ 3. Cancel story creation
164
+
165
+ Please choose an option (1/2/3):
166
+ ```
167
+
168
+ - If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
169
+
170
+ ```plaintext
171
+ Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
172
+
173
+ Would you like to:
174
+ 1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
175
+ 2. Select a specific story to work on
176
+ 3. Cancel story creation
177
+
178
+ Please choose an option (1/2/3):
179
+ ```
180
+
181
+ - **CRITICAL**: NEVER automatically skip to another epic or non-sequential story. The user MUST explicitly instruct which story to create if skipping the sequential order.
154
182
 
155
183
  - **If no story files exist in `docs/stories/`:**
156
- - The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
157
- - If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
184
+ - The next story is ALWAYS 1.1 (the first story of the first epic).
185
+ - If story 1.1 has unmet prerequisites, follow the same alert process as above.
158
186
  - Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
159
187
 
160
188
  ### 2. Gather Core Story Requirements (from Epic)
@@ -190,13 +218,13 @@ Based on configuration loaded in Step 0:
190
218
  - Follow the structured reading order in section 4.2 below
191
219
 
192
220
  - **If `architectureVersion: v4` and `architectureSharded: false`**:
193
- - Load the monolithic architecture from `architecture-file`
221
+ - Load the monolithic architecture from `architectureFile`
194
222
  - Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
195
223
 
196
224
  - **If `architectureVersion` is NOT v4**:
197
225
  - Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
198
226
  - If `architectureSharded: true`: Search sharded files by filename relevance
199
- - If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
227
+ - If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
200
228
 
201
229
  #### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
202
230
 
@@ -253,7 +281,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
253
281
 
254
282
  ### 6. Populate Story Template with Full Context
255
283
 
256
- - Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
284
+ - Create a new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config).
257
285
  - Use the Story Template to structure the file.
258
286
  - Fill in:
259
287
  - Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -300,7 +328,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
300
328
  - Verify all source references are included for technical details
301
329
  - Ensure tasks align with both epic requirements and architecture constraints
302
330
  - Update status to "Draft"
303
- - Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
331
+ - Save the story file to `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config)
304
332
 
305
333
  ### 9. Report Completion
306
334
 
@@ -214,6 +214,11 @@ loading:
214
214
  - Agents: Only when transforming
215
215
  - Templates/Tasks: Only when executing
216
216
  - Always indicate loading
217
+ kb-mode-behavior:
218
+ - When *kb-mode is invoked, use kb-mode-interaction task
219
+ - Don't dump all KB content immediately
220
+ - Present topic areas and wait for user selection
221
+ - Provide focused, contextual responses
217
222
  workflow-guidance:
218
223
  - Discover available workflows in the bundle at runtime
219
224
  - Understand each workflow's purpose, options, and decision points
@@ -227,6 +232,7 @@ dependencies:
227
232
  tasks:
228
233
  - advanced-elicitation
229
234
  - create-doc
235
+ - kb-mode-interaction
230
236
  data:
231
237
  - bmad-kb
232
238
  utils:
@@ -2234,6 +2240,79 @@ Templates in the BMAD method use standardized markup for AI processing. These co
2234
2240
  - All template-specific instructions are embedded within templates
2235
2241
  ==================== END: utils#template-format ====================
2236
2242
 
2243
+ ==================== START: tasks#kb-mode-interaction ====================
2244
+ # KB Mode Interaction Task
2245
+
2246
+ ## Purpose
2247
+ Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
2248
+
2249
+ ## Instructions
2250
+
2251
+ When entering KB mode (*kb-mode), follow these steps:
2252
+
2253
+ ### 1. Welcome and Guide
2254
+ Announce entering KB mode with a brief, friendly introduction:
2255
+
2256
+ "I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
2257
+
2258
+ ### 2. Present Topic Areas
2259
+ Offer a concise list of main topic areas the user might want to explore:
2260
+
2261
+ **What would you like to know more about?**
2262
+
2263
+ 1. **Setup & Installation** - Getting started with BMAD
2264
+ 2. **Workflows** - Choosing the right workflow for your project
2265
+ 3. **Web vs IDE** - When to use each environment
2266
+ 4. **Agents** - Understanding specialized agents and their roles
2267
+ 5. **Documents** - PRDs, Architecture, Stories, and more
2268
+ 6. **Agile Process** - How BMAD implements Agile methodologies
2269
+ 7. **Configuration** - Customizing BMAD for your needs
2270
+ 8. **Best Practices** - Tips for effective BMAD usage
2271
+
2272
+ Or ask me about anything else related to BMAD-METHOD!
2273
+
2274
+ ### 3. Respond Contextually
2275
+ - Wait for user's specific question or topic selection
2276
+ - Provide focused, relevant information from the knowledge base
2277
+ - Offer to dive deeper or explore related topics
2278
+ - Keep responses concise unless user asks for detailed explanations
2279
+
2280
+ ### 4. Interactive Exploration
2281
+ - After answering, suggest related topics they might find helpful
2282
+ - Maintain conversational flow rather than data dumping
2283
+ - Use examples when appropriate
2284
+ - Reference specific documentation sections when relevant
2285
+
2286
+ ### 5. Exit Gracefully
2287
+ When user is done or wants to exit KB mode:
2288
+ - Summarize key points discussed if helpful
2289
+ - Remind them they can return to KB mode anytime with *kb-mode
2290
+ - Suggest next steps based on what was discussed
2291
+
2292
+ ## Example Interaction
2293
+
2294
+ **User**: *kb-mode
2295
+
2296
+ **Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
2297
+
2298
+ **What would you like to know more about?**
2299
+
2300
+ 1. **Setup & Installation** - Getting started with BMAD
2301
+ 2. **Workflows** - Choosing the right workflow for your project
2302
+ 3. **Web vs IDE** - When to use each environment
2303
+ 4. **Agents** - Understanding specialized agents and their roles
2304
+ 5. **Documents** - PRDs, Architecture, Stories, and more
2305
+ 6. **Agile Process** - How BMAD implements Agile methodologies
2306
+ 7. **Configuration** - Customizing BMAD for your needs
2307
+ 8. **Best Practices** - Tips for effective BMAD usage
2308
+
2309
+ Or ask me about anything else related to BMAD-METHOD!
2310
+
2311
+ **User**: Tell me about workflows
2312
+
2313
+ **Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
2314
+ ==================== END: tasks#kb-mode-interaction ====================
2315
+
2237
2316
  ==================== START: utils#workflow-management ====================
2238
2317
  # Workflow Management
2239
2318
 
@@ -153,6 +153,11 @@ loading:
153
153
  - Agents: Only when transforming
154
154
  - Templates/Tasks: Only when executing
155
155
  - Always indicate loading
156
+ kb-mode-behavior:
157
+ - When *kb-mode is invoked, use kb-mode-interaction task
158
+ - Don't dump all KB content immediately
159
+ - Present topic areas and wait for user selection
160
+ - Provide focused, contextual responses
156
161
  workflow-guidance:
157
162
  - Discover available workflows in the bundle at runtime
158
163
  - Understand each workflow's purpose, options, and decision points
@@ -166,6 +171,7 @@ dependencies:
166
171
  tasks:
167
172
  - advanced-elicitation
168
173
  - create-doc
174
+ - kb-mode-interaction
169
175
  data:
170
176
  - bmad-kb
171
177
  utils:
@@ -816,6 +822,79 @@ If template specifies a checklist:
816
822
  - Template markup is for AI processing only - never expose to users
817
823
  ==================== END: tasks#create-doc ====================
818
824
 
825
+ ==================== START: tasks#kb-mode-interaction ====================
826
+ # KB Mode Interaction Task
827
+
828
+ ## Purpose
829
+ Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
830
+
831
+ ## Instructions
832
+
833
+ When entering KB mode (*kb-mode), follow these steps:
834
+
835
+ ### 1. Welcome and Guide
836
+ Announce entering KB mode with a brief, friendly introduction:
837
+
838
+ "I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
839
+
840
+ ### 2. Present Topic Areas
841
+ Offer a concise list of main topic areas the user might want to explore:
842
+
843
+ **What would you like to know more about?**
844
+
845
+ 1. **Setup & Installation** - Getting started with BMAD
846
+ 2. **Workflows** - Choosing the right workflow for your project
847
+ 3. **Web vs IDE** - When to use each environment
848
+ 4. **Agents** - Understanding specialized agents and their roles
849
+ 5. **Documents** - PRDs, Architecture, Stories, and more
850
+ 6. **Agile Process** - How BMAD implements Agile methodologies
851
+ 7. **Configuration** - Customizing BMAD for your needs
852
+ 8. **Best Practices** - Tips for effective BMAD usage
853
+
854
+ Or ask me about anything else related to BMAD-METHOD!
855
+
856
+ ### 3. Respond Contextually
857
+ - Wait for user's specific question or topic selection
858
+ - Provide focused, relevant information from the knowledge base
859
+ - Offer to dive deeper or explore related topics
860
+ - Keep responses concise unless user asks for detailed explanations
861
+
862
+ ### 4. Interactive Exploration
863
+ - After answering, suggest related topics they might find helpful
864
+ - Maintain conversational flow rather than data dumping
865
+ - Use examples when appropriate
866
+ - Reference specific documentation sections when relevant
867
+
868
+ ### 5. Exit Gracefully
869
+ When user is done or wants to exit KB mode:
870
+ - Summarize key points discussed if helpful
871
+ - Remind them they can return to KB mode anytime with *kb-mode
872
+ - Suggest next steps based on what was discussed
873
+
874
+ ## Example Interaction
875
+
876
+ **User**: *kb-mode
877
+
878
+ **Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
879
+
880
+ **What would you like to know more about?**
881
+
882
+ 1. **Setup & Installation** - Getting started with BMAD
883
+ 2. **Workflows** - Choosing the right workflow for your project
884
+ 3. **Web vs IDE** - When to use each environment
885
+ 4. **Agents** - Understanding specialized agents and their roles
886
+ 5. **Documents** - PRDs, Architecture, Stories, and more
887
+ 6. **Agile Process** - How BMAD implements Agile methodologies
888
+ 7. **Configuration** - Customizing BMAD for your needs
889
+ 8. **Best Practices** - Tips for effective BMAD usage
890
+
891
+ Or ask me about anything else related to BMAD-METHOD!
892
+
893
+ **User**: Tell me about workflows
894
+
895
+ **Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
896
+ ==================== END: tasks#kb-mode-interaction ====================
897
+
819
898
  ==================== START: data#bmad-kb ====================
820
899
  # BMAD Knowledge Base
821
900
 
@@ -885,6 +964,64 @@ npx bmad-method install
885
964
 
886
965
  **Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
887
966
 
967
+ ## Core Configuration (core-config.yml)
968
+
969
+ **New in V4**: The `bmad-core/core-config.yml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
970
+
971
+ ### What is core-config.yml?
972
+
973
+ This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
974
+
975
+ - **Version Flexibility**: Work with V3, V4, or custom document structures
976
+ - **Custom Locations**: Define where your documents and shards live
977
+ - **Developer Context**: Specify which files the dev agent should always load
978
+ - **Debug Support**: Built-in logging for troubleshooting
979
+
980
+ ### Key Configuration Areas
981
+
982
+ #### PRD Configuration
983
+ - **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
984
+ - **prdSharded**: Whether epics are embedded (false) or in separate files (true)
985
+ - **prdShardedLocation**: Where to find sharded epic files
986
+ - **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
987
+
988
+ #### Architecture Configuration
989
+ - **architectureVersion**: v3 (monolithic) or v4 (sharded)
990
+ - **architectureSharded**: Whether architecture is split into components
991
+ - **architectureShardedLocation**: Where sharded architecture files live
992
+
993
+ #### Developer Files
994
+ - **devLoadAlwaysFiles**: List of files the dev agent loads for every task
995
+ - **devDebugLog**: Where dev agent logs repeated failures
996
+ - **agentCoreDump**: Export location for chat conversations
997
+
998
+ ### Why It Matters
999
+
1000
+ 1. **No Forced Migrations**: Keep your existing document structure
1001
+ 2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
1002
+ 3. **Custom Workflows**: Configure BMAD to match your team's process
1003
+ 4. **Intelligent Agents**: Agents automatically adapt to your configuration
1004
+
1005
+ ### Common Configurations
1006
+
1007
+ **Legacy V3 Project**:
1008
+ ```yaml
1009
+ prdVersion: v3
1010
+ prdSharded: false
1011
+ architectureVersion: v3
1012
+ architectureSharded: false
1013
+ ```
1014
+
1015
+ **V4 Optimized Project**:
1016
+ ```yaml
1017
+ prdVersion: v4
1018
+ prdSharded: true
1019
+ prdShardedLocation: docs/prd
1020
+ architectureVersion: v4
1021
+ architectureSharded: true
1022
+ architectureShardedLocation: docs/architecture
1023
+ ```
1024
+
888
1025
  ## Core Philosophy
889
1026
 
890
1027
  ### Vibe CEO'ing
@@ -8519,14 +8656,14 @@ To identify the next logical story based on project progress and epic definition
8519
8656
  2. Run the BMAD installer against your project to upgrade and add the file automatically
8520
8657
  Please add and configure core-config.yml before proceeding."
8521
8658
  - Extract the following key configurations:
8522
- - `dev-story-location`: Where to save story files
8659
+ - `devStoryLocation`: Where to save story files
8523
8660
  - `prd.prdSharded`: Whether PRD is sharded or monolithic
8524
- - `prd.prd-file`: Location of monolithic PRD (if not sharded)
8661
+ - `prd.prdFile`: Location of monolithic PRD (if not sharded)
8525
8662
  - `prd.prdShardedLocation`: Location of sharded epic files
8526
8663
  - `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
8527
8664
  - `architecture.architectureVersion`: Architecture document version
8528
8665
  - `architecture.architectureSharded`: Whether architecture is sharded
8529
- - `architecture.architecture-file`: Location of monolithic architecture
8666
+ - `architecture.architectureFile`: Location of monolithic architecture
8530
8667
  - `architecture.architectureShardedLocation`: Location of sharded architecture files
8531
8668
 
8532
8669
  ### 1. Identify Next Story for Preparation
@@ -8535,11 +8672,11 @@ To identify the next logical story based on project progress and epic definition
8535
8672
 
8536
8673
  - Based on `prdSharded` from config:
8537
8674
  - **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
8538
- - **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
8675
+ - **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
8539
8676
 
8540
8677
  #### 1.2 Review Existing Stories
8541
8678
 
8542
- - Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
8679
+ - Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
8543
8680
  - If the directory exists and has at least 1 file, find the highest-numbered story file.
8544
8681
  - **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
8545
8682
  - Verify its `Status` is 'Done' (or equivalent).
@@ -8559,12 +8696,40 @@ To identify the next logical story based on project progress and epic definition
8559
8696
  ```
8560
8697
 
8561
8698
  - Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
8562
- - If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
8563
- - Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
8699
+ - If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and parse it to find ALL stories in that epic. **ALWAYS select the next sequential story** (e.g., if last was 2.2, next MUST be 2.3).
8700
+ - If the next sequential story has unmet prerequisites, present this to the user:
8701
+
8702
+ ```plaintext
8703
+ ALERT: Next story has unmet prerequisites:
8704
+ Story: {epicNum}.{storyNum} - {Story Title}
8705
+ Prerequisites not met: [list specific prerequisites]
8706
+
8707
+ Would you like to:
8708
+ 1. Create the story anyway (mark prerequisites as pending)
8709
+ 2. Skip to a different story (requires your specific instruction)
8710
+ 3. Cancel story creation
8711
+
8712
+ Please choose an option (1/2/3):
8713
+ ```
8714
+
8715
+ - If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
8716
+
8717
+ ```plaintext
8718
+ Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
8719
+
8720
+ Would you like to:
8721
+ 1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
8722
+ 2. Select a specific story to work on
8723
+ 3. Cancel story creation
8724
+
8725
+ Please choose an option (1/2/3):
8726
+ ```
8727
+
8728
+ - **CRITICAL**: NEVER automatically skip to another epic or non-sequential story. The user MUST explicitly instruct which story to create if skipping the sequential order.
8564
8729
 
8565
8730
  - **If no story files exist in `docs/stories/`:**
8566
- - The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
8567
- - If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
8731
+ - The next story is ALWAYS 1.1 (the first story of the first epic).
8732
+ - If story 1.1 has unmet prerequisites, follow the same alert process as above.
8568
8733
  - Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
8569
8734
 
8570
8735
  ### 2. Gather Core Story Requirements (from Epic)
@@ -8600,13 +8765,13 @@ Based on configuration loaded in Step 0:
8600
8765
  - Follow the structured reading order in section 4.2 below
8601
8766
 
8602
8767
  - **If `architectureVersion: v4` and `architectureSharded: false`**:
8603
- - Load the monolithic architecture from `architecture-file`
8768
+ - Load the monolithic architecture from `architectureFile`
8604
8769
  - Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
8605
8770
 
8606
8771
  - **If `architectureVersion` is NOT v4**:
8607
8772
  - Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
8608
8773
  - If `architectureSharded: true`: Search sharded files by filename relevance
8609
- - If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
8774
+ - If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
8610
8775
 
8611
8776
  #### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
8612
8777
 
@@ -8663,7 +8828,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
8663
8828
 
8664
8829
  ### 6. Populate Story Template with Full Context
8665
8830
 
8666
- - Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
8831
+ - Create a new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config).
8667
8832
  - Use the Story Template to structure the file.
8668
8833
  - Fill in:
8669
8834
  - Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -8710,7 +8875,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
8710
8875
  - Verify all source references are included for technical details
8711
8876
  - Ensure tasks align with both epic requirements and architecture constraints
8712
8877
  - Update status to "Draft"
8713
- - Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
8878
+ - Save the story file to `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config)
8714
8879
 
8715
8880
  ### 9. Report Completion
8716
8881
 
@@ -9452,7 +9617,7 @@ workflow:
9452
9617
 
9453
9618
  sequence:
9454
9619
  - step: service_analysis
9455
- agent: architect
9620
+ agent: architect
9456
9621
  action: analyze existing project and use task document-project
9457
9622
  creates: multiple documents per the document-project template
9458
9623
  notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."
@@ -157,6 +157,11 @@ loading:
157
157
  - Agents: Only when transforming
158
158
  - Templates/Tasks: Only when executing
159
159
  - Always indicate loading
160
+ kb-mode-behavior:
161
+ - When *kb-mode is invoked, use kb-mode-interaction task
162
+ - Don't dump all KB content immediately
163
+ - Present topic areas and wait for user selection
164
+ - Provide focused, contextual responses
160
165
  workflow-guidance:
161
166
  - Discover available workflows in the bundle at runtime
162
167
  - Understand each workflow's purpose, options, and decision points
@@ -170,6 +175,7 @@ dependencies:
170
175
  tasks:
171
176
  - advanced-elicitation
172
177
  - create-doc
178
+ - kb-mode-interaction
173
179
  data:
174
180
  - bmad-kb
175
181
  utils:
@@ -663,6 +669,79 @@ If template specifies a checklist:
663
669
  - Template markup is for AI processing only - never expose to users
664
670
  ==================== END: tasks#create-doc ====================
665
671
 
672
+ ==================== START: tasks#kb-mode-interaction ====================
673
+ # KB Mode Interaction Task
674
+
675
+ ## Purpose
676
+ Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
677
+
678
+ ## Instructions
679
+
680
+ When entering KB mode (*kb-mode), follow these steps:
681
+
682
+ ### 1. Welcome and Guide
683
+ Announce entering KB mode with a brief, friendly introduction:
684
+
685
+ "I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
686
+
687
+ ### 2. Present Topic Areas
688
+ Offer a concise list of main topic areas the user might want to explore:
689
+
690
+ **What would you like to know more about?**
691
+
692
+ 1. **Setup & Installation** - Getting started with BMAD
693
+ 2. **Workflows** - Choosing the right workflow for your project
694
+ 3. **Web vs IDE** - When to use each environment
695
+ 4. **Agents** - Understanding specialized agents and their roles
696
+ 5. **Documents** - PRDs, Architecture, Stories, and more
697
+ 6. **Agile Process** - How BMAD implements Agile methodologies
698
+ 7. **Configuration** - Customizing BMAD for your needs
699
+ 8. **Best Practices** - Tips for effective BMAD usage
700
+
701
+ Or ask me about anything else related to BMAD-METHOD!
702
+
703
+ ### 3. Respond Contextually
704
+ - Wait for user's specific question or topic selection
705
+ - Provide focused, relevant information from the knowledge base
706
+ - Offer to dive deeper or explore related topics
707
+ - Keep responses concise unless user asks for detailed explanations
708
+
709
+ ### 4. Interactive Exploration
710
+ - After answering, suggest related topics they might find helpful
711
+ - Maintain conversational flow rather than data dumping
712
+ - Use examples when appropriate
713
+ - Reference specific documentation sections when relevant
714
+
715
+ ### 5. Exit Gracefully
716
+ When user is done or wants to exit KB mode:
717
+ - Summarize key points discussed if helpful
718
+ - Remind them they can return to KB mode anytime with *kb-mode
719
+ - Suggest next steps based on what was discussed
720
+
721
+ ## Example Interaction
722
+
723
+ **User**: *kb-mode
724
+
725
+ **Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
726
+
727
+ **What would you like to know more about?**
728
+
729
+ 1. **Setup & Installation** - Getting started with BMAD
730
+ 2. **Workflows** - Choosing the right workflow for your project
731
+ 3. **Web vs IDE** - When to use each environment
732
+ 4. **Agents** - Understanding specialized agents and their roles
733
+ 5. **Documents** - PRDs, Architecture, Stories, and more
734
+ 6. **Agile Process** - How BMAD implements Agile methodologies
735
+ 7. **Configuration** - Customizing BMAD for your needs
736
+ 8. **Best Practices** - Tips for effective BMAD usage
737
+
738
+ Or ask me about anything else related to BMAD-METHOD!
739
+
740
+ **User**: Tell me about workflows
741
+
742
+ **Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
743
+ ==================== END: tasks#kb-mode-interaction ====================
744
+
666
745
  ==================== START: data#bmad-kb ====================
667
746
  # BMAD Knowledge Base
668
747
 
@@ -732,6 +811,64 @@ npx bmad-method install
732
811
 
733
812
  **Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
734
813
 
814
+ ## Core Configuration (core-config.yml)
815
+
816
+ **New in V4**: The `bmad-core/core-config.yml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
817
+
818
+ ### What is core-config.yml?
819
+
820
+ This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
821
+
822
+ - **Version Flexibility**: Work with V3, V4, or custom document structures
823
+ - **Custom Locations**: Define where your documents and shards live
824
+ - **Developer Context**: Specify which files the dev agent should always load
825
+ - **Debug Support**: Built-in logging for troubleshooting
826
+
827
+ ### Key Configuration Areas
828
+
829
+ #### PRD Configuration
830
+ - **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
831
+ - **prdSharded**: Whether epics are embedded (false) or in separate files (true)
832
+ - **prdShardedLocation**: Where to find sharded epic files
833
+ - **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
834
+
835
+ #### Architecture Configuration
836
+ - **architectureVersion**: v3 (monolithic) or v4 (sharded)
837
+ - **architectureSharded**: Whether architecture is split into components
838
+ - **architectureShardedLocation**: Where sharded architecture files live
839
+
840
+ #### Developer Files
841
+ - **devLoadAlwaysFiles**: List of files the dev agent loads for every task
842
+ - **devDebugLog**: Where dev agent logs repeated failures
843
+ - **agentCoreDump**: Export location for chat conversations
844
+
845
+ ### Why It Matters
846
+
847
+ 1. **No Forced Migrations**: Keep your existing document structure
848
+ 2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
849
+ 3. **Custom Workflows**: Configure BMAD to match your team's process
850
+ 4. **Intelligent Agents**: Agents automatically adapt to your configuration
851
+
852
+ ### Common Configurations
853
+
854
+ **Legacy V3 Project**:
855
+ ```yaml
856
+ prdVersion: v3
857
+ prdSharded: false
858
+ architectureVersion: v3
859
+ architectureSharded: false
860
+ ```
861
+
862
+ **V4 Optimized Project**:
863
+ ```yaml
864
+ prdVersion: v4
865
+ prdSharded: true
866
+ prdShardedLocation: docs/prd
867
+ architectureVersion: v4
868
+ architectureSharded: true
869
+ architectureShardedLocation: docs/architecture
870
+ ```
871
+
735
872
  ## Core Philosophy
736
873
 
737
874
  ### Vibe CEO'ing
@@ -8809,7 +8946,7 @@ workflow:
8809
8946
 
8810
8947
  sequence:
8811
8948
  - step: service_analysis
8812
- agent: architect
8949
+ agent: architect
8813
8950
  action: analyze existing project and use task document-project
8814
8951
  creates: multiple documents per the document-project template
8815
8952
  notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."