bmad-method 4.19.2 → 4.20.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/.github/FUNDING.yml +15 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.vscode/settings.json +6 -76
- package/CHANGELOG.md +7 -0
- package/CONTRIBUTING.md +1 -1
- package/GUIDING-PRINCIPLES.md +2 -2
- package/LICENSE +1 -1
- package/README.md +178 -220
- package/bmad-core/agents/dev.md +1 -1
- package/bmad-core/data/bmad-kb.md +1 -1
- package/dist/agents/analyst.txt +1 -1
- package/dist/agents/bmad-master.txt +1 -1
- package/dist/agents/bmad-orchestrator.txt +1 -1
- package/dist/teams/team-all.txt +39 -39
- package/dist/teams/team-fullstack.txt +39 -39
- package/dist/teams/team-ide-minimal.txt +1 -1
- package/dist/teams/team-no-ui.txt +13 -13
- package/docs/agentic-tools/claude-code-guide.md +36 -0
- package/docs/agentic-tools/cline-guide.md +42 -0
- package/docs/agentic-tools/cursor-guide.md +37 -0
- package/docs/agentic-tools/gemini-cli-guide.md +46 -0
- package/docs/agentic-tools/roo-code-guide.md +46 -0
- package/docs/agentic-tools/windsurf-guide.md +37 -0
- package/docs/core-architecture.md +174 -6
- package/docs/expansion-packs.md +15 -0
- package/docs/user-guide.md +283 -36
- package/docs/versioning-and-releases.md +2 -10
- package/docs/versions.md +0 -1
- package/docs/working-in-the-brownfield.md +4 -8
- package/package.json +1 -1
- package/tools/installer/bin/bmad.js +2 -2
- package/tools/installer/package.json +1 -1
- package/.claude/commands/analyst.md +0 -68
- package/.claude/commands/architect.md +0 -68
- package/.claude/commands/bmad-master.md +0 -105
- package/.claude/commands/bmad-orchestrator.md +0 -130
- package/.claude/commands/bmad-the-creator.md +0 -57
- package/.claude/commands/dev.md +0 -69
- package/.claude/commands/game-designer.md +0 -62
- package/.claude/commands/game-developer.md +0 -70
- package/.claude/commands/game-sm.md +0 -55
- package/.claude/commands/infra-devops-platform.md +0 -63
- package/.claude/commands/pm.md +0 -65
- package/.claude/commands/po.md +0 -67
- package/.claude/commands/qa.md +0 -54
- package/.claude/commands/sm.md +0 -55
- package/.claude/commands/ux-expert.md +0 -67
- package/.clinerules/01-bmad-master.md +0 -116
- package/.clinerules/02-bmad-orchestrator.md +0 -141
- package/.clinerules/03-pm.md +0 -76
- package/.clinerules/04-analyst.md +0 -79
- package/.clinerules/05-architect.md +0 -79
- package/.clinerules/06-po.md +0 -78
- package/.clinerules/07-sm.md +0 -66
- package/.clinerules/08-dev.md +0 -80
- package/.clinerules/09-qa.md +0 -65
- package/.clinerules/10-ux-expert.md +0 -78
- package/.clinerules/11-bmad-the-creator.md +0 -68
- package/.clinerules/12-game-designer.md +0 -73
- package/.clinerules/13-game-developer.md +0 -81
- package/.clinerules/14-game-sm.md +0 -66
- package/.clinerules/15-infra-devops-platform.md +0 -74
- package/.cursor/rules/analyst.mdc +0 -82
- package/.cursor/rules/architect.mdc +0 -82
- package/.cursor/rules/bmad-master.mdc +0 -119
- package/.cursor/rules/bmad-orchestrator.mdc +0 -144
- package/.cursor/rules/bmad-the-creator.mdc +0 -71
- package/.cursor/rules/dev.mdc +0 -83
- package/.cursor/rules/game-designer.mdc +0 -76
- package/.cursor/rules/game-developer.mdc +0 -84
- package/.cursor/rules/game-sm.mdc +0 -69
- package/.cursor/rules/infra-devops-platform.mdc +0 -77
- package/.cursor/rules/pm.mdc +0 -79
- package/.cursor/rules/po.mdc +0 -81
- package/.cursor/rules/qa.mdc +0 -68
- package/.cursor/rules/sm.mdc +0 -69
- package/.cursor/rules/ux-expert.mdc +0 -81
- package/.gemini/agents/analyst.md +0 -64
- package/.gemini/agents/architect.md +0 -64
- package/.gemini/agents/bmad-master.md +0 -101
- package/.gemini/agents/bmad-orchestrator.md +0 -126
- package/.gemini/agents/bmad-the-creator.md +0 -53
- package/.gemini/agents/dev.md +0 -65
- package/.gemini/agents/game-designer.md +0 -58
- package/.gemini/agents/game-developer.md +0 -66
- package/.gemini/agents/game-sm.md +0 -51
- package/.gemini/agents/infra-devops-platform.md +0 -59
- package/.gemini/agents/pm.md +0 -61
- package/.gemini/agents/po.md +0 -63
- package/.gemini/agents/qa.md +0 -50
- package/.gemini/agents/sm.md +0 -51
- package/.gemini/agents/ux-expert.md +0 -63
- package/.gemini/settings.json +0 -20
- package/.roomodes +0 -139
- package/.vscode/extensions.json +0 -6
- package/.vscode/tasks.json +0 -41
- package/.windsurf/rules/analyst.md +0 -76
- package/.windsurf/rules/architect.md +0 -76
- package/.windsurf/rules/bmad-master.md +0 -113
- package/.windsurf/rules/bmad-orchestrator.md +0 -138
- package/.windsurf/rules/bmad-the-creator.md +0 -65
- package/.windsurf/rules/dev.md +0 -77
- package/.windsurf/rules/game-designer.md +0 -70
- package/.windsurf/rules/game-developer.md +0 -78
- package/.windsurf/rules/game-sm.md +0 -63
- package/.windsurf/rules/infra-devops-platform.md +0 -71
- package/.windsurf/rules/pm.md +0 -73
- package/.windsurf/rules/po.md +0 -75
- package/.windsurf/rules/qa.md +0 -62
- package/.windsurf/rules/sm.md +0 -63
- package/.windsurf/rules/ux-expert.md +0 -75
- package/docs/claude-code-guide.md +0 -121
- package/docs/cursor-guide.md +0 -131
- package/docs/expansion-pack-ideas.md +0 -121
- package/docs/roo-code-guide.md +0 -142
- package/docs/windsurf-guide.md +0 -129
- /package/dist/expansion-packs/{expansion-creator → bmad-creator-tools}/agents/bmad-the-creator.txt +0 -0
package/docs/user-guide.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# BMAD-METHOD User Guide
|
|
1
|
+
# BMAD-METHOD Agentic Agile Driven Development User Guide
|
|
2
2
|
|
|
3
|
-
This comprehensive guide will help you understand and effectively use the
|
|
3
|
+
This comprehensive guide will help you understand and effectively use the BMad Method framework for AI-assisted software development.
|
|
4
4
|
|
|
5
5
|
## Table of Contents
|
|
6
6
|
|
|
@@ -61,6 +61,19 @@ Best for: Cursor, Claude Code, Windsurf, VS Code users
|
|
|
61
61
|
npx bmad-method install
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
+
### CLI Commands
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# List all available agents
|
|
68
|
+
npx bmad-method list
|
|
69
|
+
|
|
70
|
+
# Install or update (automatically detects existing installations)
|
|
71
|
+
npx bmad-method install
|
|
72
|
+
|
|
73
|
+
# Check installation status
|
|
74
|
+
npx bmad-method status
|
|
75
|
+
```
|
|
76
|
+
|
|
64
77
|
### First Steps
|
|
65
78
|
|
|
66
79
|
1. **Choose Your Environment**: Web UI or IDE
|
|
@@ -68,20 +81,47 @@ npx bmad-method install
|
|
|
68
81
|
3. **Initialize Project**: Run `/help` or `*help` to see capabilities
|
|
69
82
|
4. **Start Development**: Begin with planning or jump into coding
|
|
70
83
|
|
|
84
|
+
### Upgrading from V3 to V4
|
|
85
|
+
|
|
86
|
+
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
npx bmad-method install
|
|
90
|
+
# The installer will automatically detect your V3 installation and offer to upgrade
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The upgrade process will:
|
|
94
|
+
|
|
95
|
+
1. Create a backup of your V3 files in `.bmad-v3-backup/`
|
|
96
|
+
2. Install the new V4 `.bmad-core/` structure
|
|
97
|
+
3. Migrate your documents (PRD, Architecture, Stories, Epics)
|
|
98
|
+
4. Set up IDE integration for all V4 agents
|
|
99
|
+
5. Create an install manifest for future updates
|
|
100
|
+
|
|
101
|
+
After upgrading:
|
|
102
|
+
|
|
103
|
+
1. Review your documents in the `docs/` folder - if you had a PRD or architecture in your old project, copy it from the backup to the docs folder if they are not there.
|
|
104
|
+
2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent by saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}'
|
|
105
|
+
3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
|
|
106
|
+
|
|
107
|
+
The reason #2 and #3 are optional is because now BMAD V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration-coreconfigyml)
|
|
108
|
+
|
|
109
|
+
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
|
|
110
|
+
|
|
71
111
|
## Agent System
|
|
72
112
|
|
|
73
113
|
### Core Development Team
|
|
74
114
|
|
|
75
|
-
| Agent | Role | Primary Functions
|
|
76
|
-
| ----------- | ------------------ |
|
|
77
|
-
| `analyst` | Business Analyst | Market research, requirements gathering
|
|
78
|
-
| `pm` | Product Manager | PRD creation, feature prioritization
|
|
79
|
-
| `architect` | Solution Architect | System design, technical architecture
|
|
80
|
-
| `dev` | Developer |
|
|
81
|
-
| `qa` | QA Specialist |
|
|
82
|
-
| `ux-expert` | UX Designer | UI/UX design, prototypes
|
|
83
|
-
| `po` | Product Owner | Backlog management, story validation
|
|
84
|
-
| `sm` | Scrum Master | Sprint planning, story creation
|
|
115
|
+
| Agent | Role | Primary Functions | When to Use |
|
|
116
|
+
| ----------- | ------------------ | ---------------------------------------------- | ------------------------------------------------- |
|
|
117
|
+
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
|
|
118
|
+
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
|
|
119
|
+
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
|
|
120
|
+
| `dev` | Developer | Sequential task execution, testing, validation | Story implementation with test-driven development |
|
|
121
|
+
| `qa` | QA Specialist | Code review, refactoring, test validation | Senior developer review via `review-story` task |
|
|
122
|
+
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
|
|
123
|
+
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
|
|
124
|
+
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
|
|
85
125
|
|
|
86
126
|
### Meta Agents
|
|
87
127
|
|
|
@@ -284,20 +324,29 @@ Once planning is complete and documents are sharded, BMAD follows a structured d
|
|
|
284
324
|
|
|
285
325
|
```mermaid
|
|
286
326
|
graph TD
|
|
287
|
-
A["
|
|
288
|
-
B -->
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
F
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
327
|
+
A["Development Phase Start"] --> B["SM: Reviews Previous Story Dev/QA Notes"]
|
|
328
|
+
B --> B2["SM: Drafts Next Story from Sharded Epic + Architecture"]
|
|
329
|
+
B2 --> C{"User Approval"}
|
|
330
|
+
C -->|Approved| D["Dev: Sequential Task Execution"]
|
|
331
|
+
C -->|Needs Changes| B2
|
|
332
|
+
D --> E["Dev: Implement Tasks + Tests"]
|
|
333
|
+
E --> F["Dev: Run All Validations"]
|
|
334
|
+
F --> G["Dev: Mark Ready for Review + Add Notes"]
|
|
335
|
+
G --> H{"User Verification"}
|
|
336
|
+
H -->|Request QA Review| I["QA: Senior Dev Review + Active Refactoring"]
|
|
337
|
+
H -->|Approve Without QA| K["Mark Story as Done"]
|
|
338
|
+
I --> J["QA: Review, Refactor Code, Add Tests, Document Notes"]
|
|
339
|
+
J --> L{"QA Decision"}
|
|
340
|
+
L -->|Needs Dev Work| D
|
|
341
|
+
L -->|Approved| K
|
|
342
|
+
H -->|Needs Fixes| D
|
|
343
|
+
K --> B
|
|
344
|
+
|
|
345
|
+
style K fill:#34a853,color:#fff
|
|
346
|
+
style I fill:#f9ab00,color:#fff
|
|
347
|
+
style J fill:#ffd54f,color:#000
|
|
348
|
+
style E fill:#e3f2fd,color:#000
|
|
349
|
+
style B fill:#e8f5e9,color:#000
|
|
301
350
|
```
|
|
302
351
|
|
|
303
352
|
### Workflow Phases
|
|
@@ -319,15 +368,213 @@ graph TD
|
|
|
319
368
|
|
|
320
369
|
- **SM**: Draft next story from sharded epic
|
|
321
370
|
- **User**: Review and approve story
|
|
322
|
-
- **Dev**:
|
|
371
|
+
- **Dev**: Sequential task execution:
|
|
372
|
+
- Reads each task in the story
|
|
373
|
+
- Implements code for the task
|
|
374
|
+
- Writes tests alongside implementation
|
|
375
|
+
- Runs validations (linting, tests)
|
|
376
|
+
- Updates task checkbox [x] only if all validations pass
|
|
377
|
+
- Maintains Debug Log for temporary changes
|
|
378
|
+
- Updates File List with all created/modified files
|
|
379
|
+
- **Dev**: After all tasks complete:
|
|
380
|
+
- Runs integration tests (if specified)
|
|
381
|
+
- Runs E2E tests (if specified)
|
|
382
|
+
- Validates Definition of Done checklist
|
|
383
|
+
- Marks story as "Ready for Review"
|
|
323
384
|
- **User**: Verify implementation
|
|
385
|
+
- **Optional QA Review**: User can request QA to run `review-story` task
|
|
324
386
|
- **Repeat**: Until all stories complete
|
|
325
387
|
|
|
326
|
-
####
|
|
388
|
+
#### Dev Agent Workflow Details
|
|
389
|
+
|
|
390
|
+
The Dev agent follows a strict test-driven sequential workflow:
|
|
391
|
+
|
|
392
|
+
**Key Behaviors:**
|
|
393
|
+
|
|
394
|
+
- **Story-Centric**: Works only from the story file, never loads PRD/architecture unless specified in dev notes
|
|
395
|
+
- **Sequential Execution**: Completes tasks one by one, marking [x] only after validations pass
|
|
396
|
+
- **Test-Driven**: Writes tests alongside code for every task
|
|
397
|
+
- **Quality Gates**: Never marks tasks complete if validations fail
|
|
398
|
+
- **Debug Logging**: Tracks temporary changes in the story's Debug Log table
|
|
399
|
+
- **File Tracking**: Maintains complete File List of all created/modified files
|
|
400
|
+
|
|
401
|
+
**Blocking Conditions:**
|
|
402
|
+
The Dev agent will stop and request help if:
|
|
403
|
+
|
|
404
|
+
- Story is not approved
|
|
405
|
+
- Requirements are ambiguous after checking the story
|
|
406
|
+
- Validations fail 3 times for the same task
|
|
407
|
+
- Critical configuration files are missing
|
|
408
|
+
- Automated tests or linting fails
|
|
409
|
+
|
|
410
|
+
#### 4. Quality Assurance Integration
|
|
411
|
+
|
|
412
|
+
The QA agent plays a crucial role after development:
|
|
413
|
+
|
|
414
|
+
- **When Dev marks "Ready for Review"**: Story is ready for user verification
|
|
415
|
+
- **User Options**:
|
|
416
|
+
- **Direct Approval**: If satisfied, mark story as "Done"
|
|
417
|
+
- **Request Changes**: Send back to Dev with specific feedback
|
|
418
|
+
- **Request QA Review**: Ask QA to run the `review-story` task for senior developer review
|
|
419
|
+
- **QA Review Process** (`/qa run review-story`):
|
|
420
|
+
|
|
421
|
+
- Reviews code as a senior developer with authority to refactor
|
|
422
|
+
- **Active Refactoring**: Makes improvements directly in the code
|
|
423
|
+
- **Comprehensive Review Focus**:
|
|
424
|
+
- Code architecture and design patterns
|
|
425
|
+
- Refactoring opportunities and code duplication
|
|
426
|
+
- Performance optimizations and security concerns
|
|
427
|
+
- Best practices and patterns
|
|
428
|
+
- **Standards Compliance**: Verifies adherence to:
|
|
429
|
+
- `docs/coding-standards.md`
|
|
430
|
+
- `docs/unified-project-structure.md`
|
|
431
|
+
- `docs/testing-strategy.md`
|
|
432
|
+
- **Test Coverage Review**: Can add missing tests if critical coverage is lacking
|
|
433
|
+
- **Documentation**: Adds comments for complex logic if missing
|
|
434
|
+
- **Results Documentation** in story's QA Results section:
|
|
435
|
+
- Code quality assessment
|
|
436
|
+
- Refactoring performed with WHY and HOW explanations
|
|
437
|
+
- Compliance check results
|
|
438
|
+
- Improvements checklist (completed vs. pending items)
|
|
439
|
+
- Security and performance findings
|
|
440
|
+
- Final approval status
|
|
441
|
+
|
|
442
|
+
### Understanding the SM/Dev/QA Story Workflow
|
|
443
|
+
|
|
444
|
+
The story file is the central artifact that enables seamless collaboration between the Scrum Master (SM), Developer (Dev), and Quality Assurance (QA) agents. Here's how they work together:
|
|
445
|
+
|
|
446
|
+
#### Why We Have the Scrum Master
|
|
447
|
+
|
|
448
|
+
The SM agent serves as a critical bridge between high-level planning and technical implementation:
|
|
449
|
+
|
|
450
|
+
1. **Document Synthesis**: Reads sharded PRD epics and architecture documents to extract relevant technical details
|
|
451
|
+
2. **Story Enrichment**: Creates self-contained stories with all technical context needed for implementation
|
|
452
|
+
3. **Continuous Learning**: Uses notes from previous stories to improve future story preparation
|
|
453
|
+
4. **Developer Efficiency**: Ensures developers have everything needed without searching multiple documents
|
|
454
|
+
|
|
455
|
+
#### The Story Creation Process
|
|
456
|
+
|
|
457
|
+
When the SM agent executes the `create-next-story` task:
|
|
458
|
+
|
|
459
|
+
1. **Loads Configuration**: Reads `core-config.yml` to understand project structure
|
|
460
|
+
2. **Identifies Next Story**: Sequentially processes stories from epics (1.1, 1.2, 2.1, etc.)
|
|
461
|
+
3. **Gathers Architecture Context**: Reads relevant sharded architecture documents based on story type:
|
|
462
|
+
|
|
463
|
+
- Backend stories: data models, API specs, database schemas
|
|
464
|
+
- Frontend stories: component specs, UI patterns, workflows
|
|
465
|
+
- Full-stack: both backend and frontend documents
|
|
466
|
+
|
|
467
|
+
4. **Reviews Previous Story**: Extracts Dev and QA notes to learn from past implementation
|
|
327
468
|
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
469
|
+
#### The Story Template Structure
|
|
470
|
+
|
|
471
|
+
The story template contains embedded LLM instructions for different agents:
|
|
472
|
+
|
|
473
|
+
**SM Agent Instructions**:
|
|
474
|
+
|
|
475
|
+
- Populate Dev Notes with specific technical details from architecture
|
|
476
|
+
- Include source references for all technical guidance
|
|
477
|
+
- Create detailed tasks based on architecture constraints
|
|
478
|
+
- Add testing requirements from testing strategy
|
|
479
|
+
|
|
480
|
+
**Dev Agent Instructions**:
|
|
481
|
+
|
|
482
|
+
- Update Debug Log References during implementation
|
|
483
|
+
- Document any deviations in Completion Notes
|
|
484
|
+
- Maintain comprehensive File List of all changes
|
|
485
|
+
- Track requirement changes in Change Log
|
|
486
|
+
|
|
487
|
+
**QA Agent Instructions**:
|
|
488
|
+
|
|
489
|
+
- Append review results in QA Results section
|
|
490
|
+
- Document refactoring performed with explanations
|
|
491
|
+
- Note security and performance considerations
|
|
492
|
+
|
|
493
|
+
#### How Agents Pass Information
|
|
494
|
+
|
|
495
|
+
##### SM → Dev Flow
|
|
496
|
+
|
|
497
|
+
The SM prepares the story with:
|
|
498
|
+
|
|
499
|
+
- **Dev Notes**: Specific technical guidance extracted from architecture
|
|
500
|
+
- **Testing Requirements**: Unit, integration, and E2E test specifications
|
|
501
|
+
- **Tasks/Subtasks**: Detailed implementation steps with AC mappings
|
|
502
|
+
|
|
503
|
+
##### Dev → SM Flow
|
|
504
|
+
|
|
505
|
+
The Dev agent provides feedback through:
|
|
506
|
+
|
|
507
|
+
- **Completion Notes**: Deviations or discoveries that impact future stories
|
|
508
|
+
- **Debug Log References**: Technical challenges and solutions
|
|
509
|
+
- **File List**: Complete inventory of created/modified files
|
|
510
|
+
- **Change Log**: Any requirement modifications during development
|
|
511
|
+
|
|
512
|
+
##### QA → SM Flow
|
|
513
|
+
|
|
514
|
+
The QA agent contributes:
|
|
515
|
+
|
|
516
|
+
- **Code Quality Assessment**: Senior developer perspective on implementation quality
|
|
517
|
+
- **Refactoring Performed**: Direct code improvements with:
|
|
518
|
+
- What was changed
|
|
519
|
+
- Why the change was made
|
|
520
|
+
- How it improves the code
|
|
521
|
+
- **Compliance Results**: Verification against coding standards, project structure, and testing strategy
|
|
522
|
+
- **Test Coverage**: Added tests for critical missing coverage
|
|
523
|
+
- **Security Review**: Any security concerns found and whether addressed
|
|
524
|
+
- **Performance Considerations**: Performance issues found and optimizations made
|
|
525
|
+
- **Improvements Checklist**: Items completed (marked [x]) vs. items for Dev to address (marked [ ])
|
|
526
|
+
- **Learning Opportunities**: Explanations for junior/mid-level developer growth
|
|
527
|
+
|
|
528
|
+
#### Example: How Notes Flow Between Stories
|
|
529
|
+
|
|
530
|
+
**Story 1.1 Completion**:
|
|
531
|
+
|
|
532
|
+
```markdown
|
|
533
|
+
### Completion Notes List
|
|
534
|
+
|
|
535
|
+
- Discovered that user authentication requires additional session management not specified in architecture
|
|
536
|
+
- Created new SessionManager service in services/auth/session-manager.ts
|
|
537
|
+
- Recommend updating architecture to include session management patterns
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
**Story 1.2 Creation** (SM uses the above notes):
|
|
541
|
+
|
|
542
|
+
```markdown
|
|
543
|
+
## Dev Notes
|
|
544
|
+
|
|
545
|
+
### Previous Story Insights
|
|
546
|
+
|
|
547
|
+
- Story 1.1 created SessionManager service for auth (services/auth/session-manager.ts)
|
|
548
|
+
- Consider using SessionManager for this story's user profile feature
|
|
549
|
+
- Architecture update pending for session management patterns
|
|
550
|
+
```
|
|
551
|
+
|
|
552
|
+
This continuous feedback loop ensures each story benefits from lessons learned in previous implementations.
|
|
553
|
+
|
|
554
|
+
#### QA Agent Key Principles
|
|
555
|
+
|
|
556
|
+
When the QA agent performs the review-story task:
|
|
557
|
+
|
|
558
|
+
- **Senior Developer Authority**: Reviews as a senior developer with authority to refactor directly
|
|
559
|
+
- **Active Improvement**: Makes code improvements rather than just identifying issues
|
|
560
|
+
- **Teaching Focus**: Explains all changes for developer learning and growth
|
|
561
|
+
- **Pragmatic Balance**: Focuses on significant improvements, not nitpicks
|
|
562
|
+
- **Quality Gates**: Can block story completion if critical issues exist
|
|
563
|
+
|
|
564
|
+
**QA Blocking Conditions**:
|
|
565
|
+
The QA will stop and request clarification if:
|
|
566
|
+
|
|
567
|
+
- Story file is incomplete or missing critical sections
|
|
568
|
+
- File List is empty or clearly incomplete
|
|
569
|
+
- No tests exist when they were required
|
|
570
|
+
- Code changes don't align with story requirements
|
|
571
|
+
- Critical architectural issues require discussion
|
|
572
|
+
|
|
573
|
+
- **Benefits of QA Review**:
|
|
574
|
+
- Code quality improvements and refactoring
|
|
575
|
+
- Knowledge transfer through documented explanations
|
|
576
|
+
- Catching edge cases and security issues
|
|
577
|
+
- Ensuring architectural consistency
|
|
331
578
|
|
|
332
579
|
### Workflow Types
|
|
333
580
|
|
|
@@ -528,7 +775,7 @@ Web UI agents focus on planning and documentation. Here's how to interact with e
|
|
|
528
775
|
|
|
529
776
|
### Dynamic Resource Loading
|
|
530
777
|
|
|
531
|
-
|
|
778
|
+
BMad's dependency system ensures agents only load necessary resources:
|
|
532
779
|
|
|
533
780
|
- **Templates**: Only relevant document templates
|
|
534
781
|
- **Tasks**: Only required automation tasks
|
|
@@ -595,7 +842,7 @@ phases:
|
|
|
595
842
|
|
|
596
843
|
Templates are self-contained documents that embed both output structure and processing instructions. Follow these patterns from existing templates:
|
|
597
844
|
|
|
598
|
-
#### Template Structure
|
|
845
|
+
#### Template Structure Example
|
|
599
846
|
|
|
600
847
|
```markdown
|
|
601
848
|
# {{Project Name}} Document Title
|
|
@@ -1135,7 +1382,7 @@ Add specialized capabilities:
|
|
|
1135
1382
|
- **Data Pack**: Analytics, ML integration
|
|
1136
1383
|
- **Security Pack**: Security analysis, compliance
|
|
1137
1384
|
|
|
1138
|
-
## Troubleshooting
|
|
1385
|
+
## Troubleshooting Guide
|
|
1139
1386
|
|
|
1140
1387
|
### Common Issues
|
|
1141
1388
|
|
|
@@ -1178,7 +1425,7 @@ Add specialized capabilities:
|
|
|
1178
1425
|
- **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/tree/main/docs)
|
|
1179
1426
|
- **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
|
|
1180
1427
|
|
|
1181
|
-
## Best Practices
|
|
1428
|
+
## Best Practices and Tips
|
|
1182
1429
|
|
|
1183
1430
|
### Project Organization
|
|
1184
1431
|
|
|
@@ -1201,7 +1448,7 @@ project/
|
|
|
1201
1448
|
- Version control all BMAD-generated content
|
|
1202
1449
|
- Regular backups of `.bmad-core/` customizations
|
|
1203
1450
|
|
|
1204
|
-
### Development
|
|
1451
|
+
### Recommended Development Flow
|
|
1205
1452
|
|
|
1206
1453
|
#### Planning Phase
|
|
1207
1454
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Automated Releases (Recommended)
|
|
4
4
|
|
|
5
|
-
The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push
|
|
5
|
+
The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push and everything else happens automatically.
|
|
6
6
|
|
|
7
7
|
### Commit Message Format
|
|
8
8
|
|
|
@@ -58,7 +58,7 @@ npm run release:test # Safe to run locally - tests the config
|
|
|
58
58
|
|
|
59
59
|
## Manual Release Methods (Exceptions Only)
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
⚠️ Only use these methods if you need to bypass the automatic system
|
|
62
62
|
|
|
63
63
|
### Quick Manual Version Bump
|
|
64
64
|
|
|
@@ -75,11 +75,3 @@ git push && git push --tags
|
|
|
75
75
|
### Manual GitHub Actions Trigger
|
|
76
76
|
|
|
77
77
|
You can also trigger releases manually through GitHub Actions workflow dispatch if needed.
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## Summary
|
|
82
|
-
|
|
83
|
-
**For 99% of releases**: Just use `fix:` or `feat:` commit messages and push. Everything else is automatic!
|
|
84
|
-
|
|
85
|
-
**Manual methods**: Only needed for special cases or if you want to bypass the automated system.
|
package/docs/versions.md
CHANGED
|
@@ -16,7 +16,6 @@ Guiding Principles of V4:
|
|
|
16
16
|
- Helpers for installers and web builders that will work with any OS and IDE easily
|
|
17
17
|
- Align all agents to be the same for IDE and Web, without losing the power of the web versions, or the leanness of the files in the IDE to reduce context
|
|
18
18
|
- Further improvements to the two most important agents - the SM and DEV
|
|
19
|
-
- Expansion Packs - Coming soon...
|
|
20
19
|
|
|
21
20
|
## V3
|
|
22
21
|
|
|
@@ -1,22 +1,18 @@
|
|
|
1
1
|
# Working in the Brownfield: A Complete Guide
|
|
2
2
|
|
|
3
|
-
> 🚀 **HIGHLY RECOMMENDED: Use Gemini Web for Brownfield Documentation!**
|
|
3
|
+
> 🚀 **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation!**
|
|
4
4
|
>
|
|
5
|
-
> Gemini Web's 1M+ token context window can analyze your ENTIRE codebase at once:
|
|
5
|
+
> Gemini Web's 1M+ token context window or Gemini CLI (when its working) can analyze your ENTIRE codebase at once:
|
|
6
6
|
>
|
|
7
7
|
> - Upload via GitHub URL
|
|
8
8
|
> - Upload up to 1000 files
|
|
9
9
|
> - Upload zipped project
|
|
10
|
-
>
|
|
11
|
-
> This is MUCH more cost-effective than IDE analysis which reads files one by one!
|
|
12
10
|
|
|
13
11
|
## What is Brownfield Development?
|
|
14
12
|
|
|
15
13
|
Brownfield development refers to adding features, fixing bugs, or modernizing existing software projects. Unlike greenfield (new) projects, brownfield work requires understanding existing code, respecting constraints, and ensuring new changes integrate seamlessly without breaking existing functionality.
|
|
16
14
|
|
|
17
|
-
## When to Use
|
|
18
|
-
|
|
19
|
-
BMAD-METHOD excels at brownfield development when you need to:
|
|
15
|
+
## When to Use BMad for Brownfield
|
|
20
16
|
|
|
21
17
|
- Add significant new features to existing applications
|
|
22
18
|
- Modernize legacy codebases
|
|
@@ -29,7 +25,7 @@ BMAD-METHOD excels at brownfield development when you need to:
|
|
|
29
25
|
|
|
30
26
|
### Choose Your Approach
|
|
31
27
|
|
|
32
|
-
#### Approach A: PRD-First (Recommended
|
|
28
|
+
#### Approach A: PRD-First (Recommended if adding very large and complex new features, single or multiple epics or massive changes)
|
|
33
29
|
|
|
34
30
|
**Best for**: Large codebases, monorepos, or when you know exactly what you want to build
|
|
35
31
|
|
package/package.json
CHANGED
|
@@ -40,7 +40,7 @@ try {
|
|
|
40
40
|
|
|
41
41
|
program
|
|
42
42
|
.version(version)
|
|
43
|
-
.description('BMAD Method installer - AI
|
|
43
|
+
.description('BMAD Method installer - Universal AI agent framework for any domain');
|
|
44
44
|
|
|
45
45
|
program
|
|
46
46
|
.command('install')
|
|
@@ -329,7 +329,7 @@ async function promptInstallation() {
|
|
|
329
329
|
type: 'confirm',
|
|
330
330
|
name: 'includeWebBundles',
|
|
331
331
|
message: 'Would you like to include pre-built web bundles? (standalone files for ChatGPT, Claude, Gemini)',
|
|
332
|
-
default:
|
|
332
|
+
default: false
|
|
333
333
|
}
|
|
334
334
|
]);
|
|
335
335
|
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
# /analyst Command
|
|
2
|
-
|
|
3
|
-
When this command is used, adopt the following agent persona:
|
|
4
|
-
|
|
5
|
-
# analyst
|
|
6
|
-
|
|
7
|
-
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
8
|
-
|
|
9
|
-
```yaml
|
|
10
|
-
root: .bmad-core
|
|
11
|
-
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
12
|
-
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
13
|
-
activation-instructions:
|
|
14
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
15
|
-
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
16
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
17
|
-
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
18
|
-
agent:
|
|
19
|
-
name: Mary
|
|
20
|
-
id: analyst
|
|
21
|
-
title: Business Analyst
|
|
22
|
-
icon: 📊
|
|
23
|
-
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, initial project discovery, and documenting existing projects (brownfield)
|
|
24
|
-
customization: null
|
|
25
|
-
persona:
|
|
26
|
-
role: Insightful Analyst & Strategic Ideation Partner
|
|
27
|
-
style: Analytical, inquisitive, creative, facilitative, objective, data-informed
|
|
28
|
-
identity: Strategic analyst specializing in brainstorming, market research, competitive analysis, and project briefing
|
|
29
|
-
focus: Research planning, ideation facilitation, strategic analysis, actionable insights
|
|
30
|
-
core_principles:
|
|
31
|
-
- Curiosity-Driven Inquiry - Ask probing "why" questions to uncover underlying truths
|
|
32
|
-
- Objective & Evidence-Based Analysis - Ground findings in verifiable data and credible sources
|
|
33
|
-
- Strategic Contextualization - Frame all work within broader strategic context
|
|
34
|
-
- Facilitate Clarity & Shared Understanding - Help articulate needs with precision
|
|
35
|
-
- Creative Exploration & Divergent Thinking - Encourage wide range of ideas before narrowing
|
|
36
|
-
- Structured & Methodical Approach - Apply systematic methods for thoroughness
|
|
37
|
-
- Action-Oriented Outputs - Produce clear, actionable deliverables
|
|
38
|
-
- Collaborative Partnership - Engage as a thinking partner with iterative refinement
|
|
39
|
-
- Maintaining a Broad Perspective - Stay aware of market trends and dynamics
|
|
40
|
-
- Integrity of Information - Ensure accurate sourcing and representation
|
|
41
|
-
- Numbered Options Protocol - Always use numbered lists for selections
|
|
42
|
-
startup:
|
|
43
|
-
- Greet the user with your name and role, and inform of the *help command.
|
|
44
|
-
commands: # All commands require * prefix when used (e.g., *help)
|
|
45
|
-
- help: Show numbered list of the following commands to allow selection
|
|
46
|
-
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
|
|
47
|
-
- create-doc {template}: Create doc (no template = show available templates)
|
|
48
|
-
- brainstorm {topic}: Facilitate structured brainstorming session
|
|
49
|
-
- research {topic}: Generate deep research prompt for investigation
|
|
50
|
-
- elicit: Run advanced elicitation to clarify requirements
|
|
51
|
-
- document-project: Analyze and document existing project structure comprehensively
|
|
52
|
-
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
|
53
|
-
dependencies:
|
|
54
|
-
tasks:
|
|
55
|
-
- brainstorming-techniques
|
|
56
|
-
- create-deep-research-prompt
|
|
57
|
-
- create-doc
|
|
58
|
-
- advanced-elicitation
|
|
59
|
-
- document-project
|
|
60
|
-
templates:
|
|
61
|
-
- project-brief-tmpl
|
|
62
|
-
- market-research-tmpl
|
|
63
|
-
- competitor-analysis-tmpl
|
|
64
|
-
data:
|
|
65
|
-
- bmad-kb
|
|
66
|
-
utils:
|
|
67
|
-
- template-format
|
|
68
|
-
```
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
# /architect Command
|
|
2
|
-
|
|
3
|
-
When this command is used, adopt the following agent persona:
|
|
4
|
-
|
|
5
|
-
# architect
|
|
6
|
-
|
|
7
|
-
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
8
|
-
|
|
9
|
-
```yaml
|
|
10
|
-
root: .bmad-core
|
|
11
|
-
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
|
12
|
-
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
|
13
|
-
activation-instructions:
|
|
14
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
15
|
-
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
16
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
17
|
-
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
18
|
-
agent:
|
|
19
|
-
name: Winston
|
|
20
|
-
id: architect
|
|
21
|
-
title: Architect
|
|
22
|
-
icon: 🏗️
|
|
23
|
-
whenToUse: Use for system design, architecture documents, technology selection, API design, and infrastructure planning
|
|
24
|
-
customization: null
|
|
25
|
-
persona:
|
|
26
|
-
role: Holistic System Architect & Full-Stack Technical Leader
|
|
27
|
-
style: Comprehensive, pragmatic, user-centric, technically deep yet accessible
|
|
28
|
-
identity: Master of holistic application design who bridges frontend, backend, infrastructure, and everything in between
|
|
29
|
-
focus: Complete systems architecture, cross-stack optimization, pragmatic technology selection
|
|
30
|
-
core_principles:
|
|
31
|
-
- Holistic System Thinking - View every component as part of a larger system
|
|
32
|
-
- User Experience Drives Architecture - Start with user journeys and work backward
|
|
33
|
-
- Pragmatic Technology Selection - Choose boring technology where possible, exciting where necessary
|
|
34
|
-
- Progressive Complexity - Design systems simple to start but can scale
|
|
35
|
-
- Cross-Stack Performance Focus - Optimize holistically across all layers
|
|
36
|
-
- Developer Experience as First-Class Concern - Enable developer productivity
|
|
37
|
-
- Security at Every Layer - Implement defense in depth
|
|
38
|
-
- Data-Centric Design - Let data requirements drive architecture
|
|
39
|
-
- Cost-Conscious Engineering - Balance technical ideals with financial reality
|
|
40
|
-
- Living Architecture - Design for change and adaptation
|
|
41
|
-
startup:
|
|
42
|
-
- Greet the user with your name and role, and inform of the *help command.
|
|
43
|
-
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
|
|
44
|
-
commands: # All commands require * prefix when used (e.g., *help)
|
|
45
|
-
- help: Show numbered list of the following commands to allow selection
|
|
46
|
-
- chat-mode: (Default) Architect consultation with advanced-elicitation for complex system design
|
|
47
|
-
- create-doc {template}: Create doc (no template = show available templates)
|
|
48
|
-
- execute-checklist {checklist}: Run architectural validation checklist
|
|
49
|
-
- research {topic}: Generate deep research prompt for architectural decisions
|
|
50
|
-
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
|
|
51
|
-
dependencies:
|
|
52
|
-
tasks:
|
|
53
|
-
- create-doc
|
|
54
|
-
- create-deep-research-prompt
|
|
55
|
-
- document-project
|
|
56
|
-
- execute-checklist
|
|
57
|
-
templates:
|
|
58
|
-
- architecture-tmpl
|
|
59
|
-
- front-end-architecture-tmpl
|
|
60
|
-
- fullstack-architecture-tmpl
|
|
61
|
-
- brownfield-architecture-tmpl
|
|
62
|
-
checklists:
|
|
63
|
-
- architect-checklist
|
|
64
|
-
data:
|
|
65
|
-
- technical-preferences
|
|
66
|
-
utils:
|
|
67
|
-
- template-format
|
|
68
|
-
```
|