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.
- package/.vscode/settings.json +1 -0
- package/CHANGELOG.md +19 -0
- package/bmad-core/core-config.yml +20 -26
- package/bmad-core/tasks/create-next-story.md +9 -9
- package/bmad-core/tasks/shard-doc.md +25 -7
- package/dist/agents/analyst.txt +58 -0
- package/dist/agents/bmad-master.txt +99 -13
- package/dist/agents/bmad-orchestrator.txt +137 -0
- package/dist/agents/sm.txt +41 -13
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +79 -0
- package/dist/teams/team-all.txt +179 -14
- package/dist/teams/team-fullstack.txt +138 -1
- package/dist/teams/team-ide-minimal.txt +178 -13
- package/dist/teams/team-no-ui.txt +138 -1
- package/docs/user-guide.md +22 -22
- package/package.json +1 -1
- package/tools/installer/lib/installer.js +12 -2
- package/tools/installer/package.json +1 -1
package/.vscode/settings.json
CHANGED
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,22 @@
|
|
|
1
|
+
# [4.11.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.3...v4.11.0) (2025-06-21)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* resolve web bundles directory path when using relative paths in NPX installer ([5c8485d](https://github.com/bmadcode/BMAD-METHOD/commit/5c8485d09ffec60ad4965ced62f4595890cb7535))
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* add markdown-tree integration for document sharding ([540578b](https://github.com/bmadcode/BMAD-METHOD/commit/540578b39d1815e41e11f0e87545de3f09ee54e1))
|
|
12
|
+
|
|
13
|
+
## [4.10.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.2...v4.10.3) (2025-06-20)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* bundle update ([2cf3ba1](https://github.com/bmadcode/BMAD-METHOD/commit/2cf3ba1ab8dd7e52584bef16a96e65e7d2513c4f))
|
|
19
|
+
|
|
1
20
|
## [4.10.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.1...v4.10.2) (2025-06-20)
|
|
2
21
|
|
|
3
22
|
|
|
@@ -1,26 +1,20 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
prd
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
architecture
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
devLoadAlwaysFiles:
|
|
22
|
-
- docs/architecture/coding-standards.md
|
|
23
|
-
- docs/architecture/tech-stack.md
|
|
24
|
-
- docs/architecture/project-structure.md
|
|
25
|
-
devDebugLog: .ai/debug-log.md
|
|
26
|
-
agentCoreDump: .ai/core-dump{n}.md
|
|
1
|
+
markdownExploder: true
|
|
2
|
+
prd:
|
|
3
|
+
prdFile: docs/prd.md
|
|
4
|
+
prdVersion: v4
|
|
5
|
+
prdSharded: true
|
|
6
|
+
prdShardedLocation: docs/prd
|
|
7
|
+
epicFilePattern: epic-{n}*.md
|
|
8
|
+
architecture:
|
|
9
|
+
architectureFile: docs/architecture.md
|
|
10
|
+
architectureVersion: v4
|
|
11
|
+
architectureSharded: true
|
|
12
|
+
architectureShardedLocation: docs/architecture
|
|
13
|
+
customTechnicalDocuments: null
|
|
14
|
+
devLoadAlwaysFiles:
|
|
15
|
+
- docs/architecture/coding-standards.md
|
|
16
|
+
- docs/architecture/tech-stack.md
|
|
17
|
+
- docs/architecture/source-tree.md
|
|
18
|
+
devDebugLog: .ai/debug-log.md
|
|
19
|
+
devStoryLocation: docs/stories
|
|
20
|
+
agentCoreDump: .ai/core-dump{n}.md
|
|
@@ -17,14 +17,14 @@ To identify the next logical story based on project progress and epic definition
|
|
|
17
17
|
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
|
18
18
|
Please add and configure core-config.yml before proceeding."
|
|
19
19
|
- Extract the following key configurations:
|
|
20
|
-
- `
|
|
20
|
+
- `devStoryLocation`: Where to save story files
|
|
21
21
|
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
22
|
-
- `prd.
|
|
22
|
+
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
|
23
23
|
- `prd.prdShardedLocation`: Location of sharded epic files
|
|
24
24
|
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
|
25
25
|
- `architecture.architectureVersion`: Architecture document version
|
|
26
26
|
- `architecture.architectureSharded`: Whether architecture is sharded
|
|
27
|
-
- `architecture.
|
|
27
|
+
- `architecture.architectureFile`: Location of monolithic architecture
|
|
28
28
|
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
|
29
29
|
|
|
30
30
|
### 1. Identify Next Story for Preparation
|
|
@@ -33,11 +33,11 @@ To identify the next logical story based on project progress and epic definition
|
|
|
33
33
|
|
|
34
34
|
- Based on `prdSharded` from config:
|
|
35
35
|
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
|
36
|
-
- **If `prdSharded: false`**: Load the full PRD from `
|
|
36
|
+
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
|
37
37
|
|
|
38
38
|
#### 1.2 Review Existing Stories
|
|
39
39
|
|
|
40
|
-
- Check `
|
|
40
|
+
- Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
|
|
41
41
|
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
|
42
42
|
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
|
43
43
|
- Verify its `Status` is 'Done' (or equivalent).
|
|
@@ -126,13 +126,13 @@ Based on configuration loaded in Step 0:
|
|
|
126
126
|
- Follow the structured reading order in section 4.2 below
|
|
127
127
|
|
|
128
128
|
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
|
129
|
-
- Load the monolithic architecture from `
|
|
129
|
+
- Load the monolithic architecture from `architectureFile`
|
|
130
130
|
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
|
131
131
|
|
|
132
132
|
- **If `architectureVersion` is NOT v4**:
|
|
133
133
|
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
|
134
134
|
- If `architectureSharded: true`: Search sharded files by filename relevance
|
|
135
|
-
- If `architectureSharded: false`: Search within monolithic `
|
|
135
|
+
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
|
136
136
|
|
|
137
137
|
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
|
138
138
|
|
|
@@ -189,7 +189,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
189
189
|
|
|
190
190
|
### 6. Populate Story Template with Full Context
|
|
191
191
|
|
|
192
|
-
- Create a new story file: `{
|
|
192
|
+
- Create a new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config).
|
|
193
193
|
- Use the Story Template to structure the file.
|
|
194
194
|
- Fill in:
|
|
195
195
|
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
|
@@ -236,7 +236,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
236
236
|
- Verify all source references are included for technical details
|
|
237
237
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
238
238
|
- Update status to "Draft"
|
|
239
|
-
- Save the story file to `{
|
|
239
|
+
- Save the story file to `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config)
|
|
240
240
|
|
|
241
241
|
### 9. Report Completion
|
|
242
242
|
|
|
@@ -6,9 +6,27 @@
|
|
|
6
6
|
- Create a folder structure to organize the sharded documents
|
|
7
7
|
- Maintain all content integrity including code blocks, diagrams, and markdown formatting
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Primary Method: Automatic with markdown-tree
|
|
10
10
|
|
|
11
|
-
[[LLM: First,
|
|
11
|
+
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
12
|
+
|
|
13
|
+
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
14
|
+
|
|
15
|
+
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:
|
|
16
|
+
|
|
17
|
+
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
18
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yml
|
|
19
|
+
|
|
20
|
+
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
21
|
+
|
|
22
|
+
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
23
|
+
|
|
24
|
+
1. Set markdownExploder to true in bmad-core/core-config.yml
|
|
25
|
+
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
26
|
+
|
|
27
|
+
I will now proceed with the manual sharding process."
|
|
28
|
+
|
|
29
|
+
Then proceed with the manual method below ONLY if markdownExploder is false.]]
|
|
12
30
|
|
|
13
31
|
### Installation and Usage
|
|
14
32
|
|
|
@@ -41,19 +59,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
41
59
|
|
|
42
60
|
---
|
|
43
61
|
|
|
44
|
-
## Manual Method (if @kayvan/markdown-tree-parser is not available)
|
|
62
|
+
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
|
45
63
|
|
|
46
64
|
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
|
47
65
|
|
|
48
66
|
### Task Instructions
|
|
49
67
|
|
|
50
|
-
|
|
68
|
+
1. Identify Document and Target Location
|
|
51
69
|
|
|
52
70
|
- Determine which document to shard (user-provided path)
|
|
53
71
|
- Create a new folder under `docs/` with the same name as the document (without extension)
|
|
54
72
|
- Example: `docs/prd.md` → create folder `docs/prd/`
|
|
55
73
|
|
|
56
|
-
|
|
74
|
+
2. Parse and Extract Sections
|
|
57
75
|
|
|
58
76
|
[[LLM: When sharding the document:
|
|
59
77
|
|
|
@@ -63,7 +81,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
63
81
|
- Extract the section heading and ALL content until the next level 2 section
|
|
64
82
|
- Include all subsections, code blocks, diagrams, lists, tables, etc.
|
|
65
83
|
- Be extremely careful with:
|
|
66
|
-
- Fenced code blocks (```) - ensure you capture the full block including closing backticks
|
|
84
|
+
- Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
|
|
67
85
|
- Mermaid diagrams - preserve the complete diagram syntax
|
|
68
86
|
- Nested markdown elements
|
|
69
87
|
- Multi-line content that might contain ## inside code blocks
|
|
@@ -82,7 +100,7 @@ For each extracted section:
|
|
|
82
100
|
|
|
83
101
|
2. **Adjust heading levels**:
|
|
84
102
|
|
|
85
|
-
- The level 2 heading becomes level 1 (# instead of ##)
|
|
103
|
+
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
|
86
104
|
- All subsection levels decrease by 1:
|
|
87
105
|
|
|
88
106
|
```txt
|
package/dist/agents/analyst.txt
CHANGED
|
@@ -1679,6 +1679,64 @@ npx bmad-method install
|
|
|
1679
1679
|
|
|
1680
1680
|
**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.
|
|
1681
1681
|
|
|
1682
|
+
## Core Configuration (core-config.yml)
|
|
1683
|
+
|
|
1684
|
+
**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.
|
|
1685
|
+
|
|
1686
|
+
### What is core-config.yml?
|
|
1687
|
+
|
|
1688
|
+
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:
|
|
1689
|
+
|
|
1690
|
+
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
1691
|
+
- **Custom Locations**: Define where your documents and shards live
|
|
1692
|
+
- **Developer Context**: Specify which files the dev agent should always load
|
|
1693
|
+
- **Debug Support**: Built-in logging for troubleshooting
|
|
1694
|
+
|
|
1695
|
+
### Key Configuration Areas
|
|
1696
|
+
|
|
1697
|
+
#### PRD Configuration
|
|
1698
|
+
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
|
1699
|
+
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
|
1700
|
+
- **prdShardedLocation**: Where to find sharded epic files
|
|
1701
|
+
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
|
1702
|
+
|
|
1703
|
+
#### Architecture Configuration
|
|
1704
|
+
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
|
1705
|
+
- **architectureSharded**: Whether architecture is split into components
|
|
1706
|
+
- **architectureShardedLocation**: Where sharded architecture files live
|
|
1707
|
+
|
|
1708
|
+
#### Developer Files
|
|
1709
|
+
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
|
1710
|
+
- **devDebugLog**: Where dev agent logs repeated failures
|
|
1711
|
+
- **agentCoreDump**: Export location for chat conversations
|
|
1712
|
+
|
|
1713
|
+
### Why It Matters
|
|
1714
|
+
|
|
1715
|
+
1. **No Forced Migrations**: Keep your existing document structure
|
|
1716
|
+
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
1717
|
+
3. **Custom Workflows**: Configure BMAD to match your team's process
|
|
1718
|
+
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
1719
|
+
|
|
1720
|
+
### Common Configurations
|
|
1721
|
+
|
|
1722
|
+
**Legacy V3 Project**:
|
|
1723
|
+
```yaml
|
|
1724
|
+
prdVersion: v3
|
|
1725
|
+
prdSharded: false
|
|
1726
|
+
architectureVersion: v3
|
|
1727
|
+
architectureSharded: false
|
|
1728
|
+
```
|
|
1729
|
+
|
|
1730
|
+
**V4 Optimized Project**:
|
|
1731
|
+
```yaml
|
|
1732
|
+
prdVersion: v4
|
|
1733
|
+
prdSharded: true
|
|
1734
|
+
prdShardedLocation: docs/prd
|
|
1735
|
+
architectureVersion: v4
|
|
1736
|
+
architectureSharded: true
|
|
1737
|
+
architectureShardedLocation: docs/architecture
|
|
1738
|
+
```
|
|
1739
|
+
|
|
1682
1740
|
## Core Philosophy
|
|
1683
1741
|
|
|
1684
1742
|
### Vibe CEO'ing
|
|
@@ -1734,14 +1734,14 @@ To identify the next logical story based on project progress and epic definition
|
|
|
1734
1734
|
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
|
1735
1735
|
Please add and configure core-config.yml before proceeding."
|
|
1736
1736
|
- Extract the following key configurations:
|
|
1737
|
-
- `
|
|
1737
|
+
- `devStoryLocation`: Where to save story files
|
|
1738
1738
|
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
|
1739
|
-
- `prd.
|
|
1739
|
+
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
|
1740
1740
|
- `prd.prdShardedLocation`: Location of sharded epic files
|
|
1741
1741
|
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
|
1742
1742
|
- `architecture.architectureVersion`: Architecture document version
|
|
1743
1743
|
- `architecture.architectureSharded`: Whether architecture is sharded
|
|
1744
|
-
- `architecture.
|
|
1744
|
+
- `architecture.architectureFile`: Location of monolithic architecture
|
|
1745
1745
|
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
|
1746
1746
|
|
|
1747
1747
|
### 1. Identify Next Story for Preparation
|
|
@@ -1750,11 +1750,11 @@ To identify the next logical story based on project progress and epic definition
|
|
|
1750
1750
|
|
|
1751
1751
|
- Based on `prdSharded` from config:
|
|
1752
1752
|
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
|
1753
|
-
- **If `prdSharded: false`**: Load the full PRD from `
|
|
1753
|
+
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
|
1754
1754
|
|
|
1755
1755
|
#### 1.2 Review Existing Stories
|
|
1756
1756
|
|
|
1757
|
-
- Check `
|
|
1757
|
+
- Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
|
|
1758
1758
|
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
|
1759
1759
|
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
|
1760
1760
|
- Verify its `Status` is 'Done' (or equivalent).
|
|
@@ -1774,12 +1774,40 @@ To identify the next logical story based on project progress and epic definition
|
|
|
1774
1774
|
```
|
|
1775
1775
|
|
|
1776
1776
|
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
|
1777
|
-
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and
|
|
1778
|
-
-
|
|
1777
|
+
- 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).
|
|
1778
|
+
- If the next sequential story has unmet prerequisites, present this to the user:
|
|
1779
|
+
|
|
1780
|
+
```plaintext
|
|
1781
|
+
ALERT: Next story has unmet prerequisites:
|
|
1782
|
+
Story: {epicNum}.{storyNum} - {Story Title}
|
|
1783
|
+
Prerequisites not met: [list specific prerequisites]
|
|
1784
|
+
|
|
1785
|
+
Would you like to:
|
|
1786
|
+
1. Create the story anyway (mark prerequisites as pending)
|
|
1787
|
+
2. Skip to a different story (requires your specific instruction)
|
|
1788
|
+
3. Cancel story creation
|
|
1789
|
+
|
|
1790
|
+
Please choose an option (1/2/3):
|
|
1791
|
+
```
|
|
1792
|
+
|
|
1793
|
+
- If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
|
|
1794
|
+
|
|
1795
|
+
```plaintext
|
|
1796
|
+
Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
|
|
1797
|
+
|
|
1798
|
+
Would you like to:
|
|
1799
|
+
1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
|
|
1800
|
+
2. Select a specific story to work on
|
|
1801
|
+
3. Cancel story creation
|
|
1802
|
+
|
|
1803
|
+
Please choose an option (1/2/3):
|
|
1804
|
+
```
|
|
1805
|
+
|
|
1806
|
+
- **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.
|
|
1779
1807
|
|
|
1780
1808
|
- **If no story files exist in `docs/stories/`:**
|
|
1781
|
-
- The next story is the first story
|
|
1782
|
-
- If
|
|
1809
|
+
- The next story is ALWAYS 1.1 (the first story of the first epic).
|
|
1810
|
+
- If story 1.1 has unmet prerequisites, follow the same alert process as above.
|
|
1783
1811
|
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
|
1784
1812
|
|
|
1785
1813
|
### 2. Gather Core Story Requirements (from Epic)
|
|
@@ -1815,13 +1843,13 @@ Based on configuration loaded in Step 0:
|
|
|
1815
1843
|
- Follow the structured reading order in section 4.2 below
|
|
1816
1844
|
|
|
1817
1845
|
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
|
1818
|
-
- Load the monolithic architecture from `
|
|
1846
|
+
- Load the monolithic architecture from `architectureFile`
|
|
1819
1847
|
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
|
1820
1848
|
|
|
1821
1849
|
- **If `architectureVersion` is NOT v4**:
|
|
1822
1850
|
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
|
1823
1851
|
- If `architectureSharded: true`: Search sharded files by filename relevance
|
|
1824
|
-
- If `architectureSharded: false`: Search within monolithic `
|
|
1852
|
+
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
|
1825
1853
|
|
|
1826
1854
|
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
|
1827
1855
|
|
|
@@ -1878,7 +1906,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
1878
1906
|
|
|
1879
1907
|
### 6. Populate Story Template with Full Context
|
|
1880
1908
|
|
|
1881
|
-
- Create a new story file: `{
|
|
1909
|
+
- Create a new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config).
|
|
1882
1910
|
- Use the Story Template to structure the file.
|
|
1883
1911
|
- Fill in:
|
|
1884
1912
|
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
|
@@ -1925,7 +1953,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
|
|
1925
1953
|
- Verify all source references are included for technical details
|
|
1926
1954
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
1927
1955
|
- Update status to "Draft"
|
|
1928
|
-
- Save the story file to `{
|
|
1956
|
+
- Save the story file to `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config)
|
|
1929
1957
|
|
|
1930
1958
|
### 9. Report Completion
|
|
1931
1959
|
|
|
@@ -8486,6 +8514,64 @@ npx bmad-method install
|
|
|
8486
8514
|
|
|
8487
8515
|
**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.
|
|
8488
8516
|
|
|
8517
|
+
## Core Configuration (core-config.yml)
|
|
8518
|
+
|
|
8519
|
+
**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.
|
|
8520
|
+
|
|
8521
|
+
### What is core-config.yml?
|
|
8522
|
+
|
|
8523
|
+
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:
|
|
8524
|
+
|
|
8525
|
+
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
8526
|
+
- **Custom Locations**: Define where your documents and shards live
|
|
8527
|
+
- **Developer Context**: Specify which files the dev agent should always load
|
|
8528
|
+
- **Debug Support**: Built-in logging for troubleshooting
|
|
8529
|
+
|
|
8530
|
+
### Key Configuration Areas
|
|
8531
|
+
|
|
8532
|
+
#### PRD Configuration
|
|
8533
|
+
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
|
8534
|
+
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
|
8535
|
+
- **prdShardedLocation**: Where to find sharded epic files
|
|
8536
|
+
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
|
8537
|
+
|
|
8538
|
+
#### Architecture Configuration
|
|
8539
|
+
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
|
8540
|
+
- **architectureSharded**: Whether architecture is split into components
|
|
8541
|
+
- **architectureShardedLocation**: Where sharded architecture files live
|
|
8542
|
+
|
|
8543
|
+
#### Developer Files
|
|
8544
|
+
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
|
8545
|
+
- **devDebugLog**: Where dev agent logs repeated failures
|
|
8546
|
+
- **agentCoreDump**: Export location for chat conversations
|
|
8547
|
+
|
|
8548
|
+
### Why It Matters
|
|
8549
|
+
|
|
8550
|
+
1. **No Forced Migrations**: Keep your existing document structure
|
|
8551
|
+
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
8552
|
+
3. **Custom Workflows**: Configure BMAD to match your team's process
|
|
8553
|
+
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
8554
|
+
|
|
8555
|
+
### Common Configurations
|
|
8556
|
+
|
|
8557
|
+
**Legacy V3 Project**:
|
|
8558
|
+
```yaml
|
|
8559
|
+
prdVersion: v3
|
|
8560
|
+
prdSharded: false
|
|
8561
|
+
architectureVersion: v3
|
|
8562
|
+
architectureSharded: false
|
|
8563
|
+
```
|
|
8564
|
+
|
|
8565
|
+
**V4 Optimized Project**:
|
|
8566
|
+
```yaml
|
|
8567
|
+
prdVersion: v4
|
|
8568
|
+
prdSharded: true
|
|
8569
|
+
prdShardedLocation: docs/prd
|
|
8570
|
+
architectureVersion: v4
|
|
8571
|
+
architectureSharded: true
|
|
8572
|
+
architectureShardedLocation: docs/architecture
|
|
8573
|
+
```
|
|
8574
|
+
|
|
8489
8575
|
## Core Philosophy
|
|
8490
8576
|
|
|
8491
8577
|
### Vibe CEO'ing
|
|
@@ -136,6 +136,11 @@ loading:
|
|
|
136
136
|
- Agents: Only when transforming
|
|
137
137
|
- Templates/Tasks: Only when executing
|
|
138
138
|
- Always indicate loading
|
|
139
|
+
kb-mode-behavior:
|
|
140
|
+
- When *kb-mode is invoked, use kb-mode-interaction task
|
|
141
|
+
- Don't dump all KB content immediately
|
|
142
|
+
- Present topic areas and wait for user selection
|
|
143
|
+
- Provide focused, contextual responses
|
|
139
144
|
workflow-guidance:
|
|
140
145
|
- Discover available workflows in the bundle at runtime
|
|
141
146
|
- Understand each workflow's purpose, options, and decision points
|
|
@@ -149,6 +154,7 @@ dependencies:
|
|
|
149
154
|
tasks:
|
|
150
155
|
- advanced-elicitation
|
|
151
156
|
- create-doc
|
|
157
|
+
- kb-mode-interaction
|
|
152
158
|
data:
|
|
153
159
|
- bmad-kb
|
|
154
160
|
utils:
|
|
@@ -329,6 +335,79 @@ If template specifies a checklist:
|
|
|
329
335
|
- Template markup is for AI processing only - never expose to users
|
|
330
336
|
==================== END: tasks#create-doc ====================
|
|
331
337
|
|
|
338
|
+
==================== START: tasks#kb-mode-interaction ====================
|
|
339
|
+
# KB Mode Interaction Task
|
|
340
|
+
|
|
341
|
+
## Purpose
|
|
342
|
+
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
|
343
|
+
|
|
344
|
+
## Instructions
|
|
345
|
+
|
|
346
|
+
When entering KB mode (*kb-mode), follow these steps:
|
|
347
|
+
|
|
348
|
+
### 1. Welcome and Guide
|
|
349
|
+
Announce entering KB mode with a brief, friendly introduction:
|
|
350
|
+
|
|
351
|
+
"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."
|
|
352
|
+
|
|
353
|
+
### 2. Present Topic Areas
|
|
354
|
+
Offer a concise list of main topic areas the user might want to explore:
|
|
355
|
+
|
|
356
|
+
**What would you like to know more about?**
|
|
357
|
+
|
|
358
|
+
1. **Setup & Installation** - Getting started with BMAD
|
|
359
|
+
2. **Workflows** - Choosing the right workflow for your project
|
|
360
|
+
3. **Web vs IDE** - When to use each environment
|
|
361
|
+
4. **Agents** - Understanding specialized agents and their roles
|
|
362
|
+
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
363
|
+
6. **Agile Process** - How BMAD implements Agile methodologies
|
|
364
|
+
7. **Configuration** - Customizing BMAD for your needs
|
|
365
|
+
8. **Best Practices** - Tips for effective BMAD usage
|
|
366
|
+
|
|
367
|
+
Or ask me about anything else related to BMAD-METHOD!
|
|
368
|
+
|
|
369
|
+
### 3. Respond Contextually
|
|
370
|
+
- Wait for user's specific question or topic selection
|
|
371
|
+
- Provide focused, relevant information from the knowledge base
|
|
372
|
+
- Offer to dive deeper or explore related topics
|
|
373
|
+
- Keep responses concise unless user asks for detailed explanations
|
|
374
|
+
|
|
375
|
+
### 4. Interactive Exploration
|
|
376
|
+
- After answering, suggest related topics they might find helpful
|
|
377
|
+
- Maintain conversational flow rather than data dumping
|
|
378
|
+
- Use examples when appropriate
|
|
379
|
+
- Reference specific documentation sections when relevant
|
|
380
|
+
|
|
381
|
+
### 5. Exit Gracefully
|
|
382
|
+
When user is done or wants to exit KB mode:
|
|
383
|
+
- Summarize key points discussed if helpful
|
|
384
|
+
- Remind them they can return to KB mode anytime with *kb-mode
|
|
385
|
+
- Suggest next steps based on what was discussed
|
|
386
|
+
|
|
387
|
+
## Example Interaction
|
|
388
|
+
|
|
389
|
+
**User**: *kb-mode
|
|
390
|
+
|
|
391
|
+
**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.
|
|
392
|
+
|
|
393
|
+
**What would you like to know more about?**
|
|
394
|
+
|
|
395
|
+
1. **Setup & Installation** - Getting started with BMAD
|
|
396
|
+
2. **Workflows** - Choosing the right workflow for your project
|
|
397
|
+
3. **Web vs IDE** - When to use each environment
|
|
398
|
+
4. **Agents** - Understanding specialized agents and their roles
|
|
399
|
+
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
400
|
+
6. **Agile Process** - How BMAD implements Agile methodologies
|
|
401
|
+
7. **Configuration** - Customizing BMAD for your needs
|
|
402
|
+
8. **Best Practices** - Tips for effective BMAD usage
|
|
403
|
+
|
|
404
|
+
Or ask me about anything else related to BMAD-METHOD!
|
|
405
|
+
|
|
406
|
+
**User**: Tell me about workflows
|
|
407
|
+
|
|
408
|
+
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
|
409
|
+
==================== END: tasks#kb-mode-interaction ====================
|
|
410
|
+
|
|
332
411
|
==================== START: data#bmad-kb ====================
|
|
333
412
|
# BMAD Knowledge Base
|
|
334
413
|
|
|
@@ -398,6 +477,64 @@ npx bmad-method install
|
|
|
398
477
|
|
|
399
478
|
**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.
|
|
400
479
|
|
|
480
|
+
## Core Configuration (core-config.yml)
|
|
481
|
+
|
|
482
|
+
**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.
|
|
483
|
+
|
|
484
|
+
### What is core-config.yml?
|
|
485
|
+
|
|
486
|
+
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:
|
|
487
|
+
|
|
488
|
+
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
489
|
+
- **Custom Locations**: Define where your documents and shards live
|
|
490
|
+
- **Developer Context**: Specify which files the dev agent should always load
|
|
491
|
+
- **Debug Support**: Built-in logging for troubleshooting
|
|
492
|
+
|
|
493
|
+
### Key Configuration Areas
|
|
494
|
+
|
|
495
|
+
#### PRD Configuration
|
|
496
|
+
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
|
497
|
+
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
|
498
|
+
- **prdShardedLocation**: Where to find sharded epic files
|
|
499
|
+
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
|
500
|
+
|
|
501
|
+
#### Architecture Configuration
|
|
502
|
+
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
|
503
|
+
- **architectureSharded**: Whether architecture is split into components
|
|
504
|
+
- **architectureShardedLocation**: Where sharded architecture files live
|
|
505
|
+
|
|
506
|
+
#### Developer Files
|
|
507
|
+
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
|
508
|
+
- **devDebugLog**: Where dev agent logs repeated failures
|
|
509
|
+
- **agentCoreDump**: Export location for chat conversations
|
|
510
|
+
|
|
511
|
+
### Why It Matters
|
|
512
|
+
|
|
513
|
+
1. **No Forced Migrations**: Keep your existing document structure
|
|
514
|
+
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
515
|
+
3. **Custom Workflows**: Configure BMAD to match your team's process
|
|
516
|
+
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
517
|
+
|
|
518
|
+
### Common Configurations
|
|
519
|
+
|
|
520
|
+
**Legacy V3 Project**:
|
|
521
|
+
```yaml
|
|
522
|
+
prdVersion: v3
|
|
523
|
+
prdSharded: false
|
|
524
|
+
architectureVersion: v3
|
|
525
|
+
architectureSharded: false
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
**V4 Optimized Project**:
|
|
529
|
+
```yaml
|
|
530
|
+
prdVersion: v4
|
|
531
|
+
prdSharded: true
|
|
532
|
+
prdShardedLocation: docs/prd
|
|
533
|
+
architectureVersion: v4
|
|
534
|
+
architectureSharded: true
|
|
535
|
+
architectureShardedLocation: docs/architecture
|
|
536
|
+
```
|
|
537
|
+
|
|
401
538
|
## Core Philosophy
|
|
402
539
|
|
|
403
540
|
### Vibe CEO'ing
|