appiq-solution 1.4.2 → 1.4.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.
- package/#Tools/APPIQ-METHOD/.cursor/commands/analyze.md +1 -1
- package/#Tools/APPIQ-METHOD/.cursor/commands/appiq.md +1 -1
- package/#Tools/APPIQ-METHOD/.cursor/commands/help.md +1 -1
- package/#Tools/APPIQ-METHOD/.cursor/commands/story.md +1 -1
- package/#Tools/APPIQ-METHOD/bmad-core/agents/init-flow-po.md +219 -0
- package/#Tools/APPIQ-METHOD/commands/analyze.md +1 -1
- package/#Tools/APPIQ-METHOD/commands/appiq.md +1 -1
- package/#Tools/APPIQ-METHOD/commands/help.md +1 -1
- package/#Tools/APPIQ-METHOD/commands/story.md +1 -1
- package/#Tools/APPIQ-METHOD/package.json +1 -1
- package/#Tools/APPIQ-METHOD/tools/appiq-installer.js +196 -104
- package/#Tools/APPIQ-METHOD/tools/cli.js +1 -1
- package/#Tools/APPIQ-METHOD/tools/setup-ide-commands.js +40 -37
- package/#Tools/APPIQ-METHOD/tools/smart-installer.js +16 -13
- package/bmad-core/agent-teams/team-all.yaml +14 -0
- package/bmad-core/agent-teams/team-flutter-mobile.yaml +114 -0
- package/bmad-core/agent-teams/team-fullstack.yaml +28 -0
- package/bmad-core/agent-teams/team-ide-minimal.yaml +10 -0
- package/bmad-core/agent-teams/team-no-ui.yaml +13 -0
- package/bmad-core/agents/analyst.md +85 -0
- package/bmad-core/agents/architect.md +90 -0
- package/bmad-core/agents/bmad-master.md +108 -0
- package/bmad-core/agents/bmad-orchestrator.md +150 -0
- package/bmad-core/agents/bmad-smart-launcher.md +170 -0
- package/bmad-core/agents/dev.md +95 -0
- package/bmad-core/agents/init-flow-po.md +219 -0
- package/bmad-core/agents/pm.md +85 -0
- package/bmad-core/agents/po.md +76 -0
- package/bmad-core/agents/qa.md +86 -0
- package/bmad-core/agents/sm.md +67 -0
- package/bmad-core/agents/ux-expert.md +71 -0
- package/bmad-core/bmad-core/user-guide.md +0 -0
- package/bmad-core/checklists/architect-checklist.md +443 -0
- package/bmad-core/checklists/change-checklist.md +182 -0
- package/bmad-core/checklists/pm-checklist.md +375 -0
- package/bmad-core/checklists/po-master-checklist.md +441 -0
- package/bmad-core/checklists/security-validation-checklist.md +332 -0
- package/bmad-core/checklists/story-dod-checklist.md +101 -0
- package/bmad-core/checklists/story-draft-checklist.md +156 -0
- package/bmad-core/core-config.yaml +20 -0
- package/bmad-core/core-config.yaml.bak +20 -0
- package/bmad-core/data/backend-services-integration.md +686 -0
- package/bmad-core/data/bmad-kb.md +803 -0
- package/bmad-core/data/brainstorming-techniques.md +36 -0
- package/bmad-core/data/elicitation-methods.md +134 -0
- package/bmad-core/data/shadcn-ui-integration.md +388 -0
- package/bmad-core/data/technical-preferences.md +149 -0
- package/bmad-core/enhanced-ide-development-workflow.md +43 -0
- package/bmad-core/tasks/advanced-elicitation.md +117 -0
- package/bmad-core/tasks/brownfield-create-epic.md +160 -0
- package/bmad-core/tasks/brownfield-create-story.md +147 -0
- package/bmad-core/tasks/correct-course.md +70 -0
- package/bmad-core/tasks/create-brownfield-story.md +304 -0
- package/bmad-core/tasks/create-deep-research-prompt.md +289 -0
- package/bmad-core/tasks/create-flutter-story.md +197 -0
- package/bmad-core/tasks/create-next-story.md +112 -0
- package/bmad-core/tasks/document-project.md +341 -0
- package/bmad-core/tasks/facilitate-brainstorming-session.md +136 -0
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +51 -0
- package/bmad-core/tasks/index-docs.md +179 -0
- package/bmad-core/tasks/intelligent-epic-creation.md +234 -0
- package/bmad-core/tasks/kb-mode-interaction.md +75 -0
- package/bmad-core/tasks/review-story.md +145 -0
- package/bmad-core/tasks/shard-doc.md +187 -0
- package/bmad-core/tasks/smart-project-analysis.md +289 -0
- package/bmad-core/tasks/validate-next-story.md +134 -0
- package/bmad-core/templates/architecture-tmpl.yaml +650 -0
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +293 -0
- package/bmad-core/templates/flutter-mobile-prd-tmpl.yaml +330 -0
- package/bmad-core/templates/flutter-story-tmpl.yaml +376 -0
- package/bmad-core/templates/flutter-ui-spec-tmpl.yaml +415 -0
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +206 -0
- package/bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +812 -0
- package/bmad-core/templates/market-research-tmpl.yaml +252 -0
- package/bmad-core/templates/prd-tmpl.yaml +202 -0
- package/bmad-core/templates/project-brief-tmpl.yaml +221 -0
- package/bmad-core/templates/story-tmpl.yaml +137 -0
- package/bmad-core/user-guide.md +251 -0
- package/bmad-core/workflows/brownfield-fullstack.yaml +311 -0
- package/bmad-core/workflows/brownfield-service.yaml +187 -0
- package/bmad-core/workflows/brownfield-ui.yaml +197 -0
- package/bmad-core/workflows/greenfield-fullstack.yaml +284 -0
- package/bmad-core/workflows/greenfield-service.yaml +206 -0
- package/bmad-core/workflows/greenfield-ui.yaml +235 -0
- package/bmad-core/working-in-the-brownfield.md +373 -0
- package/package.json +1 -1
- package/tools/appiq-installer.js +196 -104
- package/tools/cli.js +1 -1
- package/tools/setup-ide-commands.js +40 -37
- package/tools/smart-installer.js +16 -13
@@ -0,0 +1,137 @@
|
|
1
|
+
template:
|
2
|
+
id: story-template-v2
|
3
|
+
name: Story Document
|
4
|
+
version: 2.0
|
5
|
+
output:
|
6
|
+
format: markdown
|
7
|
+
filename: docs/stories/{{epic_num}}.{{story_num}}.{{story_title_short}}.md
|
8
|
+
title: "Story {{epic_num}}.{{story_num}}: {{story_title_short}}"
|
9
|
+
|
10
|
+
workflow:
|
11
|
+
mode: interactive
|
12
|
+
elicitation: advanced-elicitation
|
13
|
+
|
14
|
+
agent_config:
|
15
|
+
editable_sections:
|
16
|
+
- Status
|
17
|
+
- Story
|
18
|
+
- Acceptance Criteria
|
19
|
+
- Tasks / Subtasks
|
20
|
+
- Dev Notes
|
21
|
+
- Testing
|
22
|
+
- Change Log
|
23
|
+
|
24
|
+
sections:
|
25
|
+
- id: status
|
26
|
+
title: Status
|
27
|
+
type: choice
|
28
|
+
choices: [Draft, Approved, InProgress, Review, Done]
|
29
|
+
instruction: Select the current status of the story
|
30
|
+
owner: scrum-master
|
31
|
+
editors: [scrum-master, dev-agent]
|
32
|
+
|
33
|
+
- id: story
|
34
|
+
title: Story
|
35
|
+
type: template-text
|
36
|
+
template: |
|
37
|
+
**As a** {{role}},
|
38
|
+
**I want** {{action}},
|
39
|
+
**so that** {{benefit}}
|
40
|
+
instruction: Define the user story using the standard format with role, action, and benefit
|
41
|
+
elicit: true
|
42
|
+
owner: scrum-master
|
43
|
+
editors: [scrum-master]
|
44
|
+
|
45
|
+
- id: acceptance-criteria
|
46
|
+
title: Acceptance Criteria
|
47
|
+
type: numbered-list
|
48
|
+
instruction: Copy the acceptance criteria numbered list from the epic file
|
49
|
+
elicit: true
|
50
|
+
owner: scrum-master
|
51
|
+
editors: [scrum-master]
|
52
|
+
|
53
|
+
- id: tasks-subtasks
|
54
|
+
title: Tasks / Subtasks
|
55
|
+
type: bullet-list
|
56
|
+
instruction: |
|
57
|
+
Break down the story into specific tasks and subtasks needed for implementation.
|
58
|
+
Reference applicable acceptance criteria numbers where relevant.
|
59
|
+
template: |
|
60
|
+
- [ ] Task 1 (AC: # if applicable)
|
61
|
+
- [ ] Subtask1.1...
|
62
|
+
- [ ] Task 2 (AC: # if applicable)
|
63
|
+
- [ ] Subtask 2.1...
|
64
|
+
- [ ] Task 3 (AC: # if applicable)
|
65
|
+
- [ ] Subtask 3.1...
|
66
|
+
elicit: true
|
67
|
+
owner: scrum-master
|
68
|
+
editors: [scrum-master, dev-agent]
|
69
|
+
|
70
|
+
- id: dev-notes
|
71
|
+
title: Dev Notes
|
72
|
+
instruction: |
|
73
|
+
Populate relevant information, only what was pulled from actual artifacts from docs folder, relevant to this story:
|
74
|
+
- Do not invent information
|
75
|
+
- If known add Relevant Source Tree info that relates to this story
|
76
|
+
- If there were important notes from previous story that are relevant to this one, include them here
|
77
|
+
- Put enough information in this section so that the dev agent should NEVER need to read the architecture documents, these notes along with the tasks and subtasks must give the Dev Agent the complete context it needs to comprehend with the least amount of overhead the information to complete the story, meeting all AC and completing all tasks+subtasks
|
78
|
+
elicit: true
|
79
|
+
owner: scrum-master
|
80
|
+
editors: [scrum-master]
|
81
|
+
sections:
|
82
|
+
- id: testing-standards
|
83
|
+
title: Testing
|
84
|
+
instruction: |
|
85
|
+
List Relevant Testing Standards from Architecture the Developer needs to conform to:
|
86
|
+
- Test file location
|
87
|
+
- Test standards
|
88
|
+
- Testing frameworks and patterns to use
|
89
|
+
- Any specific testing requirements for this story
|
90
|
+
elicit: true
|
91
|
+
owner: scrum-master
|
92
|
+
editors: [scrum-master]
|
93
|
+
|
94
|
+
- id: change-log
|
95
|
+
title: Change Log
|
96
|
+
type: table
|
97
|
+
columns: [Date, Version, Description, Author]
|
98
|
+
instruction: Track changes made to this story document
|
99
|
+
owner: scrum-master
|
100
|
+
editors: [scrum-master, dev-agent, qa-agent]
|
101
|
+
|
102
|
+
- id: dev-agent-record
|
103
|
+
title: Dev Agent Record
|
104
|
+
instruction: This section is populated by the development agent during implementation
|
105
|
+
owner: dev-agent
|
106
|
+
editors: [dev-agent]
|
107
|
+
sections:
|
108
|
+
- id: agent-model
|
109
|
+
title: Agent Model Used
|
110
|
+
template: "{{agent_model_name_version}}"
|
111
|
+
instruction: Record the specific AI agent model and version used for development
|
112
|
+
owner: dev-agent
|
113
|
+
editors: [dev-agent]
|
114
|
+
|
115
|
+
- id: debug-log-references
|
116
|
+
title: Debug Log References
|
117
|
+
instruction: Reference any debug logs or traces generated during development
|
118
|
+
owner: dev-agent
|
119
|
+
editors: [dev-agent]
|
120
|
+
|
121
|
+
- id: completion-notes
|
122
|
+
title: Completion Notes List
|
123
|
+
instruction: Notes about the completion of tasks and any issues encountered
|
124
|
+
owner: dev-agent
|
125
|
+
editors: [dev-agent]
|
126
|
+
|
127
|
+
- id: file-list
|
128
|
+
title: File List
|
129
|
+
instruction: List all files created, modified, or affected during story implementation
|
130
|
+
owner: dev-agent
|
131
|
+
editors: [dev-agent]
|
132
|
+
|
133
|
+
- id: qa-results
|
134
|
+
title: QA Results
|
135
|
+
instruction: Results from QA Agent QA review of the completed story implementation
|
136
|
+
owner: qa-agent
|
137
|
+
editors: [qa-agent]
|
@@ -0,0 +1,251 @@
|
|
1
|
+
# BMad-Method BMAd Code User Guide
|
2
|
+
|
3
|
+
This guide will help you understand and effectively use the BMad Method for agile AI driven planning and development.
|
4
|
+
|
5
|
+
## The BMad Plan and Execute Workflow
|
6
|
+
|
7
|
+
First, here is the full standard Greenfield Planning + Execution Workflow. Brownfield is very similar, but it's suggested to understand this greenfield first, even if on a simple project before tackling a brownfield project. The BMad Method needs to be installed to the root of your new project folder. For the planning phase, you can optionally perform it with powerful web agents, potentially resulting in higher quality results at a fraction of the cost it would take to complete if providing your own API key or credits in some Agentic tools. For planning, powerful thinking models and larger context - along with working as a partner with the agents will net the best results.
|
8
|
+
|
9
|
+
If you are going to use the BMad Method with a Brownfield project (an existing project), review **[Working in the Brownfield](./working-in-the-brownfield.md)**.
|
10
|
+
|
11
|
+
If you do not see the diagrams that following rendering, you can install Markdown All in One along with the Markdown Preview Mermaid Support plugins to VSCode (or one of the forked clones). With these plugin's, if you right click on the tab when open, there should be a Open Preview option, or check the IDE documentation.
|
12
|
+
|
13
|
+
### The Planning Workflow (Web UI or Powerful IDE Agents)
|
14
|
+
|
15
|
+
Before development begins, BMad follows a structured planning workflow that's ideally done in web UI for cost efficiency:
|
16
|
+
|
17
|
+
```mermaid
|
18
|
+
graph TD
|
19
|
+
A["Start: Project Idea"] --> B{"Optional: Analyst Research"}
|
20
|
+
B -->|Yes| C["Analyst: Brainstorming (Optional)"]
|
21
|
+
B -->|No| G{"Project Brief Available?"}
|
22
|
+
C --> C2["Analyst: Market Research (Optional)"]
|
23
|
+
C2 --> C3["Analyst: Competitor Analysis (Optional)"]
|
24
|
+
C3 --> D["Analyst: Create Project Brief"]
|
25
|
+
D --> G
|
26
|
+
G -->|Yes| E["PM: Create PRD from Brief (Fast Track)"]
|
27
|
+
G -->|No| E2["PM: Interactive PRD Creation (More Questions)"]
|
28
|
+
E --> F["PRD Created with FRs, NFRs, Epics & Stories"]
|
29
|
+
E2 --> F
|
30
|
+
F --> F2{"UX Required?"}
|
31
|
+
F2 -->|Yes| F3["UX Expert: Create Front End Spec"]
|
32
|
+
F2 -->|No| H["Architect: Create Architecture from PRD"]
|
33
|
+
F3 --> F4["UX Expert: Generate UI Prompt for Lovable/V0 (Optional)"]
|
34
|
+
F4 --> H2["Architect: Create Architecture from PRD + UX Spec"]
|
35
|
+
H --> I["PO: Run Master Checklist"]
|
36
|
+
H2 --> I
|
37
|
+
I --> J{"Documents Aligned?"}
|
38
|
+
J -->|Yes| K["Planning Complete"]
|
39
|
+
J -->|No| L["PO: Update Epics & Stories"]
|
40
|
+
L --> M["Update PRD/Architecture as needed"]
|
41
|
+
M --> I
|
42
|
+
K --> N["📁 Switch to IDE (If in a Web Agent Platform)"]
|
43
|
+
N --> O["PO: Shard Documents"]
|
44
|
+
O --> P["Ready for SM/Dev Cycle"]
|
45
|
+
|
46
|
+
style A fill:#f5f5f5,color:#000
|
47
|
+
style B fill:#e3f2fd,color:#000
|
48
|
+
style C fill:#e8f5e9,color:#000
|
49
|
+
style C2 fill:#e8f5e9,color:#000
|
50
|
+
style C3 fill:#e8f5e9,color:#000
|
51
|
+
style D fill:#e8f5e9,color:#000
|
52
|
+
style E fill:#fff3e0,color:#000
|
53
|
+
style E2 fill:#fff3e0,color:#000
|
54
|
+
style F fill:#fff3e0,color:#000
|
55
|
+
style F2 fill:#e3f2fd,color:#000
|
56
|
+
style F3 fill:#e1f5fe,color:#000
|
57
|
+
style F4 fill:#e1f5fe,color:#000
|
58
|
+
style G fill:#e3f2fd,color:#000
|
59
|
+
style H fill:#f3e5f5,color:#000
|
60
|
+
style H2 fill:#f3e5f5,color:#000
|
61
|
+
style I fill:#f9ab00,color:#fff
|
62
|
+
style J fill:#e3f2fd,color:#000
|
63
|
+
style K fill:#34a853,color:#fff
|
64
|
+
style L fill:#f9ab00,color:#fff
|
65
|
+
style M fill:#fff3e0,color:#000
|
66
|
+
style N fill:#1a73e8,color:#fff
|
67
|
+
style O fill:#f9ab00,color:#fff
|
68
|
+
style P fill:#34a853,color:#fff
|
69
|
+
```
|
70
|
+
|
71
|
+
#### Web UI to IDE Transition
|
72
|
+
|
73
|
+
**Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow:
|
74
|
+
|
75
|
+
1. **Copy Documents to Project**: Ensure `docs/prd.md` and `docs/architecture.md` are in your project's docs folder (or a custom location you can specify during installation)
|
76
|
+
2. **Switch to IDE**: Open your project in your preferred Agentic IDE
|
77
|
+
3. **Document Sharding**: Use the PO agent to shard the PRD and then the Architecture
|
78
|
+
4. **Begin Development**: Start the Core Development Cycle that follows
|
79
|
+
|
80
|
+
### The Core Development Cycle (IDE)
|
81
|
+
|
82
|
+
Once planning is complete and documents are sharded, BMad follows a structured development workflow:
|
83
|
+
|
84
|
+
```mermaid
|
85
|
+
graph TD
|
86
|
+
A["Development Phase Start"] --> B["SM: Reviews Previous Story Dev/QA Notes"]
|
87
|
+
B --> B2["SM: Drafts Next Story from Sharded Epic + Architecture"]
|
88
|
+
B2 --> B3{"PO: Validate Story Draft (Optional)"}
|
89
|
+
B3 -->|Validation Requested| B4["PO: Validate Story Against Artifacts"]
|
90
|
+
B3 -->|Skip Validation| C{"User Approval"}
|
91
|
+
B4 --> C
|
92
|
+
C -->|Approved| D["Dev: Sequential Task Execution"]
|
93
|
+
C -->|Needs Changes| B2
|
94
|
+
D --> E["Dev: Implement Tasks + Tests"]
|
95
|
+
E --> F["Dev: Run All Validations"]
|
96
|
+
F --> G["Dev: Mark Ready for Review + Add Notes"]
|
97
|
+
G --> H{"User Verification"}
|
98
|
+
H -->|Request QA Review| I["QA: Senior Dev Review + Active Refactoring"]
|
99
|
+
H -->|Approve Without QA| M["IMPORTANT: Verify All Regression Tests and Linting are Passing"]
|
100
|
+
I --> J["QA: Review, Refactor Code, Add Tests, Document Notes"]
|
101
|
+
J --> L{"QA Decision"}
|
102
|
+
L -->|Needs Dev Work| D
|
103
|
+
L -->|Approved| M
|
104
|
+
H -->|Needs Fixes| D
|
105
|
+
M --> N["IMPORTANT: COMMIT YOUR CHANGES BEFORE PROCEEDING!"]
|
106
|
+
N --> K["Mark Story as Done"]
|
107
|
+
K --> B
|
108
|
+
|
109
|
+
style A fill:#f5f5f5,color:#000
|
110
|
+
style B fill:#e8f5e9,color:#000
|
111
|
+
style B2 fill:#e8f5e9,color:#000
|
112
|
+
style B3 fill:#e3f2fd,color:#000
|
113
|
+
style B4 fill:#fce4ec,color:#000
|
114
|
+
style C fill:#e3f2fd,color:#000
|
115
|
+
style D fill:#e3f2fd,color:#000
|
116
|
+
style E fill:#e3f2fd,color:#000
|
117
|
+
style F fill:#e3f2fd,color:#000
|
118
|
+
style G fill:#e3f2fd,color:#000
|
119
|
+
style H fill:#e3f2fd,color:#000
|
120
|
+
style I fill:#f9ab00,color:#fff
|
121
|
+
style J fill:#ffd54f,color:#000
|
122
|
+
style K fill:#34a853,color:#fff
|
123
|
+
style L fill:#e3f2fd,color:#000
|
124
|
+
style M fill:#ff5722,color:#fff
|
125
|
+
style N fill:#d32f2f,color:#fff
|
126
|
+
```
|
127
|
+
|
128
|
+
## Installation
|
129
|
+
|
130
|
+
### Optional
|
131
|
+
|
132
|
+
If you want to do the planning in the Web with Claude (Sonnet 4 or Opus), Gemini Gem (2.5 Pro), or Custom GPT's:
|
133
|
+
|
134
|
+
1. Navigate to `dist/teams/`
|
135
|
+
2. Copy `team-fullstack.txt`
|
136
|
+
3. Create new Gemini Gem or CustomGPT
|
137
|
+
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
|
138
|
+
5. Type `/help` to see available commands
|
139
|
+
|
140
|
+
### IDE Project Setup
|
141
|
+
|
142
|
+
```bash
|
143
|
+
# Interactive installation (recommended)
|
144
|
+
npx bmad-method install
|
145
|
+
```
|
146
|
+
|
147
|
+
## Special Agents
|
148
|
+
|
149
|
+
There are two bmad agents - in the future they will be consolidated into the single bmad-master.
|
150
|
+
|
151
|
+
### BMad-Master
|
152
|
+
|
153
|
+
This agent can do any task or command that all other agents can do, aside from actual story implementation. Additionally, this agent can help explain the BMad Method when in the web by accessing the knowledge base and explaining anything to you about the process.
|
154
|
+
|
155
|
+
If you don't want to bother switching between different agents aside from the dev, this is the agent for you. Just remember that as the context grows, the performance of the agent degrades, therefore it is important to instruct the agent to compact the conversation and start a new conversation with the compacted conversation as the initial message. Do this often, preferably after each story is implemented.
|
156
|
+
|
157
|
+
### BMad-Orchestrator
|
158
|
+
|
159
|
+
This agent should NOT be used within the IDE, it is a heavy weight special purpose agent that utilizes a lot of context and can morph into any other agent. This exists solely to facilitate the team's within the web bundles. If you use a web bundle you will be greeted by the BMad Orchestrator.
|
160
|
+
|
161
|
+
### How Agents Work
|
162
|
+
|
163
|
+
#### Dependencies System
|
164
|
+
|
165
|
+
Each agent has a YAML section that defines its dependencies:
|
166
|
+
|
167
|
+
```yaml
|
168
|
+
dependencies:
|
169
|
+
templates:
|
170
|
+
- prd-template.md
|
171
|
+
- user-story-template.md
|
172
|
+
tasks:
|
173
|
+
- create-doc.md
|
174
|
+
- shard-doc.md
|
175
|
+
data:
|
176
|
+
- bmad-kb.md
|
177
|
+
```
|
178
|
+
|
179
|
+
**Key Points:**
|
180
|
+
|
181
|
+
- Agents only load resources they need (lean context)
|
182
|
+
- Dependencies are automatically resolved during bundling
|
183
|
+
- Resources are shared across agents to maintain consistency
|
184
|
+
|
185
|
+
#### Agent Interaction
|
186
|
+
|
187
|
+
**In IDE:**
|
188
|
+
|
189
|
+
```bash
|
190
|
+
# Some Ide's, like Cursor or Windsurf for example, utilize manual rules so interaction is done with the '@' symbol
|
191
|
+
@pm Create a PRD for a task management app
|
192
|
+
@architect Design the system architecture
|
193
|
+
@dev Implement the user authentication
|
194
|
+
|
195
|
+
# Some, like Claude Code use slash commands instead
|
196
|
+
/pm Create user stories
|
197
|
+
/dev Fix the login bug
|
198
|
+
```
|
199
|
+
|
200
|
+
#### Interactive Modes
|
201
|
+
|
202
|
+
- **Incremental Mode**: Step-by-step with user input
|
203
|
+
- **YOLO Mode**: Rapid generation with minimal interaction
|
204
|
+
|
205
|
+
## IDE Integration
|
206
|
+
|
207
|
+
### IDE Best Practices
|
208
|
+
|
209
|
+
- **Context Management**: Keep relevant files only in context, keep files as lean and focused as necessary
|
210
|
+
- **Agent Selection**: Use appropriate agent for task
|
211
|
+
- **Iterative Development**: Work in small, focused tasks
|
212
|
+
- **File Organization**: Maintain clean project structure
|
213
|
+
- **Commit Regularly**: Save your work frequently
|
214
|
+
|
215
|
+
## Technical Preferences System
|
216
|
+
|
217
|
+
BMad includes a personalization system through the `technical-preferences.md` file located in `.bmad-core/data/` - this can help bias the PM and Architect to recommend your preferences for design patterns, technology selection, or anything else you would like to put in here.
|
218
|
+
|
219
|
+
### Using with Web Bundles
|
220
|
+
|
221
|
+
When creating custom web bundles or uploading to AI platforms, include your `technical-preferences.md` content to ensure agents have your preferences from the start of any conversation.
|
222
|
+
|
223
|
+
## Core Configuration
|
224
|
+
|
225
|
+
The `bmad-core/core-config.yaml` file is a critical config that enables BMad to work seamlessly with differing project structures, more options will be made available in the future. Currently the most important is the devLoadAlwaysFiles list section in the yaml.
|
226
|
+
|
227
|
+
### Developer Context Files
|
228
|
+
|
229
|
+
Define which files the dev agent should always load:
|
230
|
+
|
231
|
+
```yaml
|
232
|
+
devLoadAlwaysFiles:
|
233
|
+
- docs/architecture/coding-standards.md
|
234
|
+
- docs/architecture/tech-stack.md
|
235
|
+
- docs/architecture/project-structure.md
|
236
|
+
```
|
237
|
+
|
238
|
+
You will want to verify from sharding your architecture that these documents exist, that they are as lean as possible, and contain exactly the information you want your dev agent to ALWAYS load into it's context. These are the rules the agent will follow.
|
239
|
+
|
240
|
+
As your project grows and the code starts to build consistent patterns, coding standards should be reduced to include only the standards that the agent still makes with. The agent will look at surrounding code in files to infer the coding standards that are relevant to the current task.
|
241
|
+
|
242
|
+
## Getting Help
|
243
|
+
|
244
|
+
- **Discord Community**: [Join Discord](https://discord.gg/gk8jAdXWmj)
|
245
|
+
- **GitHub Issues**: [Report bugs](https://github.com/bmadcode/bmad-method/issues)
|
246
|
+
- **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/docs)
|
247
|
+
- **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
|
248
|
+
|
249
|
+
## Conclusion
|
250
|
+
|
251
|
+
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.
|
@@ -0,0 +1,311 @@
|
|
1
|
+
workflow:
|
2
|
+
id: brownfield-fullstack
|
3
|
+
name: Brownfield Full-Stack Enhancement
|
4
|
+
description: >-
|
5
|
+
Agent workflow for enhancing existing full-stack applications with new features,
|
6
|
+
modernization, or significant changes. Handles existing system analysis and safe integration.
|
7
|
+
type: brownfield
|
8
|
+
project_types:
|
9
|
+
- feature-addition
|
10
|
+
- refactoring
|
11
|
+
- modernization
|
12
|
+
- integration-enhancement
|
13
|
+
|
14
|
+
sequence:
|
15
|
+
- step: enhancement_classification
|
16
|
+
agent: analyst
|
17
|
+
action: classify enhancement scope
|
18
|
+
notes: |
|
19
|
+
Determine enhancement complexity to route to appropriate path:
|
20
|
+
- Single story (< 4 hours) → Use brownfield-create-story task
|
21
|
+
- Small feature (1-3 stories) → Use brownfield-create-epic task
|
22
|
+
- Major enhancement (multiple epics) → Continue with full workflow
|
23
|
+
|
24
|
+
Ask user: "Can you describe the enhancement scope? Is this a small fix, a feature addition, or a major enhancement requiring architectural changes?"
|
25
|
+
|
26
|
+
- step: routing_decision
|
27
|
+
condition: based_on_classification
|
28
|
+
routes:
|
29
|
+
single_story:
|
30
|
+
agent: pm
|
31
|
+
uses: brownfield-create-story
|
32
|
+
notes: "Create single story for immediate implementation. Exit workflow after story creation."
|
33
|
+
small_feature:
|
34
|
+
agent: pm
|
35
|
+
uses: brownfield-create-epic
|
36
|
+
notes: "Create focused epic with 1-3 stories. Exit workflow after epic creation."
|
37
|
+
major_enhancement:
|
38
|
+
continue: to_next_step
|
39
|
+
notes: "Continue with comprehensive planning workflow below."
|
40
|
+
|
41
|
+
- step: documentation_check
|
42
|
+
agent: analyst
|
43
|
+
action: check existing documentation
|
44
|
+
condition: major_enhancement_path
|
45
|
+
notes: |
|
46
|
+
Check if adequate project documentation exists:
|
47
|
+
- Look for existing architecture docs, API specs, coding standards
|
48
|
+
- Assess if documentation is current and comprehensive
|
49
|
+
- If adequate: Skip document-project, proceed to PRD
|
50
|
+
- If inadequate: Run document-project first
|
51
|
+
|
52
|
+
- step: project_analysis
|
53
|
+
agent: architect
|
54
|
+
action: analyze existing project and use task document-project
|
55
|
+
creates: brownfield-architecture.md (or multiple documents)
|
56
|
+
condition: documentation_inadequate
|
57
|
+
notes: |
|
58
|
+
Run document-project to capture current system state, technical debt, and constraints. Pass findings to PRD creation.
|
59
|
+
|
60
|
+
For Flutter projects, analyze:
|
61
|
+
- Current Flutter architecture (Clean Architecture compliance)
|
62
|
+
- Feature-based organization structure
|
63
|
+
- State management patterns (Cubit/BLoC usage)
|
64
|
+
- Dependencies and version compatibility
|
65
|
+
- Performance and accessibility compliance
|
66
|
+
|
67
|
+
- agent: pm
|
68
|
+
creates: prd.md
|
69
|
+
uses: brownfield-prd-tmpl
|
70
|
+
requires: existing_documentation_or_analysis
|
71
|
+
notes: |
|
72
|
+
Creates PRD for major enhancement. If document-project was run, reference its output to avoid re-analysis.
|
73
|
+
If skipped, use existing project documentation.
|
74
|
+
SAVE OUTPUT: Copy final prd.md to your project's docs/ folder.
|
75
|
+
|
76
|
+
For Flutter projects, use flutter-mobile-prd-tmpl.yaml to ensure:
|
77
|
+
- Feature-based requirements organization
|
78
|
+
- Clean Architecture layer specifications
|
79
|
+
- Material Design 3 compliance requirements
|
80
|
+
- Mobile-specific performance and accessibility criteria
|
81
|
+
|
82
|
+
- step: architecture_decision
|
83
|
+
agent: pm/architect
|
84
|
+
action: determine if architecture document needed
|
85
|
+
condition: after_prd_creation
|
86
|
+
notes: |
|
87
|
+
Review PRD to determine if architectural planning is needed:
|
88
|
+
- New architectural patterns → Create architecture doc
|
89
|
+
- New libraries/frameworks → Create architecture doc
|
90
|
+
- Platform/infrastructure changes → Create architecture doc
|
91
|
+
- Following existing patterns → Skip to story creation
|
92
|
+
|
93
|
+
- agent: architect
|
94
|
+
creates: architecture.md
|
95
|
+
uses: brownfield-architecture-tmpl
|
96
|
+
requires: prd.md
|
97
|
+
condition: architecture_changes_needed
|
98
|
+
notes: "Creates architecture ONLY for significant architectural changes. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
99
|
+
|
100
|
+
- agent: po
|
101
|
+
validates: all_artifacts
|
102
|
+
uses: po-master-checklist
|
103
|
+
notes: "Validates all documents for integration safety and completeness. May require updates to any document."
|
104
|
+
|
105
|
+
- agent: various
|
106
|
+
updates: any_flagged_documents
|
107
|
+
condition: po_checklist_issues
|
108
|
+
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
|
109
|
+
|
110
|
+
- agent: po
|
111
|
+
action: shard_documents
|
112
|
+
creates: sharded_docs
|
113
|
+
requires: all_artifacts_in_project
|
114
|
+
notes: |
|
115
|
+
Shard documents for IDE development:
|
116
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
117
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
118
|
+
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
119
|
+
|
120
|
+
- agent: sm
|
121
|
+
action: create_story
|
122
|
+
creates: story.md
|
123
|
+
requires: sharded_docs_or_brownfield_docs
|
124
|
+
repeats: for_each_epic_or_enhancement
|
125
|
+
notes: |
|
126
|
+
Story creation cycle:
|
127
|
+
- For sharded PRD: @sm → *create (uses create-next-story)
|
128
|
+
- For brownfield docs: @sm → use create-brownfield-story task
|
129
|
+
- Creates story from available documentation
|
130
|
+
- Story starts in "Draft" status
|
131
|
+
- May require additional context gathering for brownfield
|
132
|
+
|
133
|
+
- agent: analyst/pm
|
134
|
+
action: review_draft_story
|
135
|
+
updates: story.md
|
136
|
+
requires: story.md
|
137
|
+
optional: true
|
138
|
+
condition: user_wants_story_review
|
139
|
+
notes: |
|
140
|
+
OPTIONAL: Review and approve draft story
|
141
|
+
- NOTE: story-review task coming soon
|
142
|
+
- Review story completeness and alignment
|
143
|
+
- Update story status: Draft → Approved
|
144
|
+
|
145
|
+
- agent: dev
|
146
|
+
action: implement_story
|
147
|
+
creates: implementation_files
|
148
|
+
requires: story.md
|
149
|
+
notes: |
|
150
|
+
Dev Agent (New Chat): @dev
|
151
|
+
- Implements approved story
|
152
|
+
- Updates File List with all changes
|
153
|
+
- Marks story as "Review" when complete
|
154
|
+
|
155
|
+
- agent: qa
|
156
|
+
action: review_implementation
|
157
|
+
updates: implementation_files
|
158
|
+
requires: implementation_files
|
159
|
+
optional: true
|
160
|
+
notes: |
|
161
|
+
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
162
|
+
- Senior dev review with refactoring ability
|
163
|
+
- Fixes small issues directly
|
164
|
+
- Leaves checklist for remaining items
|
165
|
+
- Updates story status (Review → Done or stays Review)
|
166
|
+
|
167
|
+
- agent: dev
|
168
|
+
action: address_qa_feedback
|
169
|
+
updates: implementation_files
|
170
|
+
condition: qa_left_unchecked_items
|
171
|
+
notes: |
|
172
|
+
If QA left unchecked items:
|
173
|
+
- Dev Agent (New Chat): Address remaining items
|
174
|
+
- Return to QA for final approval
|
175
|
+
|
176
|
+
- repeat_development_cycle:
|
177
|
+
action: continue_for_all_stories
|
178
|
+
notes: |
|
179
|
+
Repeat story cycle (SM → Dev → QA) for all epic stories
|
180
|
+
Continue until all stories in PRD are complete
|
181
|
+
|
182
|
+
- agent: po
|
183
|
+
action: epic_retrospective
|
184
|
+
creates: epic-retrospective.md
|
185
|
+
condition: epic_complete
|
186
|
+
optional: true
|
187
|
+
notes: |
|
188
|
+
OPTIONAL: After epic completion
|
189
|
+
- NOTE: epic-retrospective task coming soon
|
190
|
+
- Validate epic was completed correctly
|
191
|
+
- Document learnings and improvements
|
192
|
+
|
193
|
+
- workflow_end:
|
194
|
+
action: project_complete
|
195
|
+
notes: |
|
196
|
+
All stories implemented and reviewed!
|
197
|
+
Project development phase complete.
|
198
|
+
|
199
|
+
Reference: {root}/data/bmad-kb.md#IDE Development Workflow
|
200
|
+
|
201
|
+
flow_diagram: |
|
202
|
+
```mermaid
|
203
|
+
graph TD
|
204
|
+
A[Start: Brownfield Enhancement] --> B[analyst: classify enhancement scope]
|
205
|
+
B --> C{Enhancement Size?}
|
206
|
+
|
207
|
+
C -->|Single Story| D[pm: brownfield-create-story]
|
208
|
+
C -->|1-3 Stories| E[pm: brownfield-create-epic]
|
209
|
+
C -->|Major Enhancement| F[analyst: check documentation]
|
210
|
+
|
211
|
+
D --> END1[To Dev Implementation]
|
212
|
+
E --> END2[To Story Creation]
|
213
|
+
|
214
|
+
F --> G{Docs Adequate?}
|
215
|
+
G -->|No| H[architect: document-project]
|
216
|
+
G -->|Yes| I[pm: brownfield PRD]
|
217
|
+
H --> I
|
218
|
+
|
219
|
+
I --> J{Architecture Needed?}
|
220
|
+
J -->|Yes| K[architect: architecture.md]
|
221
|
+
J -->|No| L[po: validate artifacts]
|
222
|
+
K --> L
|
223
|
+
|
224
|
+
L --> M{PO finds issues?}
|
225
|
+
M -->|Yes| N[Fix issues]
|
226
|
+
M -->|No| O[po: shard documents]
|
227
|
+
N --> L
|
228
|
+
|
229
|
+
O --> P[sm: create story]
|
230
|
+
P --> Q{Story Type?}
|
231
|
+
Q -->|Sharded PRD| R[create-next-story]
|
232
|
+
Q -->|Brownfield Docs| S[create-brownfield-story]
|
233
|
+
|
234
|
+
R --> T{Review draft?}
|
235
|
+
S --> T
|
236
|
+
T -->|Yes| U[review & approve]
|
237
|
+
T -->|No| V[dev: implement]
|
238
|
+
U --> V
|
239
|
+
|
240
|
+
V --> W{QA review?}
|
241
|
+
W -->|Yes| X[qa: review]
|
242
|
+
W -->|No| Y{More stories?}
|
243
|
+
X --> Z{Issues?}
|
244
|
+
Z -->|Yes| AA[dev: fix]
|
245
|
+
Z -->|No| Y
|
246
|
+
AA --> X
|
247
|
+
Y -->|Yes| P
|
248
|
+
Y -->|No| AB{Retrospective?}
|
249
|
+
AB -->|Yes| AC[po: retrospective]
|
250
|
+
AB -->|No| AD[Complete]
|
251
|
+
AC --> AD
|
252
|
+
|
253
|
+
style AD fill:#90EE90
|
254
|
+
style END1 fill:#90EE90
|
255
|
+
style END2 fill:#90EE90
|
256
|
+
style D fill:#87CEEB
|
257
|
+
style E fill:#87CEEB
|
258
|
+
style I fill:#FFE4B5
|
259
|
+
style K fill:#FFE4B5
|
260
|
+
style O fill:#ADD8E6
|
261
|
+
style P fill:#ADD8E6
|
262
|
+
style V fill:#ADD8E6
|
263
|
+
style U fill:#F0E68C
|
264
|
+
style X fill:#F0E68C
|
265
|
+
style AC fill:#F0E68C
|
266
|
+
```
|
267
|
+
|
268
|
+
decision_guidance:
|
269
|
+
when_to_use:
|
270
|
+
- Enhancement requires coordinated stories
|
271
|
+
- Architectural changes are needed
|
272
|
+
- Significant integration work required
|
273
|
+
- Risk assessment and mitigation planning necessary
|
274
|
+
- Multiple team members will work on related changes
|
275
|
+
|
276
|
+
handoff_prompts:
|
277
|
+
classification_complete: |
|
278
|
+
Enhancement classified as: {{enhancement_type}}
|
279
|
+
{{if single_story}}: Proceeding with brownfield-create-story task for immediate implementation.
|
280
|
+
{{if small_feature}}: Creating focused epic with brownfield-create-epic task.
|
281
|
+
{{if major_enhancement}}: Continuing with comprehensive planning workflow.
|
282
|
+
|
283
|
+
documentation_assessment: |
|
284
|
+
Documentation assessment complete:
|
285
|
+
{{if adequate}}: Existing documentation is sufficient. Proceeding directly to PRD creation.
|
286
|
+
{{if inadequate}}: Running document-project to capture current system state before PRD.
|
287
|
+
|
288
|
+
document_project_to_pm: |
|
289
|
+
Project analysis complete. Key findings documented in:
|
290
|
+
- {{document_list}}
|
291
|
+
Use these findings to inform PRD creation and avoid re-analyzing the same aspects.
|
292
|
+
|
293
|
+
pm_to_architect_decision: |
|
294
|
+
PRD complete and saved as docs/prd.md.
|
295
|
+
Architectural changes identified: {{yes/no}}
|
296
|
+
{{if yes}}: Proceeding to create architecture document for: {{specific_changes}}
|
297
|
+
{{if no}}: No architectural changes needed. Proceeding to validation.
|
298
|
+
|
299
|
+
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
|
300
|
+
|
301
|
+
po_to_sm: |
|
302
|
+
All artifacts validated.
|
303
|
+
Documentation type available: {{sharded_prd / brownfield_docs}}
|
304
|
+
{{if sharded}}: Use standard create-next-story task.
|
305
|
+
{{if brownfield}}: Use create-brownfield-story task to handle varied documentation formats.
|
306
|
+
|
307
|
+
sm_story_creation: |
|
308
|
+
Creating story from {{documentation_type}}.
|
309
|
+
{{if missing_context}}: May need to gather additional context from user during story creation.
|
310
|
+
|
311
|
+
complete: "All planning artifacts validated and development can begin. Stories will be created based on available documentation format."
|