@@ -112,7 +112,7 @@ Create an `index.md` file in the sharded folder that:
|
|||||||
- [Section Name 2](./section-name-2.md)
|
- [Section Name 2](./section-name-2.md)
|
||||||
- [Section Name 3](./section-name-3.md)
|
- [Section Name 3](./section-name-3.md)
|
||||||
...
|
...
|
||||||
```text
|
```
|
||||||
|
|
||||||
### 5. Preserve Special Content
|
### 5. Preserve Special Content
|
||||||
|
|
||||||
|
|||||||
@@ -357,7 +357,7 @@ servers:
|
|||||||
'[object Object]': null
|
'[object Object]': null
|
||||||
description:
|
description:
|
||||||
'[object Object]': null
|
'[object Object]': null
|
||||||
```text
|
```
|
||||||
|
|
||||||
^^/CONDITION: has_rest_api^^
|
^^/CONDITION: has_rest_api^^
|
||||||
|
|
||||||
@@ -420,7 +420,6 @@ After presenting the structure, apply `tasks#advanced-elicitation` protocol to r
|
|||||||
├── {{package-manifest}} # Dependencies manifest
|
├── {{package-manifest}} # Dependencies manifest
|
||||||
├── {{config-files}} # Language/framework configs
|
├── {{config-files}} # Language/framework configs
|
||||||
└── README.md # Project documentation
|
└── README.md # Project documentation
|
||||||
```text
|
|
||||||
|
|
||||||
@{example: monorepo-structure}
|
@{example: monorepo-structure}
|
||||||
project-root/
|
project-root/
|
||||||
@@ -432,6 +431,7 @@ project-root/
|
|||||||
├── scripts/ # Monorepo management scripts
|
├── scripts/ # Monorepo management scripts
|
||||||
└── package.json # Root package.json with workspaces
|
└── package.json # Root package.json with workspaces
|
||||||
@{/example}
|
@{/example}
|
||||||
|
```
|
||||||
|
|
||||||
[[LLM: After presenting the source tree structure, apply `tasks#advanced-elicitation` protocol]]
|
[[LLM: After presenting the source tree structure, apply `tasks#advanced-elicitation` protocol]]
|
||||||
|
|
||||||
|
|||||||
@@ -226,7 +226,7 @@ Present component architecture and apply `tasks#advanced-elicitation` protocol]]
|
|||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
{{component_interaction_diagram}}
|
{{component_interaction_diagram}}
|
||||||
```text
|
```
|
||||||
|
|
||||||
## API Design and Integration
|
## API Design and Integration
|
||||||
|
|
||||||
@@ -266,7 +266,7 @@ Present API design and apply `tasks#advanced-elicitation` protocol]]
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{{response_schema}}
|
{{response_schema}}
|
||||||
```text
|
```
|
||||||
|
|
||||||
<</REPEAT>>
|
<</REPEAT>>
|
||||||
|
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
|
|||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
{{sitemap_diagram}}
|
{{sitemap_diagram}}
|
||||||
```text
|
```
|
||||||
|
|
||||||
@{example: sitemap}
|
@{example: sitemap}
|
||||||
|
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ Available workflows for [Team Name]:
|
|||||||
[... etc. ...]
|
[... etc. ...]
|
||||||
|
|
||||||
Use /workflow-start {number or id} to begin a workflow.
|
Use /workflow-start {number or id} to begin a workflow.
|
||||||
```text
|
```
|
||||||
|
|
||||||
### /workflow-start {workflow-id}
|
### /workflow-start {workflow-id}
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ In Progress:
|
|||||||
- Create PRD (John) - awaiting input
|
- Create PRD (John) - awaiting input
|
||||||
|
|
||||||
Next: Technical Architecture
|
Next: Technical Architecture
|
||||||
```text
|
```
|
||||||
|
|
||||||
### /workflow-resume
|
### /workflow-resume
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ BMad: I see you've completed Discovery and part of Product Planning.
|
|||||||
- UX Strategy with Sally (ux-expert)
|
- UX Strategy with Sally (ux-expert)
|
||||||
|
|
||||||
Would you like me to load Sally to continue?
|
Would you like me to load Sally to continue?
|
||||||
```text
|
```
|
||||||
|
|
||||||
### /workflow-next
|
### /workflow-next
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ BMad: I see you have a PRD and architecture document. Based on these artifacts,
|
|||||||
- Load Sarah (Product Owner) to validate all artifacts
|
- Load Sarah (Product Owner) to validate all artifacts
|
||||||
|
|
||||||
Would you like to continue with this workflow?
|
Would you like to continue with this workflow?
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Workflow Context Passing
|
## Workflow Context Passing
|
||||||
|
|
||||||
@@ -185,7 +185,7 @@ Sally: I see we're in the Product Planning stage of the greenfield-fullstack wor
|
|||||||
|
|
||||||
Let's create the UX strategy and UI specifications. First, let me review
|
Let's create the UX strategy and UI specifications. First, let me review
|
||||||
the PRD to understand the features we're designing for...
|
the PRD to understand the features we're designing for...
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Multi-Path Workflows
|
## Multi-Path Workflows
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The system facilitates a full development lifecycle:
|
|||||||
|
|
||||||
The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
|
The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
|
||||||
|
|
||||||
````mermaid
|
```mermaid
|
||||||
graph TD
|
graph TD
|
||||||
subgraph BMAD Method Project
|
subgraph BMAD Method Project
|
||||||
subgraph Core Framework
|
subgraph Core Framework
|
||||||
@@ -59,7 +59,7 @@ graph TD
|
|||||||
style A fill:#1a73e8,color:#fff
|
style A fill:#1a73e8,color:#fff
|
||||||
style I fill:#f9ab00,color:#fff
|
style I fill:#f9ab00,color:#fff
|
||||||
style J fill:#34a853,color:#fff
|
style J fill:#34a853,color:#fff
|
||||||
```text
|
```
|
||||||
|
|
||||||
## 3. Core Components
|
## 3. Core Components
|
||||||
|
|
||||||
@@ -173,7 +173,7 @@ graph TD
|
|||||||
style G fill:#f9ab00,color:#fff
|
style G fill:#f9ab00,color:#fff
|
||||||
style L fill:#1a73e8,color:#fff
|
style L fill:#1a73e8,color:#fff
|
||||||
style N fill:#34a853,color:#fff
|
style N fill:#34a853,color:#fff
|
||||||
````
|
```
|
||||||
|
|
||||||
**Key Planning Phases:**
|
**Key Planning Phases:**
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ A pull request (PR) is how you propose changes to a project on GitHub. Think of
|
|||||||
# Replace YOUR-USERNAME with your actual GitHub username
|
# Replace YOUR-USERNAME with your actual GitHub username
|
||||||
git clone https://github.com/YOUR-USERNAME/bmad-method.git
|
git clone https://github.com/YOUR-USERNAME/bmad-method.git
|
||||||
cd bmad-method
|
cd bmad-method
|
||||||
```text
|
```
|
||||||
|
|
||||||
### 3. Create a New Branch
|
### 3. Create a New Branch
|
||||||
|
|
||||||
@@ -57,7 +57,7 @@ git add .
|
|||||||
|
|
||||||
# Commit with a clear message
|
# Commit with a clear message
|
||||||
git commit -m "Fix typo in README.md"
|
git commit -m "Fix typo in README.md"
|
||||||
```text
|
```
|
||||||
|
|
||||||
**Good commit messages:**
|
**Good commit messages:**
|
||||||
|
|
||||||
|
|||||||
@@ -56,10 +56,10 @@ Best for: ChatGPT, Claude, Gemini users
|
|||||||
|
|
||||||
Best for: Cursor, Claude Code, Windsurf, VS Code users
|
Best for: Cursor, Claude Code, Windsurf, VS Code users
|
||||||
|
|
||||||
````bash
|
```bash
|
||||||
# Interactive installation (recommended)
|
# Interactive installation (recommended)
|
||||||
npx bmad-method install
|
npx bmad-method install
|
||||||
```text
|
```
|
||||||
|
|
||||||
### First Steps
|
### First Steps
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ dependencies:
|
|||||||
- shard-doc.md
|
- shard-doc.md
|
||||||
data:
|
data:
|
||||||
- bmad-kb.md
|
- bmad-kb.md
|
||||||
````
|
```
|
||||||
|
|
||||||
**Key Points:**
|
**Key Points:**
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ dependencies:
|
|||||||
|
|
||||||
**In IDE:**
|
**In IDE:**
|
||||||
|
|
||||||
````bash
|
```bash
|
||||||
# Cursor or Windsurf (manual rules - loaded with @)
|
# Cursor or Windsurf (manual rules - loaded with @)
|
||||||
@pm Create a PRD for a task management app
|
@pm Create a PRD for a task management app
|
||||||
@architect Design the system architecture
|
@architect Design the system architecture
|
||||||
@@ -127,7 +127,7 @@ dependencies:
|
|||||||
# Claude Code (files in commands folder - loaded with /)
|
# Claude Code (files in commands folder - loaded with /)
|
||||||
/pm Create user stories
|
/pm Create user stories
|
||||||
/dev Fix the login bug
|
/dev Fix the login bug
|
||||||
```text
|
```
|
||||||
|
|
||||||
**In Web UI:**
|
**In Web UI:**
|
||||||
|
|
||||||
@@ -135,7 +135,7 @@ dependencies:
|
|||||||
/pm create-doc prd
|
/pm create-doc prd
|
||||||
/architect review system design
|
/architect review system design
|
||||||
/dev implement story 1.2
|
/dev implement story 1.2
|
||||||
````
|
```
|
||||||
|
|
||||||
## Templates and Document Creation
|
## Templates and Document Creation
|
||||||
|
|
||||||
@@ -224,10 +224,10 @@ When working directly in IDEs:
|
|||||||
|
|
||||||
Templates can include `advanced-elicitation.md` for enhanced interaction:
|
Templates can include `advanced-elicitation.md` for enhanced interaction:
|
||||||
|
|
||||||
`````markdown
|
```markdown
|
||||||
[[LLM: Use advanced-elicitation actions 0-3 to refine requirements]]
|
[[LLM: Use advanced-elicitation actions 0-3 to refine requirements]]
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
This provides 10 structured brainstorming actions:
|
This provides 10 structured brainstorming actions:
|
||||||
|
|
||||||
@@ -268,10 +268,7 @@ graph TD
|
|||||||
style G fill:#f9ab00,color:#fff
|
style G fill:#f9ab00,color:#fff
|
||||||
style L fill:#1a73e8,color:#fff
|
style L fill:#1a73e8,color:#fff
|
||||||
style N fill:#34a853,color:#fff
|
style N fill:#34a853,color:#fff
|
||||||
````
|
```
|
||||||
`````
|
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
#### Web UI to IDE Transition
|
#### Web UI to IDE Transition
|
||||||
|
|
||||||
@@ -286,7 +283,7 @@ graph TD
|
|||||||
|
|
||||||
Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
|
Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
|
||||||
|
|
||||||
````mermaid
|
```mermaid
|
||||||
graph TD
|
graph TD
|
||||||
A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
|
A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
|
||||||
B --> C["PO: Shard Arch"]
|
B --> C["PO: Shard Arch"]
|
||||||
@@ -302,7 +299,7 @@ graph TD
|
|||||||
J --> E
|
J --> E
|
||||||
|
|
||||||
style J fill:#34a853,color:#fff
|
style J fill:#34a853,color:#fff
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Workflow Phases
|
### Workflow Phases
|
||||||
|
|
||||||
@@ -391,7 +388,7 @@ agents:
|
|||||||
- qa
|
- qa
|
||||||
workflows:
|
workflows:
|
||||||
- greenfield-fullstack
|
- greenfield-fullstack
|
||||||
`````
|
```
|
||||||
|
|
||||||
## IDE Integration
|
## IDE Integration
|
||||||
|
|
||||||
@@ -543,7 +540,7 @@ BMAD's dependency system ensures agents only load necessary resources:
|
|||||||
|
|
||||||
Create custom templates following `template-format.md`:
|
Create custom templates following `template-format.md`:
|
||||||
|
|
||||||
`````markdown
|
```markdown
|
||||||
---
|
---
|
||||||
title: Custom Template
|
title: Custom Template
|
||||||
description: Your custom document type
|
description: Your custom document type
|
||||||
@@ -565,7 +562,7 @@ dependencies:
|
|||||||
|
|
||||||
{{section_2_content}}
|
{{section_2_content}}
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
### Workflow Customization
|
### Workflow Customization
|
||||||
|
|
||||||
@@ -594,10 +591,7 @@ phases:
|
|||||||
deliverables:
|
deliverables:
|
||||||
- implementation
|
- implementation
|
||||||
- tests
|
- tests
|
||||||
````
|
```
|
||||||
`````
|
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
### Creating Custom Templates
|
### Creating Custom Templates
|
||||||
|
|
||||||
@@ -605,7 +599,7 @@ Templates are self-contained documents that embed both output structure and proc
|
|||||||
|
|
||||||
#### Template Structure
|
#### Template Structure
|
||||||
|
|
||||||
````markdown
|
```markdown
|
||||||
# {{Project Name}} Document Title
|
# {{Project Name}} Document Title
|
||||||
|
|
||||||
[[LLM: Opening instruction for AI processing]]
|
[[LLM: Opening instruction for AI processing]]
|
||||||
@@ -628,7 +622,7 @@ Templates are self-contained documents that embed both output structure and proc
|
|||||||
[[LLM: Only include if condition is met]]
|
[[LLM: Only include if condition is met]]
|
||||||
^^/CONDITION^^
|
^^/CONDITION^^
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
#### Key Template Patterns
|
#### Key Template Patterns
|
||||||
|
|
||||||
@@ -648,9 +642,7 @@ Templates are self-contained documents that embed both output structure and proc
|
|||||||
## User Interface Section
|
## User Interface Section
|
||||||
[[LLM: Only include for UI projects]]
|
[[LLM: Only include for UI projects]]
|
||||||
^^/CONDITION^^
|
^^/CONDITION^^
|
||||||
`````
|
```
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
#### Document Sharding
|
#### Document Sharding
|
||||||
|
|
||||||
@@ -658,7 +650,7 @@ Level 2 headings (`##`) in templates can be automatically sharded into separate
|
|||||||
|
|
||||||
**Original PRD:**
|
**Original PRD:**
|
||||||
|
|
||||||
````markdown
|
```markdown
|
||||||
## Goals and Background Context
|
## Goals and Background Context
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
@@ -667,7 +659,7 @@ Level 2 headings (`##`) in templates can be automatically sharded into separate
|
|||||||
|
|
||||||
## Success Metrics
|
## Success Metrics
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
**After Sharding:**
|
**After Sharding:**
|
||||||
- `docs/prd/goals-and-background-context.md`
|
- `docs/prd/goals-and-background-context.md`
|
||||||
@@ -704,33 +696,29 @@ Tasks are reusable automation instructions that agents can execute. They follow
|
|||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@{example: Concrete usage examples}
|
@{example: Concrete usage examples}
|
||||||
`````
|
```
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
#### Task Patterns
|
#### Task Patterns
|
||||||
|
|
||||||
**Resource Integration:**
|
**Resource Integration:**
|
||||||
|
|
||||||
````markdown
|
```markdown
|
||||||
[[LLM: Check if docs/coding-standards.md exists and reference it]]
|
[[LLM: Check if docs/coding-standards.md exists and reference it]]
|
||||||
[[LLM: Load docs/openapi-spec.yaml for API context]]
|
[[LLM: Load docs/openapi-spec.yaml for API context]]
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
**Advanced Elicitation:**
|
**Advanced Elicitation:**
|
||||||
```markdown
|
```markdown
|
||||||
[[LLM: Apply tasks#advanced-elicitation protocol after completion]]
|
[[LLM: Apply tasks#advanced-elicitation protocol after completion]]
|
||||||
`````
|
```
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
**Conditional Logic:**
|
**Conditional Logic:**
|
||||||
|
|
||||||
````markdown
|
```markdown
|
||||||
[[LLM: If project has UI components, also check frontend standards]]
|
[[LLM: If project has UI components, also check frontend standards]]
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
### Creating Custom Agents
|
### Creating Custom Agents
|
||||||
|
|
||||||
@@ -764,21 +752,19 @@ dependencies:
|
|||||||
- custom-task.md
|
- custom-task.md
|
||||||
data:
|
data:
|
||||||
- domain-knowledge.md
|
- domain-knowledge.md
|
||||||
`````
|
```
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
#### Agent Startup Instructions
|
#### Agent Startup Instructions
|
||||||
|
|
||||||
Agents can load project-specific documents and provide custom context:
|
Agents can load project-specific documents and provide custom context:
|
||||||
|
|
||||||
````yaml
|
```yaml
|
||||||
startup:
|
startup:
|
||||||
- Load docs/coding-standards.md if available
|
- Load docs/coding-standards.md if available
|
||||||
- Review docs/project-structure.md for context
|
- Review docs/project-structure.md for context
|
||||||
- Check for docs/third-party-apis/ folder
|
- Check for docs/third-party-apis/ folder
|
||||||
- Announce specialized capabilities
|
- Announce specialized capabilities
|
||||||
```text
|
```
|
||||||
|
|
||||||
#### Loading Project Documents
|
#### Loading Project Documents
|
||||||
|
|
||||||
@@ -798,7 +784,7 @@ Agents can reference and load documents from the `docs/` folder:
|
|||||||
- docs/brand-guidelines.md for design consistency
|
- docs/brand-guidelines.md for design consistency
|
||||||
- docs/third-party-apis/ for integration requirements
|
- docs/third-party-apis/ for integration requirements
|
||||||
- Any project-specific documentation in docs/ folder]]
|
- Any project-specific documentation in docs/ folder]]
|
||||||
`````
|
```
|
||||||
|
|
||||||
### Technical Preferences System
|
### Technical Preferences System
|
||||||
|
|
||||||
@@ -812,7 +798,7 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|||||||
|
|
||||||
**Technology Stack Preferences:**
|
**Technology Stack Preferences:**
|
||||||
|
|
||||||
`````markdown
|
```markdown
|
||||||
## Preferred Technologies
|
## Preferred Technologies
|
||||||
|
|
||||||
### Frontend
|
### Frontend
|
||||||
@@ -832,7 +818,7 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|||||||
- Vercel for frontend
|
- Vercel for frontend
|
||||||
- Railway for backend services
|
- Railway for backend services
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
**Design Patterns & Standards:**
|
**Design Patterns & Standards:**
|
||||||
```markdown
|
```markdown
|
||||||
@@ -846,14 +832,11 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|||||||
- Microservices for complex applications
|
- Microservices for complex applications
|
||||||
- RESTful APIs with OpenAPI documentation
|
- RESTful APIs with OpenAPI documentation
|
||||||
- Event-driven architecture for real-time features
|
- Event-driven architecture for real-time features
|
||||||
````
|
```
|
||||||
`````
|
|
||||||
|
|
||||||
`````
|
|
||||||
|
|
||||||
**External Services & APIs:**
|
**External Services & APIs:**
|
||||||
|
|
||||||
````markdown
|
```markdown
|
||||||
## Preferred External Services
|
## Preferred External Services
|
||||||
|
|
||||||
- Auth0 for authentication
|
- Auth0 for authentication
|
||||||
@@ -866,7 +849,7 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|||||||
- Legacy SOAP services
|
- Legacy SOAP services
|
||||||
- Services without proper documentation
|
- Services without proper documentation
|
||||||
|
|
||||||
````text
|
```
|
||||||
|
|
||||||
#### How Agents Use This File
|
#### How Agents Use This File
|
||||||
|
|
||||||
@@ -880,7 +863,6 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|||||||
|
|
||||||
**Learning and Evolution**: As you work on projects, add discoveries to your preferences file:
|
**Learning and Evolution**: As you work on projects, add discoveries to your preferences file:
|
||||||
|
|
||||||
```markdown
|
|
||||||
## Lessons Learned
|
## Lessons Learned
|
||||||
- Avoid using Library X for large datasets (performance issues)
|
- Avoid using Library X for large datasets (performance issues)
|
||||||
- Pattern Y works well for real-time features
|
- Pattern Y works well for real-time features
|
||||||
@@ -890,9 +872,6 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|||||||
- Want to try Framework A on next appropriate project
|
- Want to try Framework A on next appropriate project
|
||||||
- Interested in Pattern B for microservices
|
- Interested in Pattern B for microservices
|
||||||
- Consider Service C for better performance
|
- Consider Service C for better performance
|
||||||
`````
|
|
||||||
|
|
||||||
````
|
|
||||||
|
|
||||||
#### Using with Web Bundles
|
#### Using with Web Bundles
|
||||||
|
|
||||||
@@ -1050,4 +1029,3 @@ Remember: BMAD is designed to enhance your development process, not replace your
|
|||||||
---
|
---
|
||||||
|
|
||||||
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.
|
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.
|
||||||
````
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ This document establishes coding standards, architectural patterns, and developm
|
|||||||
"exactOptionalPropertyTypes": true
|
"exactOptionalPropertyTypes": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Type Definitions
|
### Type Definitions
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ interface GameSystem {
|
|||||||
update(delta: number): void;
|
update(delta: number): void;
|
||||||
shutdown(): void;
|
shutdown(): void;
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
**Scene Data Interfaces:**
|
**Scene Data Interfaces:**
|
||||||
```typescript
|
```typescript
|
||||||
@@ -73,7 +73,7 @@ interface GameSettings {
|
|||||||
difficulty: 'easy' | 'normal' | 'hard';
|
difficulty: 'easy' | 'normal' | 'hard';
|
||||||
controls: ControlScheme;
|
controls: ControlScheme;
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Naming Conventions
|
### Naming Conventions
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ this.scene.start('NextScene', {
|
|||||||
// Scene overlays for UI
|
// Scene overlays for UI
|
||||||
this.scene.launch('PauseMenuScene');
|
this.scene.launch('PauseMenuScene');
|
||||||
this.scene.pause();
|
this.scene.pause();
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Game Object Patterns
|
### Game Object Patterns
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ class Player extends GameEntity {
|
|||||||
this.health = this.addComponent(new HealthComponent(this, 100));
|
this.health = this.addComponent(new HealthComponent(this, 100));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
### System Management
|
### System Management
|
||||||
|
|
||||||
@@ -235,7 +235,7 @@ class GameManager {
|
|||||||
GameManager.instance = null!;
|
GameManager.instance = null!;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Performance Optimization
|
## Performance Optimization
|
||||||
|
|
||||||
@@ -308,7 +308,7 @@ class PerformanceMonitor {
|
|||||||
// Reduce particle counts, disable effects, etc.
|
// Reduce particle counts, disable effects, etc.
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
**Update Loop Optimization:**
|
**Update Loop Optimization:**
|
||||||
```typescript
|
```typescript
|
||||||
@@ -331,7 +331,7 @@ class GameScene extends Phaser.Scene {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Input Handling
|
## Input Handling
|
||||||
|
|
||||||
@@ -385,7 +385,7 @@ class InputManager {
|
|||||||
return { ...this.inputState };
|
return { ...this.inputState };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
@@ -455,7 +455,7 @@ class GameSystem {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Testing Standards
|
## Testing Standards
|
||||||
|
|
||||||
@@ -489,7 +489,7 @@ describe('HealthComponent', () => {
|
|||||||
expect(healthComponent.isAlive()).toBe(false);
|
expect(healthComponent.isAlive()).toBe(false);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Integration Testing
|
### Integration Testing
|
||||||
|
|
||||||
@@ -512,7 +512,7 @@ describe('GameScene Integration', () => {
|
|||||||
expect(scene.inputManager).toBeDefined();
|
expect(scene.inputManager).toBeDefined();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
```text
|
```
|
||||||
|
|
||||||
## File Organization
|
## File Organization
|
||||||
|
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ This architecture is designed to support the gameplay mechanics defined in the G
|
|||||||
│ ├── stories/ # Development stories
|
│ ├── stories/ # Development stories
|
||||||
│ └── architecture/ # Technical docs
|
│ └── architecture/ # Technical docs
|
||||||
└── dist/ # Built game files
|
└── dist/ # Built game files
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Module Organization
|
### Module Organization
|
||||||
|
|
||||||
@@ -365,7 +365,7 @@ const gameConfig: Phaser.Types.Core.GameConfig = {
|
|||||||
},
|
},
|
||||||
// Additional configuration...
|
// Additional configuration...
|
||||||
};
|
};
|
||||||
```text
|
```
|
||||||
|
|
||||||
### Game Balance Configuration
|
### Game Balance Configuration
|
||||||
|
|
||||||
|
|||||||
@@ -116,7 +116,7 @@ Difficulty
|
|||||||
|/ /
|
|/ /
|
||||||
+-----------> Level Number
|
+-----------> Level Number
|
||||||
Tutorial Early Mid Late
|
Tutorial Early Mid Late
|
||||||
```text
|
```
|
||||||
|
|
||||||
**Scaling Parameters:**
|
**Scaling Parameters:**
|
||||||
- Enemy count: {{start_count}} → {{end_count}}
|
- Enemy count: {{start_count}} → {{end_count}}
|
||||||
|
|||||||
@@ -66,13 +66,13 @@ To install this expansion pack, run:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run install:expansion infrastructure
|
npm run install:expansion infrastructure
|
||||||
```text
|
```
|
||||||
|
|
||||||
Or manually:
|
Or manually:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
node tools/install-expansion-pack.js infrastructure
|
node tools/install-expansion-pack.js infrastructure
|
||||||
```text
|
```
|
||||||
|
|
||||||
This will:
|
This will:
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ After the main architecture is complete:
|
|||||||
|
|
||||||
# Or directly with DevOps agent
|
# Or directly with DevOps agent
|
||||||
npm run agent devops
|
npm run agent devops
|
||||||
```text
|
```
|
||||||
|
|
||||||
### 2. Platform Implementation
|
### 2. Platform Implementation
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
@@ -63,7 +63,7 @@ Created during agent setup:
|
|||||||
- Templates:
|
- Templates:
|
||||||
- [ ] template-name-1.md
|
- [ ] template-name-1.md
|
||||||
- [ ] template-name-2.md
|
- [ ] template-name-2.md
|
||||||
```text
|
```
|
||||||
|
|
||||||
### 4. Create Agent File
|
### 4. Create Agent File
|
||||||
|
|
||||||
@@ -121,7 +121,7 @@ Present to the user:
|
|||||||
1. Review and customize the created tasks/templates
|
1. Review and customize the created tasks/templates
|
||||||
2. Run npm run build:agents
|
2. Run npm run build:agents
|
||||||
3. Test the agent thoroughly
|
3. Test the agent thoroughly
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Template Reference
|
## Template Reference
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ persona:
|
|||||||
- Data integrity and accuracy above all
|
- Data integrity and accuracy above all
|
||||||
- Clear communication of complex findings
|
- Clear communication of complex findings
|
||||||
- Actionable insights over raw numbers
|
- Actionable insights over raw numbers
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Creating Missing Dependencies
|
## Creating Missing Dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -83,7 +83,7 @@ workflows:
|
|||||||
- {{workflow-name}} # {{workflow-description}}
|
- {{workflow-name}} # {{workflow-description}}
|
||||||
<</REPEAT>>
|
<</REPEAT>>
|
||||||
^^/CONDITION: domain-workflows^^
|
^^/CONDITION: domain-workflows^^
|
||||||
```text
|
```
|
||||||
|
|
||||||
@{example-1: Standard fullstack team}
|
@{example-1: Standard fullstack team}
|
||||||
|
|
||||||
@@ -127,7 +127,7 @@ workflows:
|
|||||||
- healthcare-patient-portal
|
- healthcare-patient-portal
|
||||||
- healthcare-compliance-audit
|
- healthcare-compliance-audit
|
||||||
- clinical-trial-management
|
- clinical-trial-management
|
||||||
```text
|
```
|
||||||
|
|
||||||
@{example-3: Minimal IDE team}
|
@{example-3: Minimal IDE team}
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,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:
|
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:
|
||||||
|
|
||||||
````yml
|
```yml
|
||||||
activation-instructions:
|
activation-instructions:
|
||||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||||
@@ -86,7 +86,7 @@ dependencies:
|
|||||||
- template-format # Required if using templates
|
- template-format # Required if using templates
|
||||||
- [UTIL_1] # Other utilities as needed
|
- [UTIL_1] # Other utilities as needed
|
||||||
[[LLM: Include workflow-management if agent participates in workflows]]
|
[[LLM: Include workflow-management if agent participates in workflows]]
|
||||||
```text
|
```
|
||||||
|
|
||||||
@{example: Construction Contractor Agent}
|
@{example: Construction Contractor Agent}
|
||||||
|
|
||||||
@@ -140,4 +140,4 @@ dependencies:
|
|||||||
- 'materials-guide.md # Construction materials specs'
|
- 'materials-guide.md # Construction materials specs'
|
||||||
utils:
|
utils:
|
||||||
- 'template-format # For template processing'
|
- 'template-format # For template processing'
|
||||||
````
|
```
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ Available workflows for [Team Name]:
|
|||||||
[... etc. ...]
|
[... etc. ...]
|
||||||
|
|
||||||
Use /workflow-start {number or id} to begin a workflow.
|
Use /workflow-start {number or id} to begin a workflow.
|
||||||
```text
|
```
|
||||||
|
|
||||||
### /workflow-start {workflow-id}
|
### /workflow-start {workflow-id}
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ In Progress:
|
|||||||
- Create PRD (John) - awaiting input
|
- Create PRD (John) - awaiting input
|
||||||
|
|
||||||
Next: Technical Architecture
|
Next: Technical Architecture
|
||||||
```text
|
```
|
||||||
|
|
||||||
### /workflow-resume
|
### /workflow-resume
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ BMad: I see you've completed Discovery and part of Product Planning.
|
|||||||
- UX Strategy with Sally (ux-expert)
|
- UX Strategy with Sally (ux-expert)
|
||||||
|
|
||||||
Would you like me to load Sally to continue?
|
Would you like me to load Sally to continue?
|
||||||
```text
|
```
|
||||||
|
|
||||||
### /workflow-next
|
### /workflow-next
|
||||||
|
|
||||||
@@ -135,7 +135,7 @@ workflow_state:
|
|||||||
status: in-progress
|
status: in-progress
|
||||||
created_by: pm
|
created_by: pm
|
||||||
started: 2024-01-15T11:00:00.000Z
|
started: 2024-01-15T11:00:00.000Z
|
||||||
```text
|
```
|
||||||
|
|
||||||
### 4. Workflow Interruption Handling
|
### 4. Workflow Interruption Handling
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ BMad: I see you have a PRD and architecture document. Based on these artifacts,
|
|||||||
- Load Sarah (Product Owner) to validate all artifacts
|
- Load Sarah (Product Owner) to validate all artifacts
|
||||||
|
|
||||||
Would you like to continue with this workflow?
|
Would you like to continue with this workflow?
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Workflow Context Passing
|
## Workflow Context Passing
|
||||||
|
|
||||||
@@ -185,7 +185,7 @@ Sally: I see we're in the Product Planning stage of the greenfield-fullstack wor
|
|||||||
|
|
||||||
Let's create the UX strategy and UI specifications. First, let me review
|
Let's create the UX strategy and UI specifications. First, let me review
|
||||||
the PRD to understand the features we're designing for...
|
the PRD to understand the features we're designing for...
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Multi-Path Workflows
|
## Multi-Path Workflows
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ installer/
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
````bash
|
```bash
|
||||||
# Interactive installation
|
# Interactive installation
|
||||||
npx bmad-method install
|
npx bmad-method install
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ npx bmad-method install --profile=minimal
|
|||||||
|
|
||||||
# Update existing installation
|
# Update existing installation
|
||||||
npx bmad-method update
|
npx bmad-method update
|
||||||
```text
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@@ -55,4 +55,4 @@ npm test
|
|||||||
|
|
||||||
# Lint code
|
# Lint code
|
||||||
npm run lint
|
npm run lint
|
||||||
````
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user