agentvibes 2.2.1 → 2.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (114) hide show
  1. package/.bmad-core/agent-teams/team-all.yaml +15 -0
  2. package/.bmad-core/agent-teams/team-fullstack.yaml +19 -0
  3. package/.bmad-core/agent-teams/team-ide-minimal.yaml +11 -0
  4. package/.bmad-core/agent-teams/team-no-ui.yaml +14 -0
  5. package/.bmad-core/agents/analyst.md +84 -0
  6. package/.bmad-core/agents/architect.md +85 -0
  7. package/.bmad-core/agents/bmad-master.md +110 -0
  8. package/.bmad-core/agents/bmad-orchestrator.md +147 -0
  9. package/.bmad-core/agents/dev.md +81 -0
  10. package/.bmad-core/agents/pm.md +84 -0
  11. package/.bmad-core/agents/po.md +79 -0
  12. package/.bmad-core/agents/qa.md +87 -0
  13. package/.bmad-core/agents/sm.md +65 -0
  14. package/.bmad-core/agents/ux-expert.md +69 -0
  15. package/.bmad-core/checklists/architect-checklist.md +440 -0
  16. package/.bmad-core/checklists/change-checklist.md +184 -0
  17. package/.bmad-core/checklists/pm-checklist.md +372 -0
  18. package/.bmad-core/checklists/po-master-checklist.md +434 -0
  19. package/.bmad-core/checklists/story-dod-checklist.md +96 -0
  20. package/.bmad-core/checklists/story-draft-checklist.md +155 -0
  21. package/.bmad-core/core-config.yaml +22 -0
  22. package/.bmad-core/data/bmad-kb.md +809 -0
  23. package/.bmad-core/data/brainstorming-techniques.md +38 -0
  24. package/.bmad-core/data/elicitation-methods.md +156 -0
  25. package/.bmad-core/data/technical-preferences.md +5 -0
  26. package/.bmad-core/data/test-levels-framework.md +148 -0
  27. package/.bmad-core/data/test-priorities-matrix.md +174 -0
  28. package/.bmad-core/enhanced-ide-development-workflow.md +248 -0
  29. package/.bmad-core/install-manifest.yaml +230 -0
  30. package/.bmad-core/tasks/advanced-elicitation.md +119 -0
  31. package/.bmad-core/tasks/apply-qa-fixes.md +150 -0
  32. package/.bmad-core/tasks/brownfield-create-epic.md +162 -0
  33. package/.bmad-core/tasks/brownfield-create-story.md +149 -0
  34. package/.bmad-core/tasks/correct-course.md +72 -0
  35. package/.bmad-core/tasks/create-brownfield-story.md +314 -0
  36. package/.bmad-core/tasks/create-deep-research-prompt.md +280 -0
  37. package/.bmad-core/tasks/create-doc.md +103 -0
  38. package/.bmad-core/tasks/create-next-story.md +114 -0
  39. package/.bmad-core/tasks/document-project.md +345 -0
  40. package/.bmad-core/tasks/execute-checklist.md +88 -0
  41. package/.bmad-core/tasks/facilitate-brainstorming-session.md +138 -0
  42. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +53 -0
  43. package/.bmad-core/tasks/index-docs.md +175 -0
  44. package/.bmad-core/tasks/kb-mode-interaction.md +77 -0
  45. package/.bmad-core/tasks/nfr-assess.md +345 -0
  46. package/.bmad-core/tasks/qa-gate.md +163 -0
  47. package/.bmad-core/tasks/review-story.md +316 -0
  48. package/.bmad-core/tasks/risk-profile.md +355 -0
  49. package/.bmad-core/tasks/shard-doc.md +187 -0
  50. package/.bmad-core/tasks/test-design.md +176 -0
  51. package/.bmad-core/tasks/trace-requirements.md +266 -0
  52. package/.bmad-core/tasks/validate-next-story.md +136 -0
  53. package/.bmad-core/templates/architecture-tmpl.yaml +651 -0
  54. package/.bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
  55. package/.bmad-core/templates/brownfield-architecture-tmpl.yaml +477 -0
  56. package/.bmad-core/templates/brownfield-prd-tmpl.yaml +281 -0
  57. package/.bmad-core/templates/competitor-analysis-tmpl.yaml +307 -0
  58. package/.bmad-core/templates/front-end-architecture-tmpl.yaml +219 -0
  59. package/.bmad-core/templates/front-end-spec-tmpl.yaml +350 -0
  60. package/.bmad-core/templates/fullstack-architecture-tmpl.yaml +824 -0
  61. package/.bmad-core/templates/market-research-tmpl.yaml +253 -0
  62. package/.bmad-core/templates/prd-tmpl.yaml +203 -0
  63. package/.bmad-core/templates/project-brief-tmpl.yaml +222 -0
  64. package/.bmad-core/templates/qa-gate-tmpl.yaml +103 -0
  65. package/.bmad-core/templates/story-tmpl.yaml +138 -0
  66. package/.bmad-core/user-guide.md +577 -0
  67. package/.bmad-core/utils/bmad-doc-template.md +327 -0
  68. package/.bmad-core/utils/workflow-management.md +71 -0
  69. package/.bmad-core/workflows/brownfield-fullstack.yaml +298 -0
  70. package/.bmad-core/workflows/brownfield-service.yaml +188 -0
  71. package/.bmad-core/workflows/brownfield-ui.yaml +198 -0
  72. package/.bmad-core/workflows/greenfield-fullstack.yaml +241 -0
  73. package/.bmad-core/workflows/greenfield-service.yaml +207 -0
  74. package/.bmad-core/workflows/greenfield-ui.yaml +236 -0
  75. package/.bmad-core/working-in-the-brownfield.md +606 -0
  76. package/.claude/commands/BMad/analyst.md +88 -0
  77. package/.claude/commands/BMad/architect.md +89 -0
  78. package/.claude/commands/BMad/bmad-master.md +114 -0
  79. package/.claude/commands/BMad/bmad-orchestrator.md +151 -0
  80. package/.claude/commands/BMad/dev.md +85 -0
  81. package/.claude/commands/BMad/pm.md +88 -0
  82. package/.claude/commands/BMad/po.md +83 -0
  83. package/.claude/commands/BMad/qa.md +91 -0
  84. package/.claude/commands/BMad/sm.md +69 -0
  85. package/.claude/commands/BMad/tasks/advanced-elicitation.md +123 -0
  86. package/.claude/commands/BMad/tasks/apply-qa-fixes.md +154 -0
  87. package/.claude/commands/BMad/tasks/brownfield-create-epic.md +166 -0
  88. package/.claude/commands/BMad/tasks/brownfield-create-story.md +153 -0
  89. package/.claude/commands/BMad/tasks/correct-course.md +76 -0
  90. package/.claude/commands/BMad/tasks/create-brownfield-story.md +318 -0
  91. package/.claude/commands/BMad/tasks/create-deep-research-prompt.md +284 -0
  92. package/.claude/commands/BMad/tasks/create-doc.md +107 -0
  93. package/.claude/commands/BMad/tasks/create-next-story.md +118 -0
  94. package/.claude/commands/BMad/tasks/document-project.md +349 -0
  95. package/.claude/commands/BMad/tasks/execute-checklist.md +92 -0
  96. package/.claude/commands/BMad/tasks/facilitate-brainstorming-session.md +142 -0
  97. package/.claude/commands/BMad/tasks/generate-ai-frontend-prompt.md +57 -0
  98. package/.claude/commands/BMad/tasks/index-docs.md +179 -0
  99. package/.claude/commands/BMad/tasks/kb-mode-interaction.md +81 -0
  100. package/.claude/commands/BMad/tasks/nfr-assess.md +349 -0
  101. package/.claude/commands/BMad/tasks/qa-gate.md +167 -0
  102. package/.claude/commands/BMad/tasks/review-story.md +320 -0
  103. package/.claude/commands/BMad/tasks/risk-profile.md +359 -0
  104. package/.claude/commands/BMad/tasks/shard-doc.md +191 -0
  105. package/.claude/commands/BMad/tasks/test-design.md +180 -0
  106. package/.claude/commands/BMad/tasks/trace-requirements.md +270 -0
  107. package/.claude/commands/BMad/tasks/validate-next-story.md +140 -0
  108. package/.claude/commands/BMad/ux-expert.md +73 -0
  109. package/.mcp-minimal.json +27 -0
  110. package/linkedin/vibe-coding-and-pulseaudio.md +121 -0
  111. package/mcp-server/agentvibes.db +0 -0
  112. package/package.json +1 -1
  113. package/scripts/audio-tunnel.config +17 -0
  114. package/sonar +141 -0
@@ -0,0 +1,577 @@
1
+ # BMad Method — 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 the diagrams below don't render, install Markdown All in One along with the Markdown Preview Mermaid Support plugins to VSCode (or one of the forked clones). With these plugins, if you right click on the tab when open, there should be an 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 --> Q{"Early Test Strategy? (Optional)"}
36
+ H2 --> Q
37
+ Q -->|Yes| R["QA: Early Test Architecture Input on High-Risk Areas"]
38
+ Q -->|No| I
39
+ R --> I["PO: Run Master Checklist"]
40
+ I --> J{"Documents Aligned?"}
41
+ J -->|Yes| K["Planning Complete"]
42
+ J -->|No| L["PO: Update Epics & Stories"]
43
+ L --> M["Update PRD/Architecture as needed"]
44
+ M --> I
45
+ K --> N["📁 Switch to IDE (If in a Web Agent Platform)"]
46
+ N --> O["PO: Shard Documents"]
47
+ O --> P["Ready for SM/Dev Cycle"]
48
+
49
+ style A fill:#f5f5f5,color:#000
50
+ style B fill:#e3f2fd,color:#000
51
+ style C fill:#e8f5e9,color:#000
52
+ style C2 fill:#e8f5e9,color:#000
53
+ style C3 fill:#e8f5e9,color:#000
54
+ style D fill:#e8f5e9,color:#000
55
+ style E fill:#fff3e0,color:#000
56
+ style E2 fill:#fff3e0,color:#000
57
+ style F fill:#fff3e0,color:#000
58
+ style F2 fill:#e3f2fd,color:#000
59
+ style F3 fill:#e1f5fe,color:#000
60
+ style F4 fill:#e1f5fe,color:#000
61
+ style G fill:#e3f2fd,color:#000
62
+ style H fill:#f3e5f5,color:#000
63
+ style H2 fill:#f3e5f5,color:#000
64
+ style Q fill:#e3f2fd,color:#000
65
+ style R fill:#ffd54f,color:#000
66
+ style I fill:#f9ab00,color:#fff
67
+ style J fill:#e3f2fd,color:#000
68
+ style K fill:#34a853,color:#fff
69
+ style L fill:#f9ab00,color:#fff
70
+ style M fill:#fff3e0,color:#000
71
+ style N fill:#1a73e8,color:#fff
72
+ style O fill:#f9ab00,color:#fff
73
+ style P fill:#34a853,color:#fff
74
+ ```
75
+
76
+ #### Web UI to IDE Transition
77
+
78
+ **Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow:
79
+
80
+ 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)
81
+ 2. **Switch to IDE**: Open your project in your preferred Agentic IDE
82
+ 3. **Document Sharding**: Use the PO agent to shard the PRD and then the Architecture
83
+ 4. **Begin Development**: Start the Core Development Cycle that follows
84
+
85
+ #### Planning Artifacts (Standard Paths)
86
+
87
+ ```text
88
+ PRD → docs/prd.md
89
+ Architecture → docs/architecture.md
90
+ Sharded Epics → docs/epics/
91
+ Sharded Stories → docs/stories/
92
+ QA Assessments → docs/qa/assessments/
93
+ QA Gates → docs/qa/gates/
94
+ ```
95
+
96
+ ### The Core Development Cycle (IDE)
97
+
98
+ Once planning is complete and documents are sharded, BMad follows a structured development workflow:
99
+
100
+ ```mermaid
101
+ graph TD
102
+ A["Development Phase Start"] --> B["SM: Reviews Previous Story Dev/QA Notes"]
103
+ B --> B2["SM: Drafts Next Story from Sharded Epic + Architecture"]
104
+ B2 --> S{"High-Risk Story? (Optional)"}
105
+ S -->|Yes| T["QA: *risk + *design on Draft Story"]
106
+ S -->|No| B3
107
+ T --> U["Test Strategy & Risk Profile Created"]
108
+ U --> B3{"PO: Validate Story Draft (Optional)"}
109
+ B3 -->|Validation Requested| B4["PO: Validate Story Against Artifacts"]
110
+ B3 -->|Skip Validation| C{"User Approval"}
111
+ B4 --> C
112
+ C -->|Approved| D["Dev: Sequential Task Execution"]
113
+ C -->|Needs Changes| B2
114
+ D --> E["Dev: Implement Tasks + Tests"]
115
+ E --> V{"Mid-Dev QA Check? (Optional)"}
116
+ V -->|Yes| W["QA: *trace or *nfr for Early Validation"]
117
+ V -->|No| F
118
+ W --> X["Dev: Address Coverage/NFR Gaps"]
119
+ X --> F["Dev: Run All Validations"]
120
+ F --> G["Dev: Mark Ready for Review + Add Notes"]
121
+ G --> H{"User Verification"}
122
+ H -->|Request QA Review| I["QA: Test Architect Review + Quality Gate"]
123
+ H -->|Approve Without QA| M["IMPORTANT: Verify All Regression Tests and Linting are Passing"]
124
+ I --> J["QA: Test Architecture Analysis + Active Refactoring"]
125
+ J --> L{"QA Decision"}
126
+ L -->|Needs Dev Work| D
127
+ L -->|Approved| M
128
+ H -->|Needs Fixes| D
129
+ M --> N["IMPORTANT: COMMIT YOUR CHANGES BEFORE PROCEEDING!"]
130
+ N --> Y{"Gate Update Needed?"}
131
+ Y -->|Yes| Z["QA: *gate to Update Status"]
132
+ Y -->|No| K
133
+ Z --> K["Mark Story as Done"]
134
+ K --> B
135
+
136
+ style A fill:#f5f5f5,color:#000
137
+ style B fill:#e8f5e9,color:#000
138
+ style B2 fill:#e8f5e9,color:#000
139
+ style S fill:#e3f2fd,color:#000
140
+ style T fill:#ffd54f,color:#000
141
+ style U fill:#ffd54f,color:#000
142
+ style B3 fill:#e3f2fd,color:#000
143
+ style B4 fill:#fce4ec,color:#000
144
+ style C fill:#e3f2fd,color:#000
145
+ style D fill:#e3f2fd,color:#000
146
+ style E fill:#e3f2fd,color:#000
147
+ style V fill:#e3f2fd,color:#000
148
+ style W fill:#ffd54f,color:#000
149
+ style X fill:#e3f2fd,color:#000
150
+ style F fill:#e3f2fd,color:#000
151
+ style G fill:#e3f2fd,color:#000
152
+ style H fill:#e3f2fd,color:#000
153
+ style I fill:#f9ab00,color:#fff
154
+ style J fill:#ffd54f,color:#000
155
+ style K fill:#34a853,color:#fff
156
+ style L fill:#e3f2fd,color:#000
157
+ style M fill:#ff5722,color:#fff
158
+ style N fill:#d32f2f,color:#fff
159
+ style Y fill:#e3f2fd,color:#000
160
+ style Z fill:#ffd54f,color:#000
161
+ ```
162
+
163
+ ## Prerequisites
164
+
165
+ Before installing BMad Method, ensure you have:
166
+
167
+ - **Node.js** ≥ 18, **npm** ≥ 9
168
+ - **Git** installed and configured
169
+ - **(Optional)** VS Code with "Markdown All in One" + "Markdown Preview Mermaid Support" extensions
170
+
171
+ ## Installation
172
+
173
+ ### Optional
174
+
175
+ If you want to do the planning on the web with Claude (Sonnet 4 or Opus), Gemini Gem (2.5 Pro), or Custom GPTs:
176
+
177
+ 1. Navigate to `dist/teams/`
178
+ 2. Copy `team-fullstack.txt`
179
+ 3. Create new Gemini Gem or CustomGPT
180
+ 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
181
+ 5. Type `/help` to see available commands
182
+
183
+ ### IDE Project Setup
184
+
185
+ ```bash
186
+ # Interactive installation (recommended)
187
+ npx bmad-method install
188
+ ```
189
+
190
+ ### OpenCode
191
+
192
+ BMAD integrates with OpenCode via a project-level `opencode.jsonc`/`opencode.json` (JSON-only, no Markdown fallback).
193
+
194
+ - Installation:
195
+ - Run `npx bmad-method install` and choose `OpenCode` in the IDE list.
196
+ - The installer will detect an existing `opencode.jsonc`/`opencode.json` or create a minimal `opencode.jsonc` if missing.
197
+ - It will:
198
+ - Ensure `instructions` includes `.bmad-core/core-config.yaml` (and each selected expansion pack’s `config.yaml`).
199
+ - Merge BMAD agents and commands using file references (`{file:./.bmad-core/...}`), idempotently.
200
+ - Preserve other top-level fields and user-defined entries.
201
+
202
+ - Prefixes and collisions:
203
+ - You can opt-in to prefix agent keys with `bmad-` and command keys with `bmad:tasks:` to avoid name collisions.
204
+ - If a key already exists and is not BMAD-managed, the installer will skip it and suggest enabling prefixes.
205
+
206
+ - What gets added:
207
+ - `instructions`: `.bmad-core/core-config.yaml` plus any selected expansion pack `config.yaml` files.
208
+ - `agent`: BMAD agents from core and selected packs.
209
+ - `prompt`: `{file:./.bmad-core/agents/<id>.md}` (or pack path)
210
+ - `mode`: `primary` for orchestrators, otherwise `all`
211
+ - `tools`: `{ write: true, edit: true, bash: true }`
212
+ - `description`: extracted from the agent’s `whenToUse`
213
+ - `command`: BMAD tasks from core and selected packs.
214
+ - `template`: `{file:./.bmad-core/tasks/<id>.md}` (or pack path)
215
+ - `description`: extracted from the task’s “Purpose” section
216
+
217
+ - Selected Packages Only:
218
+ - The installer includes agents and tasks only from the packages you selected in the earlier step (core and chosen packs).
219
+
220
+ - Refresh after changes:
221
+ - Re-run:
222
+ ```bash
223
+ npx bmad-method install -f -i opencode
224
+ ```
225
+ - The installer safely updates entries without duplication and preserves your custom fields and comments.
226
+
227
+ - Optional convenience script:
228
+ - You can add a script to your project’s `package.json` for quick refreshes:
229
+ ```json
230
+ {
231
+ "scripts": {
232
+ "bmad:opencode": "bmad-method install -f -i opencode"
233
+ }
234
+ }
235
+ ```
236
+
237
+ ### Codex (CLI & Web)
238
+
239
+ BMAD integrates with OpenAI Codex via `AGENTS.md` and committed core agent files.
240
+
241
+ - Two installation modes:
242
+ - Codex (local only): keeps `.bmad-core/` ignored for local dev.
243
+ - `npx bmad-method install -f -i codex -d .`
244
+ - Codex Web Enabled: ensures `.bmad-core/` is tracked so you can commit it for Codex Web.
245
+ - `npx bmad-method install -f -i codex-web -d .`
246
+
247
+ - What gets generated:
248
+ - `AGENTS.md` at the project root with a BMAD section containing
249
+ - How-to-use with Codex (CLI & Web)
250
+ - Agent Directory (Title, ID, When To Use)
251
+ - Detailed per‑agent sections with source path, when-to-use, activation phrasing, and YAML
252
+ - Tasks with quick usage notes
253
+ - If a `package.json` exists, helpful scripts are added:
254
+ - `bmad:refresh`, `bmad:list`, `bmad:validate`
255
+
256
+ - Using Codex:
257
+ - CLI: run `codex` in the project root and prompt naturally, e.g., “As dev, implement …”.
258
+ - Web: commit `.bmad-core/` and `AGENTS.md`, then open the repo in Codex and prompt the same way.
259
+
260
+ - Refresh after changes:
261
+ - Re-run the appropriate install mode (`codex` or `codex-web`) to update the BMAD block in `AGENTS.md`.
262
+
263
+ ## Special Agents
264
+
265
+ There are two BMad agents — in the future they'll be consolidated into a single BMad-Master.
266
+
267
+ ### BMad-Master
268
+
269
+ 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 on the web by accessing the knowledge base and explaining anything to you about the process.
270
+
271
+ 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.
272
+
273
+ ### BMad-Orchestrator
274
+
275
+ This agent should NOT be used within the IDE, it is a heavyweight, special-purpose agent that utilizes a lot of context and can morph into any other agent. This exists solely to facilitate the teams within the web bundles. If you use a web bundle you will be greeted by the BMad Orchestrator.
276
+
277
+ ### How Agents Work
278
+
279
+ #### Dependencies System
280
+
281
+ Each agent has a YAML section that defines its dependencies:
282
+
283
+ ```yaml
284
+ dependencies:
285
+ templates:
286
+ - prd-template.md
287
+ - user-story-template.md
288
+ tasks:
289
+ - create-doc.md
290
+ - shard-doc.md
291
+ data:
292
+ - bmad-kb.md
293
+ ```
294
+
295
+ **Key Points:**
296
+
297
+ - Agents only load resources they need (lean context)
298
+ - Dependencies are automatically resolved during bundling
299
+ - Resources are shared across agents to maintain consistency
300
+
301
+ #### Agent Interaction
302
+
303
+ **In IDE:**
304
+
305
+ ```bash
306
+ # Some IDEs, like Cursor or Windsurf for example, utilize manual rules so interaction is done with the '@' symbol
307
+ @pm Create a PRD for a task management app
308
+ @architect Design the system architecture
309
+ @dev Implement the user authentication
310
+
311
+ # Some IDEs, like Claude Code, use slash commands instead
312
+ /pm Create user stories
313
+ /dev Fix the login bug
314
+ ```
315
+
316
+ #### Interactive Modes
317
+
318
+ - **Incremental Mode**: Step-by-step with user input
319
+ - **YOLO Mode**: Rapid generation with minimal interaction
320
+
321
+ ## IDE Integration
322
+
323
+ ### IDE Best Practices
324
+
325
+ - **Context Management**: Keep relevant files only in context, keep files as lean and focused as necessary
326
+ - **Agent Selection**: Use appropriate agent for task
327
+ - **Iterative Development**: Work in small, focused tasks
328
+ - **File Organization**: Maintain clean project structure
329
+ - **Commit Regularly**: Save your work frequently
330
+
331
+ ## The Test Architect (QA Agent)
332
+
333
+ ### Overview
334
+
335
+ The QA agent in BMad is not just a "senior developer reviewer" - it's a **Test Architect** with deep expertise in test strategy, quality gates, and risk-based testing. Named Quinn, this agent provides advisory authority on quality matters while actively improving code when safe to do so.
336
+
337
+ #### Quick Start (Essential Commands)
338
+
339
+ ```bash
340
+ @qa *risk {story} # Assess risks before development
341
+ @qa *design {story} # Create test strategy
342
+ @qa *trace {story} # Verify test coverage during dev
343
+ @qa *nfr {story} # Check quality attributes
344
+ @qa *review {story} # Full assessment → writes gate
345
+ ```
346
+
347
+ #### Command Aliases (Test Architect)
348
+
349
+ The documentation uses short forms for convenience. Both styles are valid:
350
+
351
+ ```text
352
+ *risk → *risk-profile
353
+ *design → *test-design
354
+ *nfr → *nfr-assess
355
+ *trace → *trace-requirements (or just *trace)
356
+ *review → *review
357
+ *gate → *gate
358
+ ```
359
+
360
+ ### Core Capabilities
361
+
362
+ #### 1. Risk Profiling (`*risk`)
363
+
364
+ **When:** After story draft, before development begins (earliest intervention point)
365
+
366
+ Identifies and assesses implementation risks:
367
+
368
+ - **Categories**: Technical, Security, Performance, Data, Business, Operational
369
+ - **Scoring**: Probability × Impact analysis (1-9 scale)
370
+ - **Mitigation**: Specific strategies for each identified risk
371
+ - **Gate Impact**: Risks ≥9 trigger FAIL, ≥6 trigger CONCERNS (see `tasks/risk-profile.md` for authoritative rules)
372
+
373
+ #### 2. Test Design (`*design`)
374
+
375
+ **When:** After story draft, before development begins (guides what tests to write)
376
+
377
+ Creates comprehensive test strategies including:
378
+
379
+ - Test scenarios for each acceptance criterion
380
+ - Appropriate test level recommendations (unit vs integration vs E2E)
381
+ - Risk-based prioritization (P0/P1/P2)
382
+ - Test data requirements and mock strategies
383
+ - Execution strategies for CI/CD integration
384
+
385
+ **Example output:**
386
+
387
+ ```yaml
388
+ test_summary:
389
+ total: 24
390
+ by_level:
391
+ unit: 15
392
+ integration: 7
393
+ e2e: 2
394
+ by_priority:
395
+ P0: 8 # Must have - linked to critical risks
396
+ P1: 10 # Should have - medium risks
397
+ P2: 6 # Nice to have - low risks
398
+ ```
399
+
400
+ #### 3. Requirements Tracing (`*trace`)
401
+
402
+ **When:** During development (mid-implementation checkpoint)
403
+
404
+ Maps requirements to test coverage:
405
+
406
+ - Documents which tests validate each acceptance criterion
407
+ - Uses Given-When-Then for clarity (documentation only, not BDD code)
408
+ - Identifies coverage gaps with severity ratings
409
+ - Creates traceability matrix for audit purposes
410
+
411
+ #### 4. NFR Assessment (`*nfr`)
412
+
413
+ **When:** During development or early review (validate quality attributes)
414
+
415
+ Validates non-functional requirements:
416
+
417
+ - **Core Four**: Security, Performance, Reliability, Maintainability
418
+ - **Evidence-Based**: Looks for actual implementation proof
419
+ - **Gate Integration**: NFR failures directly impact quality gates
420
+
421
+ #### 5. Comprehensive Test Architecture Review (`*review`)
422
+
423
+ **When:** After development complete, story marked "Ready for Review"
424
+
425
+ When you run `@qa *review {story}`, Quinn performs:
426
+
427
+ - **Requirements Traceability**: Maps every acceptance criterion to its validating tests
428
+ - **Test Level Analysis**: Ensures appropriate testing at unit, integration, and E2E levels
429
+ - **Coverage Assessment**: Identifies gaps and redundant test coverage
430
+ - **Active Refactoring**: Improves code quality directly when safe
431
+ - **Quality Gate Decision**: Issues PASS/CONCERNS/FAIL status based on findings
432
+
433
+ #### 6. Quality Gates (`*gate`)
434
+
435
+ **When:** After review fixes or when gate status needs updating
436
+
437
+ Manages quality gate decisions:
438
+
439
+ - **Deterministic Rules**: Clear criteria for PASS/CONCERNS/FAIL
440
+ - **Parallel Authority**: QA owns gate files in `docs/qa/gates/`
441
+ - **Advisory Nature**: Provides recommendations, not blocks
442
+ - **Waiver Support**: Documents accepted risks when needed
443
+
444
+ **Note:** Gates are advisory; teams choose their quality bar. WAIVED requires reason, approver, and expiry date. See `templates/qa-gate-tmpl.yaml` for schema and `tasks/review-story.md` (gate rules) and `tasks/risk-profile.md` for scoring.
445
+
446
+ ### Working with the Test Architect
447
+
448
+ #### Integration with BMad Workflow
449
+
450
+ The Test Architect provides value throughout the entire development lifecycle. Here's when and how to leverage each capability:
451
+
452
+ | **Stage** | **Command** | **When to Use** | **Value** | **Output** |
453
+ | ------------------ | ----------- | ----------------------- | -------------------------- | -------------------------------------------------------------- |
454
+ | **Story Drafting** | `*risk` | After SM drafts story | Identify pitfalls early | `docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md` |
455
+ | | `*design` | After risk assessment | Guide dev on test strategy | `docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md` |
456
+ | **Development** | `*trace` | Mid-implementation | Verify test coverage | `docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md` |
457
+ | | `*nfr` | While building features | Catch quality issues early | `docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md` |
458
+ | **Review** | `*review` | Story marked complete | Full quality assessment | QA Results in story + gate file |
459
+ | **Post-Review** | `*gate` | After fixing issues | Update quality decision | Updated `docs/qa/gates/{epic}.{story}-{slug}.yml` |
460
+
461
+ #### Example Commands
462
+
463
+ ```bash
464
+ # Planning Stage - Run these BEFORE development starts
465
+ @qa *risk {draft-story} # What could go wrong?
466
+ @qa *design {draft-story} # What tests should we write?
467
+
468
+ # Development Stage - Run these DURING coding
469
+ @qa *trace {story} # Are we testing everything?
470
+ @qa *nfr {story} # Are we meeting quality standards?
471
+
472
+ # Review Stage - Run when development complete
473
+ @qa *review {story} # Comprehensive assessment + refactoring
474
+
475
+ # Post-Review - Run after addressing issues
476
+ @qa *gate {story} # Update gate status
477
+ ```
478
+
479
+ ### Quality Standards Enforced
480
+
481
+ Quinn enforces these test quality principles:
482
+
483
+ - **No Flaky Tests**: Ensures reliability through proper async handling
484
+ - **No Hard Waits**: Dynamic waiting strategies only
485
+ - **Stateless & Parallel-Safe**: Tests run independently
486
+ - **Self-Cleaning**: Tests manage their own test data
487
+ - **Appropriate Test Levels**: Unit for logic, integration for interactions, E2E for journeys
488
+ - **Explicit Assertions**: Keep assertions in tests, not helpers
489
+
490
+ ### Gate Status Meanings
491
+
492
+ - **PASS**: All critical requirements met, no blocking issues
493
+ - **CONCERNS**: Non-critical issues found, team should review
494
+ - **FAIL**: Critical issues that should be addressed (security risks, missing P0 tests)
495
+ - **WAIVED**: Issues acknowledged but explicitly accepted by team
496
+
497
+ ### Special Situations
498
+
499
+ **High-Risk Stories:**
500
+
501
+ - Always run `*risk` and `*design` before development starts
502
+ - Consider mid-development `*trace` and `*nfr` checkpoints
503
+
504
+ **Complex Integrations:**
505
+
506
+ - Run `*trace` during development to ensure all integration points tested
507
+ - Follow up with `*nfr` to validate performance across integrations
508
+
509
+ **Performance-Critical:**
510
+
511
+ - Run `*nfr` early and often during development
512
+ - Don't wait until review to discover performance issues
513
+
514
+ **Brownfield/Legacy Code:**
515
+
516
+ - Start with `*risk` to identify regression dangers
517
+ - Use `*review` with extra focus on backward compatibility
518
+
519
+ ### Best Practices
520
+
521
+ - **Early Engagement**: Run `*design` and `*risk` during story drafting
522
+ - **Risk-Based Focus**: Let risk scores drive test prioritization
523
+ - **Iterative Improvement**: Use QA feedback to improve future stories
524
+ - **Gate Transparency**: Share gate decisions with the team
525
+ - **Continuous Learning**: QA documents patterns for team knowledge sharing
526
+ - **Brownfield Care**: Pay extra attention to regression risks in existing systems
527
+
528
+ ### Output Paths Reference
529
+
530
+ Quick reference for where Test Architect outputs are stored:
531
+
532
+ ```text
533
+ *risk-profile → docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
534
+ *test-design → docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md
535
+ *trace → docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md
536
+ *nfr-assess → docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
537
+ *review → QA Results section in story + gate file reference
538
+ *gate → docs/qa/gates/{epic}.{story}-{slug}.yml
539
+ ```
540
+
541
+ ## Technical Preferences System
542
+
543
+ 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.
544
+
545
+ ### Using with Web Bundles
546
+
547
+ 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.
548
+
549
+ ## Core Configuration
550
+
551
+ 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.
552
+
553
+ ### Developer Context Files
554
+
555
+ Define which files the dev agent should always load:
556
+
557
+ ```yaml
558
+ devLoadAlwaysFiles:
559
+ - docs/architecture/coding-standards.md
560
+ - docs/architecture/tech-stack.md
561
+ - docs/architecture/project-structure.md
562
+ ```
563
+
564
+ 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 its context. These are the rules the agent will follow.
565
+
566
+ As your project grows and the code starts to build consistent patterns, coding standards should be reduced to include only the standards the agent still needs enforced. The agent will look at surrounding code in files to infer the coding standards that are relevant to the current task.
567
+
568
+ ## Getting Help
569
+
570
+ - **Discord Community**: [Join Discord](https://discord.gg/gk8jAdXWmj)
571
+ - **GitHub Issues**: [Report bugs](https://github.com/bmadcode/bmad-method/issues)
572
+ - **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/docs)
573
+ - **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
574
+
575
+ ## Conclusion
576
+
577
+ 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.