doc and text cleanup
This commit is contained in:
Brian Madison
@@ -9,18 +9,18 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
||||
agent:
|
||||
name: BMad Master
|
||||
id: bmad-master
|
||||
title: BMAD Master Task Executor
|
||||
title: BMad Master Task Executor
|
||||
icon: 🧙
|
||||
whenToUse: Use when you need comprehensive expertise across all domains or rapid context switching between multiple agent capabilities
|
||||
persona:
|
||||
role: Master Task Executor & BMAD Method Expert
|
||||
style: Efficient, direct, action-oriented. Executes any BMAD task/template/util/checklist with precision
|
||||
identity: Universal executor of all BMAD-METHOD capabilities, directly runs any resource
|
||||
role: Master Task Executor & BMad Method Expert
|
||||
style: Efficient, direct, action-oriented. Executes any BMad task/template/util/checklist with precision
|
||||
identity: Universal executor of all BMad-Method capabilities, directly runs any resource
|
||||
focus: Direct execution without transformation, load resources only when needed
|
||||
core_principles:
|
||||
- Execute any resource directly without persona transformation
|
||||
- Load resources at runtime, never pre-load
|
||||
- Expert knowledge of all BMAD resources
|
||||
- Expert knowledge of all BMad resources
|
||||
- Track execution state and guide multi-step processes
|
||||
- Use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
|
||||
@@ -9,13 +9,13 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -28,7 +28,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -41,7 +41,7 @@ startup:
|
||||
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -56,13 +56,13 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -104,7 +104,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Change Navigation Checklist
|
||||
|
||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMAD workflow.
|
||||
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -75,7 +75,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
|
||||
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -12,7 +12,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -20,11 +20,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -95,14 +95,14 @@ npx bmad-method install
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
|
||||
**Note for VS Code Users**: BMAD-METHOD assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMAD agents. The installer includes built-in support for Cline and Roo.
|
||||
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**Remember**: At its core, BMAD-METHOD is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMAD - the framework provides the structured prompts and workflows that make AI development effective
|
||||
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -163,11 +163,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -196,7 +196,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -325,7 +325,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
The BMAD-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
||||
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -369,7 +369,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -398,7 +398,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -659,7 +659,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -688,7 +688,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
Expansion packs extend BMAD-METHOD beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
||||
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ Create detailed, implementation-ready stories for brownfield projects where trad
|
||||
- Working on brownfield projects with non-standard documentation
|
||||
- Stories need to be created from document-project output
|
||||
- Working from brownfield epics without full PRD/architecture
|
||||
- Existing project documentation doesn't follow BMAD v4+ structure
|
||||
- Existing project documentation doesn't follow BMad v4+ structure
|
||||
- Need to gather additional context from user during story creation
|
||||
|
||||
**Use create-next-story when:**
|
||||
@@ -117,7 +117,7 @@ If using brownfield PRD:
|
||||
|
||||
#### 2.3 From User Documentation
|
||||
|
||||
[[LLM: When working with non-BMAD documentation, actively extract and organize the information into categories the Dev agent will need]]
|
||||
[[LLM: When working with non-BMad documentation, actively extract and organize the information into categories the Dev agent will need]]
|
||||
|
||||
Ask the user to help identify:
|
||||
|
||||
|
||||
@@ -13,8 +13,8 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Load `.bmad-core/core-config.yaml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMad installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yaml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `devStoryLocation`: Where to save story files
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -10,23 +10,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"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."
|
||||
"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."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -50,20 +50,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
|
||||
Reference in New Issue
Block a user