ros/BMAD-METHOD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs updated

Browse Source
This commit is contained in:
Brian Madison
2025-06-08 02:30:28 -05:00
parent 219198f05b
commit b22255762d
3 changed files with 27 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,4 +1,30 @@
# The BMAD-Method V4.0 (Breakthrough Method of AgileAI Driven Development)
# The BMAD-Method V4 (Breakthrough Method of AgileAI Driven Development)
## Getting Started
### For Web (Gem/Custom GPT)
1. Install Node.js
2. Run `npm run build` to produce the web output
3. Choose from the `dist/` folder:
- **Team bundles**: Fully self-contained files with multiple agents
- **Individual persona bundles**: Single agent files
- You only select 1 file for 1 Gem/GPT - either a team or individual.
- All Teams include the BMad Agent.
NOTE: BMad Agent KB has not been updated for V4 yet - so its knowledge is not ideal yet.
#### Setting up your Gem/Custom GPT
- **For team builds**: Set the description to: "You are the BMAD Agent. Follow the orchestrator's operating instructions and persona immediately."
- **For individual builds**: Set the description to: "You are the [Agent Name]. Follow the persona instructions immediately."
- Configuration for all of these are now done in the root agents folder. You can easily build various team bundles to include only the agents you want or need!
### For IDE
Copy the entire `bmad-core/` folder to your project root to get started. The `bmad-core/ide-agents` includes all of the individual agents.
SPECIAL CURSOR, WINDSURF, VSCode and CLAUDE_CODE note (or any ide for that matter): Rules and commands are the key to being able to easily use and switch between agents in the IDE now! You can see examples for cursor, and claude already, by looking in the .cursor or .claude/commands folder. Set up slash commands as these show and you will be able to use endless custom agents regardless of your choice of IDE or agentic coding partner!
## Old Versions

19
docs/recommended-ide-plugins.md
View File

@@ -1,19 +0,0 @@
# Recommended plugins for VSCode/Windsurf/Cursor
These are plugins that I use (mostly as a typescript developer) but not exhaustive:
- Cline
- Code Spell Checker
- CodeMetrics
- Docker
- ESLint
- Foam (video about this one soon)
- Jest Runner (firstris)
- Markdown Preview Mermaid Support
- Monokai Charcoal high contrast (love these themes!)
- Playwright Test for VSCode (if using Playwright for e2e)
- Prettier - Code formatter
- Prettier - ESLint
- SQLite
I also use plugins when using GoLang, Python, and C#

83
docs/workflow-diagram.md
View File

@@ -1,83 +0,0 @@
```mermaid
flowchart TD
%% Phase 0: BA
subgraph BA["Phase 0: Business Analyst"]
BA_B["Mode 1: Brainstorming"]
BA_R["Mode 2: Deep Research"]
BA_P["Mode 3: Project Briefing"]
BA_B --> BA_P
BA_R --> BA_P
end
%% Phase 1: PM
subgraph PM["Phase 1: Product Manager"]
PM_D["Mode 2: Deep Research"]
PM_M["Mode 1: Initial Product Def."]
PM_C["PM Checklist Verification"]
PM_PRD["PRD Complete"]
PM_D --> PM_M
PM_M --> PM_C
PM_C --> PM_PRD
end
%% Phase 2: Architect
subgraph ARCH["Phase 2: Architect"]
ARCH_P["Architecture Package Creation"]
ARCH_C["Architect Checklist Verification"]
ARCH_D["PRD+Architecture and Artifacts"]
ARCH_P --> ARCH_C
ARCH_C --> ARCH_D
end
%% Phase 3: PO
subgraph PO["Phase 3: Product Owner"]
PO_C["PO Checklist Verification"]
PO_A["Approval"]
end
%% Phase 4: SM
subgraph SM["Phase 4: Scrum Master"]
SM_S["Draft Next Story"]
SM_A["User Story Approval"]
end
%% Phase 5: Developer
subgraph DEV["Phase 5: Developer"]
DEV_I["Implement Story"]
DEV_T["Test"]
DEV_D["Deploy"]
DEV_A["User Approval"]
DEV_I --> DEV_T
DEV_T --> DEV_D
DEV_D --> DEV_A
end
%% Connections between phases
BA_P --> PM_M
User_Input[/"User Direct Input"/] --> PM_M
PM_PRD --> ARCH_P
ARCH_D --> PO_C
PO_C --> PO_A
PO_A --> SM_S
SM_S --> SM_A
SM_A --> DEV_I
DEV_A --> SM_S
%% Completion condition
DEV_A -- "All stories complete" --> DONE["Project Complete"]
%% Styling
classDef phase fill:#1a73e8,stroke:#0d47a1,stroke-width:2px,color:white,font-size:14px
classDef artifact fill:#43a047,stroke:#1b5e20,stroke-width:1px,color:white,font-size:14px
classDef process fill:#ff9800,stroke:#e65100,stroke-width:1px,color:white,font-size:14px
classDef approval fill:#d81b60,stroke:#880e4f,stroke-width:1px,color:white,font-size:14px
class BA,PM,ARCH,PO,SM,DEV phase
class BA_P,PM_PRD,ARCH_D artifact
class BA_B,BA_R,PM_D,PM_M,ARCH_P,SM_S,DEV_I,DEV_T,DEV_D process
class PM_C,ARCH_C,PO_C,PO_A,SM_A,DEV_A approval
```