bmad-method 4.24.3 → 4.24.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/.prettierignore +1 -1
  2. package/CHANGELOG.md +8 -1
  3. package/README.md +22 -22
  4. package/bmad-core/agents/bmad-master.md +5 -5
  5. package/bmad-core/agents/bmad-orchestrator.md +9 -9
  6. package/bmad-core/checklists/change-checklist.md +2 -2
  7. package/bmad-core/data/bmad-kb.md +18 -18
  8. package/bmad-core/tasks/create-brownfield-story.md +2 -2
  9. package/bmad-core/tasks/create-next-story.md +2 -2
  10. package/bmad-core/tasks/kb-mode-interaction.md +13 -13
  11. package/common/utils/template-format.md +1 -1
  12. package/common/utils/workflow-management.md +1 -1
  13. package/dist/agents/analyst.txt +21 -21
  14. package/dist/agents/architect.txt +3 -3
  15. package/dist/agents/bmad-master.txt +31 -31
  16. package/dist/agents/bmad-orchestrator.txt +44 -44
  17. package/dist/agents/dev.txt +2 -2
  18. package/dist/agents/pm.txt +5 -5
  19. package/dist/agents/po.txt +5 -5
  20. package/dist/agents/qa.txt +3 -3
  21. package/dist/agents/sm.txt +5 -5
  22. package/dist/agents/ux-expert.txt +3 -3
  23. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2 -2
  24. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +2 -2
  25. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +2 -2
  26. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +29 -29
  27. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +21 -21
  28. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +14 -14
  29. package/dist/teams/team-all.txt +48 -48
  30. package/dist/teams/team-fullstack.txt +46 -46
  31. package/dist/teams/team-ide-minimal.txt +48 -48
  32. package/dist/teams/team-no-ui.txt +46 -46
  33. package/docs/agentic-tools/claude-code-guide.md +5 -22
  34. package/docs/agentic-tools/cline-guide.md +3 -29
  35. package/docs/agentic-tools/cursor-guide.md +4 -27
  36. package/docs/agentic-tools/gemini-cli-guide.md +3 -17
  37. package/docs/agentic-tools/github-copilot-guide.md +22 -0
  38. package/docs/agentic-tools/roo-code-guide.md +2 -35
  39. package/docs/agentic-tools/windsurf-guide.md +3 -28
  40. package/docs/bmad-workflow-guide.md +8 -8
  41. package/docs/core-architecture.md +19 -184
  42. package/docs/expansion-packs.md +4 -4
  43. package/docs/how-to-contribute-with-pull-requests.md +1 -1
  44. package/docs/user-guide.md +29 -414
  45. package/docs/versions.md +4 -4
  46. package/docs/working-in-the-brownfield.md +9 -6
  47. package/expansion-packs/README.md +2 -2
  48. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  49. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +3 -3
  50. package/expansion-packs/bmad-creator-tools/README.md +2 -2
  51. package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +8 -8
  52. package/expansion-packs/bmad-creator-tools/config.yaml +2 -2
  53. package/expansion-packs/bmad-creator-tools/tasks/create-agent.md +1 -1
  54. package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +9 -9
  55. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +1 -1
  56. package/expansion-packs/bmad-infrastructure-devops/README.md +6 -6
  57. package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +1 -1
  58. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  59. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +4 -4
  60. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +4 -4
  61. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +2 -2
  62. package/package.json +1 -1
  63. package/tools/bmad-npx-wrapper.js +1 -1
  64. package/tools/builders/web-builder.js +1 -1
  65. package/tools/cli.js +2 -2
  66. package/tools/installer/README.md +1 -51
  67. package/tools/installer/bin/bmad.js +9 -9
  68. package/tools/installer/config/install.config.yaml +10 -10
  69. package/tools/installer/lib/config-loader.js +2 -2
  70. package/tools/installer/lib/ide-setup.js +9 -9
  71. package/tools/installer/lib/installer.js +17 -17
  72. package/tools/installer/package.json +3 -3
  73. package/tools/md-assets/web-agent-startup-instructions.md +2 -2
  74. package/tools/upgraders/v3-to-v4-upgrader.js +2 -2
  75. package/tools/version-bump.js +1 -1
  76. package/tools/yaml-format.js +1 -1
  77. package/docs/agentic-tools/vs-code-copilot-guide.md +0 -53
  78. package/tools/installer/templates/claude-commands.md +0 -7
  79. package/tools/installer/templates/cursor-rules.md +0 -22
  80. package/tools/installer/templates/windsurf-rules.md +0 -22
@@ -1,26 +1,23 @@
1
- # BMAD-METHOD Agentic Agile Driven Development 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 BMad Method framework for AI-assisted software development.
3
+ This comprehensive guide will help you understand and effectively use the BMad Method framework for AI-assisted software development along with many expansion purposes.
4
4
 
5
5
  ## Table of Contents
6
6
 
7
- 1. [Understanding BMAD](#understanding-bmad)
7
+ 1. [Understanding BMad](#understanding-bmad)
8
8
  2. [Getting Started](#getting-started)
9
9
  3. [Agent System](#agent-system)
10
10
  4. [Templates and Document Creation](#templates-and-document-creation)
11
11
  5. [Development Workflow](#development-workflow)
12
- 6. [Team Configurations](#team-configurations)
13
- 7. [IDE Integration](#ide-integration)
14
- 8. [Web UI Usage](#web-ui-usage)
15
- 9. [Advanced Features](#advanced-features)
16
- 10. [Troubleshooting](#troubleshooting)
17
- 11. [Best Practices](#best-practices)
12
+ 6. [IDE Integration](#ide-integration)
13
+ 7. [Web UI Usage](#web-ui-usage)
14
+ 8. [Advanced Features](#advanced-features)
18
15
 
19
- ## Understanding BMAD
16
+ ## Understanding BMad
20
17
 
21
- ### What is BMAD-METHOD?
18
+ ### What is BMad-Method?
22
19
 
23
- BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent orchestration framework that provides specialized AI agents for every role in a complete Agile development team. Unlike generic AI assistants, each BMAD agent has deep expertise in their specific domain and can collaborate to deliver complete software projects.
20
+ BMad-Method (Breakthrough Method of Agile AI-Driven Development) is an AI agent orchestration framework that provides specialized AI agents for every role in a complete Agile development team. Unlike generic AI assistants, each BMad agent has deep expertise in their specific domain and can collaborate with you using advanced elicitation techniques, and guided workflows
24
21
 
25
22
  ### Core Principles
26
23
 
@@ -28,9 +25,9 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
28
25
  2. **True Agile Workflow**: Follows real Agile methodologies with proper story management
29
26
  3. **Self-Contained Templates**: Documents embed both output and processing instructions
30
27
  4. **Dynamic Dependencies**: Agents only load resources they need
31
- 5. **Platform Agnostic**: Works with any AI platform or IDE
28
+ 5. **Platform Agnostic**: Works with any Project Type or Agentic IDE
32
29
 
33
- ### When to Use BMAD
30
+ ### When to Use BMad
34
31
 
35
32
  - **New Projects (Greenfield)**: Complete end-to-end development
36
33
  - **Existing Projects (Brownfield)**: Feature additions and enhancements
@@ -44,7 +41,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
44
41
 
45
42
  #### Option 1: Web UI (Fastest - 2 minutes)
46
43
 
47
- Best for: ChatGPT, Claude, Gemini users
44
+ If you want to do the planning int he Web:
48
45
 
49
46
  1. Navigate to `dist/teams/`
50
47
  2. Copy `team-fullstack.txt` content
@@ -54,8 +51,6 @@ Best for: ChatGPT, Claude, Gemini users
54
51
 
55
52
  #### Option 2: IDE Integration (5 minutes)
56
53
 
57
- Best for: Cursor, Claude Code, Windsurf, VS Code users
58
-
59
54
  ```bash
60
55
  # Interactive installation (recommended)
61
56
  npx bmad-method install
@@ -74,40 +69,6 @@ npx bmad-method install
74
69
  npx bmad-method status
75
70
  ```
76
71
 
77
- ### First Steps
78
-
79
- 1. **Choose Your Environment**: Web UI or IDE
80
- 2. **Select Agent/Team**: Individual agent or full team
81
- 3. **Initialize Project**: Run `/help` or `*help` to see capabilities
82
- 4. **Start Development**: Begin with planning or jump into coding
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)
108
-
109
- **Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
110
-
111
72
  ## Agent System
112
73
 
113
74
  ### Core Development Team
@@ -181,7 +142,7 @@ dependencies:
181
142
 
182
143
  ### Understanding Templates
183
144
 
184
- BMAD templates are **self-contained and interactive** - they embed both the desired document output and the LLM instructions needed to work with users. This means no separate task is needed for most document creation.
145
+ BMad templates are **self-contained and interactive** - they embed both the desired document output and the LLM instructions needed to work with users. This means no separate task is needed for most document creation.
185
146
 
186
147
  #### Template Structure
187
148
 
@@ -233,8 +194,8 @@ Templates follow the `template-format.md` specification:
233
194
  For cost efficiency, especially with Gemini:
234
195
 
235
196
  1. **Create Large Documents in Web UI**: Use web bundles for PRD and architecture creation
236
- 2. **Copy to Project**: Save the final markdown output to your project's `docs/` folder
237
- 3. **Standard Naming**: Use `prd.md` and `architecture.md` for consistency
197
+ 2. **Copy to Project**: Save the final markdown output to your project's `docs/` folder (use the ... menu)
198
+ 3. **Standard Naming**: Use `prd.md` and `architecture.md` for consistent file name
238
199
  4. **Continue in IDE**: Use IDE agents for development tasks and smaller documents
239
200
 
240
201
  #### File Naming Conventions
@@ -283,7 +244,7 @@ This provides 10 structured brainstorming actions:
283
244
 
284
245
  ### The Planning Workflow (Web UI)
285
246
 
286
- Before development begins, BMAD follows a structured planning workflow that's ideally done in web UI for cost efficiency:
247
+ Before development begins, BMad follows a structured planning workflow that's ideally done in web UI for cost efficiency:
287
248
 
288
249
  ```mermaid
289
250
  graph TD
@@ -320,7 +281,7 @@ graph TD
320
281
 
321
282
  ### The Core Development Cycle (IDE)
322
283
 
323
- Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
284
+ Once planning is complete and documents are sharded, BMad follows a structured development workflow:
324
285
 
325
286
  ```mermaid
326
287
  graph TD
@@ -468,27 +429,7 @@ When the SM agent executes the `create-next-story` task:
468
429
 
469
430
  #### The Story Template Structure
470
431
 
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
432
+ The story template contains embedded LLM instructions for the SM Dev and QA Agent.
492
433
 
493
434
  #### How Agents Pass Information
494
435
 
@@ -525,57 +466,6 @@ The QA agent contributes:
525
466
  - **Improvements Checklist**: Items completed (marked [x]) vs. items for Dev to address (marked [ ])
526
467
  - **Learning Opportunities**: Explanations for junior/mid-level developer growth
527
468
 
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
578
-
579
469
  ### Workflow Types
580
470
 
581
471
  #### Greenfield Development
@@ -598,85 +488,11 @@ For existing projects:
598
488
  4. Incremental development
599
489
  5. Integration testing
600
490
 
601
- ## Team Configurations
602
-
603
- ### Pre-Built Teams
604
-
605
- #### Team All
606
-
607
- - **Includes**: All 10 agents + orchestrator
608
- - **Use Case**: Complete projects requiring all roles
609
- - **Bundle**: `team-all.txt`
610
-
611
- #### Team Fullstack
612
-
613
- - **Includes**: PM, Architect, Developer, QA, UX Expert
614
- - **Use Case**: End-to-end web/mobile development
615
- - **Bundle**: `team-fullstack.txt`
616
-
617
- #### Team No-UI
618
-
619
- - **Includes**: PM, Architect, Developer, QA (no UX Expert)
620
- - **Use Case**: Backend services, APIs, system development
621
- - **Bundle**: `team-no-ui.txt`
622
-
623
- ### Custom Team Configuration
624
-
625
- Create custom teams by modifying `.bmad-core/agent-teams/`:
626
-
627
- ```yaml
628
- name: Custom Development Team
629
- description: Specialized team for specific needs
630
- agents:
631
- - pm
632
- - architect
633
- - dev
634
- - qa
635
- workflows:
636
- - greenfield-fullstack
637
- ```
638
-
639
491
  ## IDE Integration
640
492
 
641
- ### Supported IDEs
642
-
643
- #### Cursor IDE
644
-
645
- - **Commands**: `@agent-name task` (manual rules)
646
- - **Example**: `@pm Create a PRD for user management`
647
- - **Features**: Inline suggestions, context awareness
648
- - **Integration**: Agents loaded as manual rules
649
-
650
- #### Claude Code
651
-
652
- - **Commands**: `/agent-name task` (command files)
653
- - **Example**: `/architect Design microservices architecture`
654
- - **Features**: File integration, project context
655
- - **Integration**: Agents installed as files in commands folder
656
-
657
- #### Windsurf
658
-
659
- - **Commands**: `@agent-name task` (manual rules)
660
- - **Example**: `@dev Implement authentication`
661
- - **Features**: Multi-file editing, project awareness
662
- - **Integration**: Agents loaded as manual rules
663
-
664
- #### VS Code (Generic)
665
-
666
- - **Setup**: Manual installation
667
- - **Usage**: Copy agent content to chat
668
- - **Features**: Basic integration
669
-
670
- ### IDE Setup Process
671
-
672
- 1. **Install CLI**: `npx bmad-method install`
673
- 2. **Select IDE**: Choose during installation
674
- 3. **Configure Integration**: Automatic setup for supported IDEs
675
- 4. **Verify Installation**: Test with `@agent-name help`
676
-
677
493
  ### IDE Best Practices
678
494
 
679
- - **Context Management**: Keep relevant files open
495
+ - **Context Management**: Keep relevant files only in context, keep files as lean and focused as necessary
680
496
  - **Agent Selection**: Use appropriate agent for task
681
497
  - **Iterative Development**: Work in small, focused tasks
682
498
  - **File Organization**: Maintain clean project structure
@@ -685,92 +501,14 @@ workflows:
685
501
 
686
502
  **Important**: Web UI is primarily designed for planning and documentation phases, not development. Use IDE integration for coding tasks.
687
503
 
688
- ### Platform Setup
689
-
690
- #### ChatGPT Custom GPT
691
-
692
- 1. Create new Custom GPT
693
- 2. Upload team bundle as knowledge
694
- 3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
695
- 4. Configure capabilities as needed
696
-
697
- #### Claude Projects
698
-
699
- 1. Create new project
700
- 2. Add team bundle to project knowledge
701
- 3. Set project instructions with agent behavior
702
- 4. Start conversation with `/help`
703
-
704
- #### Gemini Gems
705
-
706
- 1. Create new Gem
707
- 2. Upload bundle as instruction file
708
- 3. Set system instructions for agent behavior
709
- 4. Initialize with `/help` command
710
-
711
504
  ### Web UI Commands
712
505
 
713
- #### Universal Commands
714
-
715
- - `/help` - Show available commands
716
- - `/status` - Current agent status
717
- - `/switch agent-name` - Change active agent (if orchestrator available)
718
-
719
- #### Document Commands
720
-
721
- - `/create-doc type` - Create document of specified type
722
- - `/review-doc` - Review current document
723
- - `/refine-doc` - Improve document quality
724
-
725
- #### Planning Commands
726
-
727
- - `/pm create-doc prd` - Create Product Requirements Document
728
- - `/architect create-doc architecture` - Create system architecture
729
- - `/analyst create-doc project-brief` - Create project brief
730
- - `/po run-checklist` - Validate document alignment
506
+ type #help when in the Gem or Custom GPT with one of the teams, and the BMad-Orchestrator will give you an up to date list of commands.
731
507
 
732
508
  ### Web UI Agent Interaction
733
509
 
734
510
  Web UI agents focus on planning and documentation. Here's how to interact with each:
735
511
 
736
- #### Agent Switching and Conversation
737
-
738
- - **Switch Agents**: Use `/pm`, `/architect`, `/analyst`, `/po` to switch between roles
739
- - **Agent Consultation**: Each agent offers their specialized options and capabilities
740
- - **Natural Conversation**: Agents guide you through their processes with questions and suggestions
741
-
742
- #### Planning Phase Agents
743
-
744
- - **Analyst**: `/analyst` - Brainstorming, market research, competitive analysis
745
- - **PM**: `/pm` - Product requirements, feature definition, roadmaps
746
- - **Architect**: `/architect` - System design, technical architecture
747
- - **PO**: `/po` - Document validation, epic management, story alignment
748
-
749
- ### Web UI Best Practices
750
-
751
- - **Clear Instructions**: Be specific about requirements
752
- - **Context Sharing**: Provide relevant background
753
- - **Iterative Refinement**: Use built-in elicitation features
754
- - **Document Management**: Keep generated docs organized
755
- - **Stay in Planning**: Use web UI for documentation, switch to IDE for development
756
-
757
- #### Cost-Effective Document Creation
758
-
759
- **Recommended Workflow for Large Documents:**
760
-
761
- 1. **Use Web UI for PRD and Architecture**: These are token-heavy documents, especially in Gemini
762
- 2. **Copy Final Output**: Save complete markdown to your project
763
- 3. **Standard File Names**:
764
- - Save PRD as `docs/prd.md`
765
- - Save Architecture as `docs/architecture.md`
766
- 4. **IDE for Development**: Switch to IDE agents for implementation tasks
767
-
768
- **Why This Saves Money:**
769
-
770
- - Web UI pricing is typically more cost-effective for large context windows
771
- - PRD and architecture creation involves extensive back-and-forth refinement
772
- - IDE token costs can accumulate quickly with large document generation
773
-
774
512
  ## Advanced Features
775
513
 
776
514
  ### Dynamic Resource Loading
@@ -784,7 +522,7 @@ BMad's dependency system ensures agents only load necessary resources:
784
522
 
785
523
  ### Custom Templates
786
524
 
787
- Create custom templates following `template-format.md`:
525
+ Create custom templates following `utils/template-format.md`:
788
526
 
789
527
  ```markdown
790
528
  ---
@@ -1039,7 +777,7 @@ Agents can reference and load documents from the `docs/` folder:
1039
777
 
1040
778
  ### Technical Preferences System
1041
779
 
1042
- BMAD includes a powerful personalization system through the `technical-preferences.md` file located in `.bmad-core/data/`.
780
+ BMad includes a powerful personalization system through the `technical-preferences.md` file located in `.bmad-core/data/`.
1043
781
 
1044
782
  #### What is technical-preferences.md?
1045
783
 
@@ -1133,11 +871,11 @@ When creating custom web bundles or uploading to AI platforms, include your `tec
1133
871
 
1134
872
  ### Core Configuration
1135
873
 
1136
- The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
874
+ The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
1137
875
 
1138
876
  #### Understanding core-config.yaml
1139
877
 
1140
- 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's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
878
+ 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's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
1141
879
 
1142
880
  #### Configuration Structure
1143
881
 
@@ -1347,7 +1085,7 @@ customTechnicalDocuments:
1347
1085
 
1348
1086
  #### Best Practices
1349
1087
 
1350
- 1. **Always Configure for Your Structure**: Don't force your project to match BMAD defaults
1088
+ 1. **Always Configure for Your Structure**: Don't force your project to match BMad defaults
1351
1089
  2. **Keep devLoadAlwaysFiles Focused**: Only include files needed for every dev task
1352
1090
  3. **Use Debug Log**: Enable when troubleshooting story implementation issues
1353
1091
  4. **Version Control core-config.yaml**: Track changes to understand project evolution
@@ -1384,135 +1122,16 @@ Add specialized capabilities:
1384
1122
 
1385
1123
  ## Troubleshooting Guide
1386
1124
 
1387
- ### Common Issues
1388
-
1389
- #### Agent Not Responding
1390
-
1391
- - **Cause**: Incorrect agent name or command
1392
- - **Solution**: Check available agents with `/help`
1393
- - **Prevention**: Use tab completion in supported IDEs
1394
-
1395
- #### Template Errors
1396
-
1397
- - **Cause**: Malformed template syntax
1398
- - **Solution**: Validate against `template-format.md`
1399
- - **Prevention**: Use provided templates as starting point
1400
-
1401
- #### Context Overload
1402
-
1403
- - **Cause**: Too many dependencies loaded
1404
- - **Solution**: Use specific agents instead of `bmad-master`
1405
- - **Prevention**: Choose appropriate team size
1406
-
1407
- #### Installation Issues
1408
-
1409
- - **Cause**: Node.js version, permissions
1410
- - **Solution**: Update Node.js, check permissions
1411
- - **Prevention**: Use recommended Node.js version (14+)
1412
-
1413
- ### Debugging Steps
1125
+ ## Getting Help
1414
1126
 
1415
- 1. **Check Installation**: `npx bmad-method status`
1416
- 2. **Verify Agent**: Test with simple command
1417
- 3. **Review Dependencies**: Ensure required files exist
1418
- 4. **Clear Cache**: Restart IDE/browser
1419
- 5. **Reinstall**: `npx bmad-method install --force`
1420
-
1421
- ### Getting Help
1422
-
1423
- - **Discord Community**: [Join Discord](https://discord.gg/g6ypHytrCB)
1127
+ - **Discord Community**: [Join Discord](https://discord.gg/gk8jAdXWmj)
1424
1128
  - **GitHub Issues**: [Report bugs](https://github.com/bmadcode/bmad-method/issues)
1425
1129
  - **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/tree/main/docs)
1426
1130
  - **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
1427
1131
 
1428
- ## Best Practices and Tips
1429
-
1430
- ### Project Organization
1431
-
1432
- #### Folder Structure
1433
-
1434
- ```text
1435
- project/
1436
- ├── .bmad-core/ # BMAD agents and resources
1437
- ├── docs/ # Generated documentation
1438
- │ ├── prd.md
1439
- │ ├── architecture.md
1440
- │ └── stories/
1441
- ├── src/ # Source code
1442
- └── tests/ # Test files
1443
- ```
1444
-
1445
- #### Document Management
1446
-
1447
- - Keep generated docs in `docs/` folder
1448
- - Version control all BMAD-generated content
1449
- - Regular backups of `.bmad-core/` customizations
1450
-
1451
- ### Recommended Development Flow
1452
-
1453
- #### Planning Phase
1454
-
1455
- 1. **Start with Analysis**: Use analyst for market research
1456
- 2. **Create PRD**: PM agent for comprehensive requirements
1457
- 3. **Design Architecture**: Architect for technical foundation
1458
- 4. **Plan UX**: UX Expert for user experience
1459
-
1460
- #### Development Phase
1461
-
1462
- 1. **Shard Work**: PO to break down epics
1463
- 2. **Story Development**: SM for manageable tasks
1464
- 3. **Implementation**: Dev for coding
1465
- 4. **Quality Assurance**: QA for testing
1466
-
1467
- #### Review Process
1468
-
1469
- 1. **Code Review**: Dev agent for code quality
1470
- 2. **Functional Testing**: QA for feature validation
1471
- 3. **User Acceptance**: PO for business requirements
1472
- 4. **Documentation**: Update docs as needed
1473
-
1474
- ### Quality Assurance
1475
-
1476
- #### Code Quality
1477
-
1478
- - Use dev agent for code reviews
1479
- - Implement suggested improvements
1480
- - Follow established coding standards
1481
- - Regular refactoring sessions
1482
-
1483
- #### Documentation Standards
1484
-
1485
- - Keep docs updated with changes
1486
- - Use templates for consistency
1487
- - Regular doc reviews with PO
1488
- - Clear, actionable user stories
1489
-
1490
- #### Process Quality
1491
-
1492
- - Follow Agile ceremonies
1493
- - Regular retrospectives
1494
- - Continuous improvement
1495
- - Stakeholder feedback integration
1496
-
1497
- ### Performance Optimization
1498
-
1499
- #### Context Management
1500
-
1501
- - Use specific agents vs. bmad-master
1502
- - Minimal team configurations
1503
- - Regular dependency cleanup
1504
- - Archive completed projects
1505
-
1506
- #### Resource Efficiency
1507
-
1508
- - Appropriate bundle sizes
1509
- - Selective agent usage
1510
- - Efficient template design
1511
- - Regular cache clearing
1512
-
1513
1132
  ## Conclusion
1514
1133
 
1515
- BMAD-METHOD provides a comprehensive framework for AI-assisted software development. By following this guide, you'll be able to:
1134
+ BMad-Method provides a comprehensive framework for AI-assisted software development. By following this guide, you'll be able to:
1516
1135
 
1517
1136
  - Effectively use specialized AI agents
1518
1137
  - Create professional documentation
@@ -1520,8 +1139,4 @@ BMAD-METHOD provides a comprehensive framework for AI-assisted software developm
1520
1139
  - Integrate with your preferred tools
1521
1140
  - Maintain high quality standards
1522
1141
 
1523
- Remember: BMAD is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
1524
-
1525
- ---
1526
-
1527
- For additional support, join our [Discord community](https://discord.gg/g6ypHytrCB) or check out the [YouTube channel](https://www.youtube.com/@BMadCode) for video tutorials and walkthroughs.
1142
+ Remember: BMad is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
package/docs/versions.md CHANGED
@@ -2,9 +2,9 @@
2
2
 
3
3
  ## Previous Versions
4
4
 
5
- - [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3)
6
- - [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2)
7
- - [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1)
5
+ - [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3)
6
+ - [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2)
7
+ - [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1)
8
8
 
9
9
  ## Current Version: V4 - Alpha
10
10
 
@@ -25,7 +25,7 @@ V3 didn't fix the disconnect, but it did make it easier to maintain them all in
25
25
 
26
26
  V3's biggest impact was a full explosion of customizability. Tasks, Personas, Agent Configurations, Doc Templates, data payloads.
27
27
 
28
- BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMAD AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
28
+ BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMad AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
29
29
 
30
30
  Now, instead of configuring 4+ web agents, all needing many files uploaded to create them, a single Agent called BMad, with a whole team, and the ability to switch and maintain personas evolved. Now you could in the same chat thread, talk to the whole team, or anyone on the team. No more exporting and reimporting docs to different chats - all of the sudden, you could finish the PRD, and ask Josh to pass it off to the Architect, and that was it, the architect just had it and we moved on! And all of that with just 7 total files to upload, delivering all power.
31
31
 
@@ -1,12 +1,11 @@
1
1
  # Working in the Brownfield: A Complete Guide
2
2
 
3
- > 🚀 **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation!**
3
+ > **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation Generation!**
4
4
  >
5
- > Gemini Web's 1M+ token context window or Gemini CLI (when its working) 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 or critical sections of it all at once (obviously within reason):
6
6
  >
7
- > - Upload via GitHub URL
8
- > - Upload up to 1000 files
9
- > - Upload zipped project
7
+ > - Upload via GitHub URL or use gemini cli in the project folder
8
+ > - If in the web: Upload up to 1000 files or the zipped project or just give it the github url
10
9
 
11
10
  ## What is Brownfield Development?
12
11
 
@@ -21,6 +20,10 @@ Brownfield development refers to adding features, fixing bugs, or modernizing ex
21
20
  - Fix bugs that require architectural understanding
22
21
  - Document undocumented systems
23
22
 
23
+ ## When NOT to use a Brownfield Flow
24
+
25
+ If you have just completed an MVP with BMad, and you want to continue with post-MVP, its easier to just talk to the PM and ask him to work with you to create a new epic to add into the PRD, shard out the epic, update any architecture documents with the architect, and just go from there.
26
+
24
27
  ## The Complete Brownfield Workflow
25
28
 
26
29
  ### Choose Your Approach
@@ -353,6 +356,6 @@ Is this a major enhancement affecting multiple systems?
353
356
 
354
357
  ## Conclusion
355
358
 
356
- Brownfield development with BMAD-METHOD provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
359
+ Brownfield development with BMad-Method provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
357
360
 
358
361
  Remember: **Document First, Plan Carefully, Integrate Safely**
@@ -1,3 +1,3 @@
1
- # BMAD Method Expansion Packs
1
+ # BMad Method Expansion Packs
2
2
 
3
- Expansion packs extend BMAD-METHOD beyond traditional software development, providing specialized agent teams, templates, and workflows for specific domains and industries. Each pack is a self-contained ecosystem designed to bring the power of AI-assisted workflows to any field. Coming soon.
3
+ Expansion packs extend BMad-Method beyond traditional software development, providing specialized agent teams, templates, and workflows for specific domains and industries. Each pack is a self-contained ecosystem designed to bring the power of AI-assisted workflows to any field. Coming soon.
@@ -2,6 +2,6 @@ name: bmad-2d-phaser-game-dev
2
2
  version: 1.3.0
3
3
  short-title: 2D game development with Phaser 3 & TypeScript
4
4
  description: >-
5
- 2D Game Development expansion pack for BMAD Method - Phaser 3 & TypeScript
5
+ 2D Game Development expansion pack for BMad Method - Phaser 3 & TypeScript
6
6
  focused
7
7
  author: Brian (BMad)