mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
workflow drastic simplification and more reliable
This commit is contained in:
Brian Madison
@@ -16,21 +16,20 @@ agent:
|
||||
principles: |
|
||||
- Channel expert business analysis frameworks: draw upon Porter's Five Forces, SWOT analysis, root cause analysis, and competitive intelligence methodologies to uncover what others miss. Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence.
|
||||
- Articulate requirements with absolute precision. Ensure all stakeholder voices heard.
|
||||
- Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`
|
||||
|
||||
menu:
|
||||
- trigger: BP or fuzzy match on brainstorm-project
|
||||
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
|
||||
data: "{project-root}/_bmad/bmm/data/project-context-template.md"
|
||||
description: "[BP] Project Brainstorming: Expert Guided Facilitation through a single or multiple techniques with a final report"
|
||||
description: "[BP] Brainstorm Project: Expert Guided Facilitation through a single or multiple techniques with a final report"
|
||||
|
||||
- trigger: RS or fuzzy match on research
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
||||
description: "[RS] Research: Choose from or specify market, domain, competitive analysis, or technical research"
|
||||
|
||||
- trigger: PB or fuzzy match on product-brief
|
||||
- trigger: CB or fuzzy match on product-brief
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||
description: "[PB] Product Brief: A guided experience to nail down your product idea and use it as an input to define the requirements later"
|
||||
description: "[CB] Create Brief: A guided experience to nail down your product idea into an executive brief"
|
||||
|
||||
- trigger: DP or fuzzy match on document-project
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
|
||||
@@ -17,7 +17,6 @@ agent:
|
||||
- Channel expert lean architecture wisdom: draw upon deep knowledge of distributed systems, cloud patterns, scalability trade-offs, and what actually ships successfully
|
||||
- User journeys drive technical decisions. Embrace boring technology for stability.
|
||||
- Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact.
|
||||
- Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`
|
||||
|
||||
menu:
|
||||
- trigger: CA or fuzzy match on create-architecture
|
||||
|
||||
@@ -19,7 +19,6 @@ agent:
|
||||
- PRDs emerge from user interviews, not template filling - discover what users actually need
|
||||
- Ship the smallest thing that validates the assumption - iteration over perfection
|
||||
- Technical feasibility is a constraint, not the driver - user value first
|
||||
- Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`
|
||||
|
||||
menu:
|
||||
- trigger: CP or fuzzy match on create-prd
|
||||
@@ -34,9 +33,9 @@ agent:
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
|
||||
description: "[EP] Edit PRD: Update an existing Product Requirements Document"
|
||||
|
||||
- trigger: ES or fuzzy match on epics-stories
|
||||
- trigger: CE or fuzzy match on epics-stories
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
|
||||
description: "[ES] Epics Stories: Create the Epics and Stories Listing, these are the specs that will drive development"
|
||||
description: "[CE] Create Epics and Stories: Create the Epics and Stories Listing, these are the specs that will drive development"
|
||||
|
||||
- trigger: IR or fuzzy match on implementation-readiness
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
|
||||
@@ -14,15 +14,8 @@ agent:
|
||||
identity: Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.
|
||||
communication_style: "Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity."
|
||||
principles: |
|
||||
- Strict boundaries between story prep and implementation
|
||||
- Stories are single source of truth
|
||||
- Perfect alignment between PRD and dev execution
|
||||
- Enable efficient sprints
|
||||
- Deliver developer-ready specs with precise handoffs
|
||||
|
||||
critical_actions:
|
||||
- "When running *create-story, always run as *yolo. Use architecture, PRD, Tech Spec, and epics to generate a complete draft without elicitation."
|
||||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
- I strive to be a servant leader and conduct myself accordingly, helping with any task and offering suggestions
|
||||
- I love to talk about Agile process and theory whenever anyone wants to talk about it
|
||||
|
||||
menu:
|
||||
- trigger: SP or fuzzy match on sprint-planning
|
||||
|
||||
@@ -28,7 +28,6 @@ agent:
|
||||
- "Consult {project-root}/_bmad/bmm/testarch/tea-index.csv to select knowledge fragments under knowledge/ and load only the files needed for the current task"
|
||||
- "Load the referenced fragment(s) from {project-root}/_bmad/bmm/testarch/knowledge/ before giving recommendations"
|
||||
- "Cross-check recommendations with the current official Playwright, Cypress, Pact, and CI platform documentation"
|
||||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: TF or fuzzy match on test-framework
|
||||
|
||||
@@ -21,6 +21,6 @@ agent:
|
||||
- Data-informed but always creative
|
||||
|
||||
menu:
|
||||
- trigger: UX or fuzzy match on ux-design
|
||||
- trigger: CU or fuzzy match on ux-design
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
||||
description: "[UX] UX: Guidance through realizing the plan for your UX to inform architecture and implementation. PRovides more details that what was discovered in the PRD"
|
||||
description: "[CU] Create UX: Guidance through realizing the plan for your UX to inform architecture and implementation. PRovides more details that what was discovered in the PRD"
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# BMM Module Data
|
||||
|
||||
This directory contains module-specific data files used by BMM agents and workflows.
|
||||
|
||||
## Files
|
||||
|
||||
### `project-context-template.md`
|
||||
|
||||
Template for project-specific brainstorming context. Used by:
|
||||
|
||||
- Analyst agent `brainstorm-project` command
|
||||
- Core brainstorming workflow when called with context
|
||||
|
||||
### `documentation-standards.md`
|
||||
|
||||
BMAD documentation standards and guidelines. Used by:
|
||||
|
||||
- Tech Writer agent (critical action loading)
|
||||
- Various documentation workflows
|
||||
- Standards validation and review processes
|
||||
|
||||
## Purpose
|
||||
|
||||
Separates module-specific data from core workflow implementations, maintaining clean architecture:
|
||||
|
||||
- Core workflows remain generic and reusable
|
||||
- Module-specific templates and standards are properly scoped
|
||||
- Data files can be easily maintained and updated
|
||||
- Clear separation of concerns between core and module functionality
|
||||
@@ -1,103 +0,0 @@
|
||||
# BMad Enterprise Method - Brownfield
|
||||
# Extended enterprise planning for complex brownfield with security/devops/test (30+ stories typically)
|
||||
|
||||
method_name: "BMad Enterprise Method"
|
||||
track: "enterprise-bmad-method"
|
||||
field_type: "brownfield"
|
||||
description: "Enterprise-grade planning for complex brownfield additions with extended requirements"
|
||||
|
||||
phases:
|
||||
- phase: 0
|
||||
name: "Documentation"
|
||||
conditional: "if_undocumented"
|
||||
note: "Prerequisite for brownfield without docs"
|
||||
workflows:
|
||||
- id: "document-project"
|
||||
required: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:document-project"
|
||||
output: "Comprehensive project documentation"
|
||||
purpose: "Understand existing codebase before planning"
|
||||
- phase: 1
|
||||
name: "Analysis (Optional)"
|
||||
optional: true
|
||||
note: "User-selected during workflow-init"
|
||||
workflows:
|
||||
- id: "brainstorm-project"
|
||||
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:brainstorming"
|
||||
included_by: "user_choice"
|
||||
note: "Uses core brainstorming workflow with project context template"
|
||||
- id: "research"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:research"
|
||||
included_by: "user_choice"
|
||||
note: "Can have multiple research workflows"
|
||||
- id: "product-brief"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:create-product-brief"
|
||||
included_by: "user_choice"
|
||||
note: "Recommended for greenfield Method projects"
|
||||
- phase: 2
|
||||
name: "Planning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "prd"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
|
||||
required: true
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-prd"
|
||||
output: "Product Requirements Document with FRs and NFRs"
|
||||
- id: "create-ux-design"
|
||||
conditional: "if_has_ui"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
||||
agent: "ux-designer"
|
||||
command: "/bmad:bmm:workflows:create-ux-design"
|
||||
note: "Determined after PRD - user/agent decides if needed"
|
||||
- phase: 3
|
||||
name: "Solutioning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "create-architecture"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:create-architecture"
|
||||
output: "System architecture document"
|
||||
note: "Complete system design for greenfield projects"
|
||||
- id: "create-epics-and-stories"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-epics-and-stories"
|
||||
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
|
||||
- id: "test-design"
|
||||
optional: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
agent: "tea"
|
||||
command: "/bmad:bmm:workflows:test-design"
|
||||
output: "System-level testability review"
|
||||
note: "Testability assessment before gate check - auto-detects system-level mode"
|
||||
- id: "implementation-readiness"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:implementation-readiness"
|
||||
note: "Validates PRD + Architecture + Epics + UX (optional)"
|
||||
- phase: 4
|
||||
name: "Implementation"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "sprint-planning"
|
||||
required: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
agent: "sm"
|
||||
command: "/bmad:bmm:workflows:sprint-planning"
|
||||
note: "Creates sprint plan - subsequent work tracked there"
|
||||
@@ -1,100 +0,0 @@
|
||||
# BMad Enterprise Method - Greenfield
|
||||
# Extended enterprise planning with security/devops/test for greenfield (30+ stories typically)
|
||||
|
||||
method_name: "Enterprise BMad Method"
|
||||
track: "enterprise-bmad-method"
|
||||
field_type: "greenfield"
|
||||
description: "Complete enterprise-grade planning with security, devops, and test strategy"
|
||||
|
||||
phases:
|
||||
- phase: 1
|
||||
name: "Analysis (Optional)"
|
||||
optional: true
|
||||
note: "User-selected during workflow-init"
|
||||
workflows:
|
||||
- id: "brainstorm-project"
|
||||
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:brainstorming"
|
||||
included_by: "user_choice"
|
||||
note: "Uses core brainstorming workflow with project context template"
|
||||
|
||||
- id: "research"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:research"
|
||||
included_by: "user_choice"
|
||||
note: "Can have multiple research workflows"
|
||||
|
||||
- id: "product-brief"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:create-product-brief"
|
||||
included_by: "user_choice"
|
||||
note: "Recommended for greenfield Method projects"
|
||||
|
||||
- phase: 2
|
||||
name: "Planning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "prd"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
|
||||
required: true
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-prd"
|
||||
output: "Product Requirements Document with FRs and NFRs"
|
||||
|
||||
- id: "create-ux-design"
|
||||
conditional: "if_has_ui"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
||||
agent: "ux-designer"
|
||||
command: "/bmad:bmm:workflows:create-ux-design"
|
||||
note: "Determined after PRD - user/agent decides if needed"
|
||||
|
||||
- phase: 3
|
||||
name: "Solutioning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "create-architecture"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:create-architecture"
|
||||
output: "System architecture document"
|
||||
note: "Complete system design for greenfield projects"
|
||||
|
||||
- id: "create-epics-and-stories"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-epics-and-stories"
|
||||
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
|
||||
|
||||
- id: "test-design"
|
||||
optional: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
agent: "tea"
|
||||
command: "/bmad:bmm:workflows:test-design"
|
||||
output: "System-level testability review"
|
||||
note: "Testability assessment before gate check - auto-detects system-level mode"
|
||||
|
||||
- id: "implementation-readiness"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:implementation-readiness"
|
||||
note: "Validates PRD + Architecture + Epics + UX (optional)"
|
||||
|
||||
- phase: 4
|
||||
name: "Implementation"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "sprint-planning"
|
||||
required: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
agent: "sm"
|
||||
command: "/bmad:bmm:workflows:sprint-planning"
|
||||
note: "Creates sprint plan - subsequent work tracked there"
|
||||
@@ -1,103 +0,0 @@
|
||||
# BMad Method - Brownfield
|
||||
# Full product + architecture planning for complex brownfield additions (10-50+ stories typically)
|
||||
|
||||
method_name: "BMad Method"
|
||||
track: "bmad-method"
|
||||
field_type: "brownfield"
|
||||
description: "Complete product and system design for complex brownfield work"
|
||||
|
||||
phases:
|
||||
- phase: 0
|
||||
name: "Documentation"
|
||||
conditional: "if_undocumented"
|
||||
note: "Prerequisite for brownfield without docs"
|
||||
workflows:
|
||||
- id: "document-project"
|
||||
required: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:document-project"
|
||||
output: "Comprehensive project documentation"
|
||||
purpose: "Understand existing codebase before planning"
|
||||
- phase: 1
|
||||
name: "Analysis (Optional)"
|
||||
optional: true
|
||||
note: "User-selected during workflow-init"
|
||||
workflows:
|
||||
- id: "brainstorm-project"
|
||||
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:brainstorming"
|
||||
included_by: "user_choice"
|
||||
note: "Uses core brainstorming workflow with project context template"
|
||||
- id: "research"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:research"
|
||||
included_by: "user_choice"
|
||||
note: "Can have multiple research workflows"
|
||||
- id: "product-brief"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:create-product-brief"
|
||||
included_by: "user_choice"
|
||||
note: "Recommended for greenfield Method projects"
|
||||
- phase: 2
|
||||
name: "Planning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "prd"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
|
||||
required: true
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-prd"
|
||||
output: "Product Requirements Document with FRs and NFRs"
|
||||
- id: "create-ux-design"
|
||||
conditional: "if_has_ui"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
||||
agent: "ux-designer"
|
||||
command: "/bmad:bmm:workflows:create-ux-design"
|
||||
note: "Determined after PRD - user/agent decides if needed"
|
||||
- phase: 3
|
||||
name: "Solutioning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "create-architecture"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:create-architecture"
|
||||
output: "System architecture document"
|
||||
note: "Complete system design for greenfield projects"
|
||||
- id: "create-epics-and-stories"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-epics-and-stories"
|
||||
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
|
||||
- id: "test-design"
|
||||
optional: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
agent: "tea"
|
||||
command: "/bmad:bmm:workflows:test-design"
|
||||
output: "System-level testability review"
|
||||
note: "Testability assessment before gate check - auto-detects system-level mode"
|
||||
- id: "implementation-readiness"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:implementation-readiness"
|
||||
note: "Validates PRD + Architecture + Epics + UX (optional)"
|
||||
- phase: 4
|
||||
name: "Implementation"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "sprint-planning"
|
||||
required: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
agent: "sm"
|
||||
command: "/bmad:bmm:workflows:sprint-planning"
|
||||
note: "Creates sprint plan - subsequent work tracked there"
|
||||
@@ -1,100 +0,0 @@
|
||||
# BMad Method - Greenfield
|
||||
# Full product + architecture planning for greenfield projects (10-50+ stories typically)
|
||||
|
||||
method_name: "BMad Method"
|
||||
track: "bmad-method"
|
||||
field_type: "greenfield"
|
||||
description: "Complete product and system design methodology for greenfield projects"
|
||||
|
||||
phases:
|
||||
- phase: 1
|
||||
name: "Analysis (Optional)"
|
||||
optional: true
|
||||
note: "User-selected during workflow-init"
|
||||
workflows:
|
||||
- id: "brainstorm-project"
|
||||
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:brainstorming"
|
||||
included_by: "user_choice"
|
||||
note: "Uses core brainstorming workflow with project context template"
|
||||
|
||||
- id: "research"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:research"
|
||||
included_by: "user_choice"
|
||||
note: "Can have multiple research workflows"
|
||||
|
||||
- id: "product-brief"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||
optional: true
|
||||
agent: "analyst"
|
||||
command: "/bmad:bmm:workflows:create-product-brief"
|
||||
included_by: "user_choice"
|
||||
note: "Recommended for greenfield Method projects"
|
||||
|
||||
- phase: 2
|
||||
name: "Planning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "prd"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
|
||||
required: true
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-prd"
|
||||
output: "Product Requirements Document with FRs and NFRs"
|
||||
|
||||
- id: "create-ux-design"
|
||||
conditional: "if_has_ui"
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
||||
agent: "ux-designer"
|
||||
command: "/bmad:bmm:workflows:create-ux-design"
|
||||
note: "Determined after PRD - user/agent decides if needed"
|
||||
|
||||
- phase: 3
|
||||
name: "Solutioning"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "create-architecture"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:create-architecture"
|
||||
output: "System architecture document"
|
||||
note: "Complete system design for greenfield projects"
|
||||
|
||||
- id: "create-epics-and-stories"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
|
||||
agent: "pm"
|
||||
command: "/bmad:bmm:workflows:create-epics-and-stories"
|
||||
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
|
||||
|
||||
- id: "test-design"
|
||||
optional: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
agent: "tea"
|
||||
command: "/bmad:bmm:workflows:test-design"
|
||||
output: "System-level testability review"
|
||||
note: "Testability assessment before gate check - auto-detects system-level mode"
|
||||
|
||||
- id: "implementation-readiness"
|
||||
required: true
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
agent: "architect"
|
||||
command: "/bmad:bmm:workflows:implementation-readiness"
|
||||
note: "Validates PRD + Architecture + Epics + UX (optional)"
|
||||
|
||||
- phase: 4
|
||||
name: "Implementation"
|
||||
required: true
|
||||
workflows:
|
||||
- id: "sprint-planning"
|
||||
required: true
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
agent: "sm"
|
||||
command: "/bmad:bmm:workflows:sprint-planning"
|
||||
note: "Creates sprint plan - subsequent work tracked there"
|
||||
@@ -17,24 +17,10 @@ This brainstorming session focuses on software and product development considera
|
||||
|
||||
### Integration with Project Workflow
|
||||
|
||||
Brainstorming results will feed into:
|
||||
Brainstorming results might feed into:
|
||||
|
||||
- Product Briefs for initial product vision
|
||||
- PRDs for detailed requirements
|
||||
- Technical Specifications for architecture plans
|
||||
- Research Activities for validation needs
|
||||
|
||||
### Expected Outcomes
|
||||
|
||||
Capture:
|
||||
|
||||
1. Problem Statements - Clearly defined user challenges
|
||||
2. Solution Concepts - High-level approach descriptions
|
||||
3. Feature Priorities - Categorized by importance and feasibility
|
||||
4. Technical Considerations - Architecture and implementation thoughts
|
||||
5. Next Steps - Actions needed to advance concepts
|
||||
6. Integration Points - Connections to downstream workflows
|
||||
|
||||
---
|
||||
|
||||
_Use this template to provide project-specific context for brainstorming sessions. Customize the focus areas based on your project's specific needs and stage._
|
||||
|
||||
18
src/bmm/data/workflows.csv
Normal file
18
src/bmm/data/workflows.csv
Normal file
@@ -0,0 +1,18 @@
|
||||
phase,name,code,sequence,workflow-file,command,required,agent,options,description
|
||||
0,Document Project,DP,10,_bmad/bmm/workflows/document-project/workflow.yaml,bmm:document-project,false,analyst,Create Mode,Analyze an existing project to produce useful documentation
|
||||
1,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmm:brainstorming,false,analyst,data=_bmad/bmm/data/project-context-template.md,Expert Guided Facilitation through a single or multiple techniques
|
||||
1,Research,RS,20,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmm:research,false,analyst,Create Mode,Choose from or specify market domain competitive analysis or technical research
|
||||
1,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmm:create-brief,false,analyst,Create Mode,A guided experience to nail down your product idea
|
||||
1,Validate Brief,VB,40,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmm:validate-brief,false,analyst,Validate Mode,Validates product brief completeness
|
||||
2,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmm:create-prd,true,pm,Create Mode,Expert led facilitation to produce your Product Requirements Document
|
||||
2,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmm:validate-prd,false,pm,Validate Mode,Validate PRD is comprehensive lean well organized and cohesive
|
||||
2,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmm:create-ux,false,ux-designer,Create Mode,Guidance through realizing the plan for your UX
|
||||
2,Validate UX,VU,40,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmm:validate-ux,false,ux-designer,Validate Mode,Validates UX design deliverables
|
||||
3,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmm:create-architecture,true,architect,Create Mode,Guided Workflow to document technical decisions
|
||||
3,Validate Architecture,VA,20,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmm:validate-architecture,false,architect,Validate Mode,Validates architecture completeness
|
||||
3,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmm:create-epics-and-stories,true,pm,Create Mode,Create the Epics and Stories Listing
|
||||
3,Validate Epics and Stories,VE,40,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmm:validate-epics-and-stories,false,pm,Validate Mode,Validates epics and stories completeness
|
||||
3,Test Design,TD,50,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmm:test-design,false,tea,Create Mode,Create comprehensive test scenarios ahead of development
|
||||
3,Validate Test Design,VT,60,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmm:validate-test-design,false,tea,Validate Mode,Validates test design coverage
|
||||
3,Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmm:implementation-readiness,true,architect,Validate Mode,Ensure PRD UX Architecture and Epics Stories are aligned
|
||||
4,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmm:sprint-planning,true,sm,Create Mode,Generate sprint plan for development tasks
|
||||
|
44
src/bmm/tasks/whats-after.md
Normal file
44
src/bmm/tasks/whats-after.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: whats-next
|
||||
description: Show what workflow steps come next in the BMad Method based on what's been completed
|
||||
---
|
||||
|
||||
# Task: What's Next?
|
||||
|
||||
## INPUT
|
||||
|
||||
Task input argument may provide:
|
||||
- A workflow **name** just completed (e.g., "validating the UX", "Create PRD", "done with architecture")
|
||||
- A workflow **code** (e.g., "VU", "CP", "CA")
|
||||
- Nothing - in which case you should infer from context or ask
|
||||
|
||||
## CONTEXT INFERENCE
|
||||
|
||||
If no explicit workflow is provided, check the conversation context:
|
||||
- Did someone recently state they completed something? (e.g., "I'm done with my PRD")
|
||||
- Was a workflow just completed in this conversation?
|
||||
- If unclear, ask: "What workflow did you most recently complete?"
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Load `{project-root}/_bmad/bmm/data/workflows.csv` and `{project-root}/_bmad/_config/agent-manifest.csv`. Find all workflow items after the completed row. Present these in a clear, conversational format.
|
||||
|
||||
**Phases reference:** Phase 0 (Any Time), Phase 1 (Analysis), Phase 2 (Planning), Phase 3 (Solutioning), Phase 4 (Implementation)
|
||||
|
||||
**Present the next steps as follows:**
|
||||
|
||||
1. **Optional items first** - List any optional workflows until a required step is reached
|
||||
2. **Required items next** - List the next required workflow
|
||||
3. For each item, show:
|
||||
- The workflow **name**
|
||||
- The **command** (prefixed with `/`, e.g., `/bmm:create-architecture`)
|
||||
- The **agent** displayName and title from the loaded agent-manifest that corresponds with the agent value in each row who can help, e.g., `Winston the Architect`
|
||||
- A brief **description** so the user can decide easily
|
||||
|
||||
**Recommendation format:**
|
||||
- Suggest running each workflow in a **fresh context window** for best results
|
||||
- Option: Load the agent and type the **code** for the menu item, or run the **slash command** with or without loading the agent first
|
||||
- Note: Running without the agent will not include all specifics of the agent personality or any customizations, but will still have aspects of an expert at what will be done.
|
||||
- For **validation workflows**: recommend using a different high-quality LLM if available
|
||||
|
||||
Upon presentation of whats next recommendation - return back to the calling process if one was in progress.
|
||||
@@ -114,12 +114,11 @@ Provide guidance on logical next workflows:
|
||||
- Use brief to validate concept before committing to detailed work
|
||||
- Brief can guide early technical feasibility discussions
|
||||
|
||||
### 4. Present MENU OPTIONS
|
||||
### 4. Congrats to the user
|
||||
|
||||
**Completion Confirmation:**
|
||||
"**Your Product Brief for {{project_name}} is now complete and ready for the next phase!**
|
||||
"**Your Product Brief for {{project_name}} is now complete and ready for the next phase!**"
|
||||
|
||||
The brief captures everything needed to guide subsequent product development:
|
||||
Recap that the brief captures everything needed to guide subsequent product development:
|
||||
|
||||
- Clear vision and problem definition
|
||||
- Deep understanding of target users
|
||||
@@ -127,30 +126,9 @@ The brief captures everything needed to guide subsequent product development:
|
||||
- Focused MVP scope with realistic boundaries
|
||||
- Inspiring long-term vision
|
||||
|
||||
**Suggested Next Steps**
|
||||
### 5. Suggest next steps
|
||||
|
||||
- PRD workflow for detailed requirements?
|
||||
- UX design workflow for user experience planning?
|
||||
|
||||
**Product Brief Complete**"
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- Since this is a completion step, no continuation to other workflow steps
|
||||
- User can ask questions or request review of the completed brief
|
||||
- Provide guidance on next workflow options when requested
|
||||
- End workflow session gracefully after completion confirmation
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- This is a final step with completion focus
|
||||
- No additional workflow steps to load after this
|
||||
- User can request review or clarification of completed brief
|
||||
- Provide clear guidance on next workflow options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN [completion confirmation is provided and workflow status updated], will you then mark the workflow as complete and end the session gracefully. No additional steps are loaded after this final completion step.
|
||||
Execute task `_bmad/bmm/tasks/whats-after.md` with argument `Validate PRD`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -82,70 +82,13 @@ Update the main workflow status file:
|
||||
|
||||
### 3. Suggest Next Steps
|
||||
|
||||
Provide guidance on logical next workflows:
|
||||
|
||||
**Typical Next Workflows:**
|
||||
|
||||
**Immediate Next Steps:**
|
||||
|
||||
1. **Wireframe Generation** - Create detailed wireframes based on UX specification
|
||||
2. **Interactive Prototype** - Build clickable prototypes for user testing
|
||||
3. **Solution Architecture** - Technical architecture design with UX context
|
||||
4. **Figma Design** - High-fidelity visual design implementation
|
||||
|
||||
**Visual Design Workflows:**
|
||||
|
||||
- Wireframe Generation → Interactive Prototype → Figma Design
|
||||
- Component Showcase → AI Frontend Prompt → Design System Implementation
|
||||
|
||||
**Development Workflows:**
|
||||
|
||||
- Solution Architecture → Epic Creation → Development Sprints
|
||||
|
||||
**What would be most valuable to tackle next?**
|
||||
|
||||
### 4. Document Quality Check
|
||||
|
||||
Perform final validation of the UX design:
|
||||
|
||||
**Completeness Check:**
|
||||
|
||||
- Does the specification clearly communicate the design vision?
|
||||
- Are user journeys thoroughly documented?
|
||||
- Are all critical components specified?
|
||||
- Are responsive and accessibility requirements comprehensive?
|
||||
- Is there clear guidance for implementation?
|
||||
|
||||
**Consistency Check:**
|
||||
|
||||
- Do all sections align with the emotional goals?
|
||||
- Is design system integration clearly defined?
|
||||
- Are patterns consistent across all user flows?
|
||||
- Does visual direction match established foundation?
|
||||
Execute task `_bmad/bmm/tasks/whats-after.md` with argument `Create UX`.
|
||||
|
||||
### 5. Final Completion Confirmation
|
||||
|
||||
Confirm completion with user:
|
||||
"**Your UX Design Specification for {{project_name}} is now complete and ready for implementation!**
|
||||
Congratulate the user on the completion you both completed together of the UX.
|
||||
|
||||
**The specification contains everything needed to:**
|
||||
|
||||
- Guide visual designers in creating the final interfaces
|
||||
- Inform developers of all UX requirements and patterns
|
||||
- Ensure consistency across all user interactions
|
||||
- Maintain accessibility and responsive design standards
|
||||
- Provide a foundation for user testing and iteration
|
||||
|
||||
**Ready to continue with:**
|
||||
|
||||
- Wireframe generation for detailed layouts?
|
||||
- Interactive prototype for user testing?
|
||||
- Solution architecture for technical planning?
|
||||
- Visual design implementation?
|
||||
|
||||
**Or would you like to review the complete specification first?**
|
||||
|
||||
[UX Design Workflow Complete]"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
@@ -87,39 +87,7 @@ Offer validation workflows to ensure PRD is ready for implementation:
|
||||
|
||||
### 4. Suggest Next Workflows
|
||||
|
||||
Provide guidance on logical next workflows - strongly suggesting any of these chosen are started in a fresh context with the appropriate agent:
|
||||
|
||||
**Typical Next Workflows:**
|
||||
|
||||
**Immediate Next Steps:**
|
||||
|
||||
1. **PRD Quality Validation First (Recommended):**
|
||||
- execute the `{validationFlow}` workflow if selected or start a new chat with me and select the validate PRD menu item
|
||||
- Ensures PRD is complete and ready
|
||||
- Identifies any gaps or issues
|
||||
- Validates before committing to architecture/design
|
||||
|
||||
2. **UX Design:** `workflow create-ux-design` with the UX-Designer Agent (if UI exists)
|
||||
- User journey insights from step-04 inform interaction design
|
||||
- Functional requirements from step-09 define design scope
|
||||
- Polish-optimized document provides clear design requirements
|
||||
|
||||
3. **Technical Architecture:** `workflow create-architecture` with the Architect Agent
|
||||
- Project-type requirements from step-07 guide technical decisions
|
||||
- Non-functional requirements from step-10 inform architecture choices
|
||||
- Functional requirements define system capabilities
|
||||
|
||||
4. **Epic Breakdown:** `workflow create-epics-and-stories` with me again - but really recommend first doing a UX if needed and an architecture!
|
||||
- Functional requirements from step-09 become epics and stories
|
||||
- Scope definition from step-03 guides sprint planning
|
||||
- Richer when created after UX/architecture
|
||||
|
||||
**Strategic Considerations:**
|
||||
|
||||
- Validation adds confidence before architecture/design investment
|
||||
- UX design and architecture can happen in parallel after validation
|
||||
- Epics/stories are richer when created after UX/architecture
|
||||
- Order depends on team preferences and project needs
|
||||
Execute task `_bmad/bmm/tasks/whats-after.md` with argument `Create PRD`.
|
||||
|
||||
### 5. Final Completion Confirmation
|
||||
|
||||
@@ -149,30 +117,6 @@ Provide guidance on logical next workflows - strongly suggesting any of these ch
|
||||
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
||||
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
||||
|
||||
## WORKFLOW COMPLETION CHECKLIST:
|
||||
|
||||
### Document Structure Complete:
|
||||
|
||||
- [ ] Executive Summary with vision and differentiator
|
||||
- [ ] Success Criteria with measurable outcomes
|
||||
- [ ] Product Scope (MVP, Growth, Vision)
|
||||
- [ ] User Journeys (comprehensive coverage)
|
||||
- [ ] Domain Requirements (if applicable)
|
||||
- [ ] Innovation Analysis (if applicable)
|
||||
- [ ] Project-Type Requirements
|
||||
- [ ] Functional Requirements (capability contract)
|
||||
- [ ] Non-Functional Requirements
|
||||
- [ ] Document polished for flow and coherence
|
||||
|
||||
### Process Complete:
|
||||
|
||||
- [ ] All steps (including polish) completed with user confirmation
|
||||
- [ ] All content saved and optimized
|
||||
- [ ] Frontmatter properly updated
|
||||
- [ ] Workflow status file updated (if exists)
|
||||
- [ ] Validation options presented
|
||||
- [ ] Next steps clearly communicated
|
||||
|
||||
## FINAL REMINDER to give the user:
|
||||
|
||||
The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning.
|
||||
|
||||
@@ -163,7 +163,7 @@ Display:
|
||||
**[R] Review Detailed Findings** - Walk through validation report section by section
|
||||
**[E] Use Edit Workflow** - Use validation report with Edit workflow for systematic improvements
|
||||
**[F] Fix Simpler Items** - Immediate fixes for simple issues (anti-patterns, leakage, missing headers)
|
||||
**[X] Exit** - Exit and review validation report
|
||||
**[X] Exit** - Exit and Suggest Next Steps.
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
@@ -197,8 +197,7 @@ Display:
|
||||
- **IF X (Exit):**
|
||||
- Display: "**Validation Report Saved:** {validationReportPath}"
|
||||
- Display: "**Summary:** {overall status} - {recommendation}"
|
||||
- Display: "**Next Steps:** Review the validation report and address findings. For systematic improvements, consider using Edit workflow when available, or manually fix issues identified in this report."
|
||||
- Exit validation
|
||||
- Exit and Execute task `_bmad/bmm/tasks/whats-after.md` with argument `Validate PRD`.
|
||||
|
||||
- **IF Any other:** Help user, then redisplay menu
|
||||
|
||||
|
||||
@@ -115,6 +115,8 @@ The assessment found [number] issues requiring attention. Review the detailed re
|
||||
|
||||
The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
|
||||
|
||||
Execute task `_bmad/bmm/tasks/whats-after.md` with argument `implementation readiness`.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
@@ -299,7 +299,7 @@ Show the validation results and present choices:
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Address any complex architectural concerns
|
||||
[P] Party Mode - Review validation from different implementation perspectives
|
||||
[C] Continue - Complete the architecture and finish workflow"
|
||||
[C] Continue - Complete the architecture and finish workflow
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
|
||||
@@ -5,7 +5,6 @@
|
||||
- 🛑 NEVER generate content without user input
|
||||
|
||||
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
||||
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
||||
- ✅ ALWAYS treat this as collaborative completion between architectural peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on successful workflow completion and implementation handoff
|
||||
@@ -18,14 +17,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 🎯 Present completion summary and implementation guidance
|
||||
- 📖 Update frontmatter with final workflow state
|
||||
- 🚫 NO MORE STEPS - this is the final step
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Complete architecture document is finished and validated
|
||||
- All architectural decisions, patterns, and structure are documented
|
||||
- Focus on successful completion and implementation preparation
|
||||
- Provide clear guidance for next steps in the development process
|
||||
- 🚫 THIS IS THE FINAL STEP IN THIS WORKFLOW
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
@@ -33,75 +25,11 @@ Complete the architecture workflow, provide a comprehensive completion summary,
|
||||
|
||||
## COMPLETION SEQUENCE:
|
||||
|
||||
### 1. Present Architecture Completion Summary
|
||||
### 1. Congratulate the User on Completion
|
||||
|
||||
Based on user skill level, present the completion:
|
||||
Both you and the User completed something amazing here - give a summary of what you achieved together and really congratulate the user on a job well done.
|
||||
|
||||
**For Expert Users:**
|
||||
"Architecture workflow complete. {{decision_count}} architectural decisions documented across {{step_count}} steps.
|
||||
|
||||
Your architecture is ready for AI agent implementation. All decisions are documented with specific versions and implementation patterns.
|
||||
|
||||
Key deliverables:
|
||||
|
||||
- Complete architecture decision document
|
||||
- Implementation patterns for agent consistency
|
||||
- Project structure with all files and directories
|
||||
- Validation confirming coherence and completeness
|
||||
|
||||
Ready for implementation phase."
|
||||
|
||||
**For Intermediate Users:**
|
||||
"Excellent! Your architecture for {{project_name}} is now complete and ready for implementation.
|
||||
|
||||
**What we accomplished:**
|
||||
|
||||
- Made {{decision_count}} key architectural decisions together
|
||||
- Established implementation patterns to ensure consistency
|
||||
- Created a complete project structure with {{component_count}} main areas
|
||||
- Validated that all your requirements are fully supported
|
||||
|
||||
**Your architecture document includes:**
|
||||
|
||||
- Technology choices with specific versions
|
||||
- Clear implementation patterns for AI agents to follow
|
||||
- Complete project directory structure
|
||||
- Mapping of your requirements to specific files and folders
|
||||
|
||||
The architecture is comprehensive and ready to guide consistent implementation."
|
||||
|
||||
**For Beginner Users:**
|
||||
"Congratulations! Your architecture for {{project_name}} is complete! 🎉
|
||||
|
||||
**What this means:**
|
||||
Think of this as creating the complete blueprint for your house. We've made all the important decisions about how it will be built, what materials to use, and how everything fits together.
|
||||
|
||||
**What we created together:**
|
||||
|
||||
- {{decision_count}} architectural decisions (like choosing the foundation, framing, and systems)
|
||||
- Clear rules so that multiple builders (AI agents) all work the same way
|
||||
- A complete folder structure showing exactly where every file goes
|
||||
- Confirmation that everything you want to build is supported by these decisions
|
||||
|
||||
**What happens next:**
|
||||
AI agents will read this architecture document before building anything. They'll follow all your decisions exactly, which means your app will be built with consistent patterns throughout.
|
||||
|
||||
You're ready for the implementation phase!"
|
||||
|
||||
### 2. Review Final Document State
|
||||
|
||||
Confirm the architecture document is complete:
|
||||
|
||||
**Document Structure Verification:**
|
||||
|
||||
- Project Context Analysis ✅
|
||||
- Starter Template Evaluation ✅
|
||||
- Core Architectural Decisions ✅
|
||||
- Implementation Patterns & Consistency Rules ✅
|
||||
- Project Structure & Boundaries ✅
|
||||
- Architecture Validation Results ✅
|
||||
|
||||
**Frontmatter Update:**
|
||||
### 2. Update the created document's frontmatter
|
||||
|
||||
```yaml
|
||||
stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]
|
||||
@@ -111,216 +39,12 @@ status: 'complete'
|
||||
completedAt: '{{current_date}}'
|
||||
```
|
||||
|
||||
### 3. Implementation Guidance
|
||||
### 3. Next Steps Guidance
|
||||
|
||||
Provide specific next steps for implementation:
|
||||
Execute task `_bmad/bmm/tasks/whats-after.md` with argument `Create Architecture`.
|
||||
|
||||
**Immediate Next Steps:**
|
||||
Upon Completion of task output: offer to answer any questions about the Architecture Document.
|
||||
|
||||
1. **Review the complete architecture document** at `{planning_artifacts}/architecture.md`
|
||||
2. **Begin with project initialization** using the starter template command documented
|
||||
3. **Create first implementation story** for project setup
|
||||
4. **Start implementing user stories** following the architectural decisions
|
||||
|
||||
**Development Workflow:**
|
||||
"AI agents will:
|
||||
|
||||
1. Read the architecture document before implementing each story
|
||||
2. Follow your technology choices and patterns exactly
|
||||
3. Use the project structure we defined
|
||||
4. Maintain consistency across all components"
|
||||
|
||||
**Quality Assurance:**
|
||||
"Your architecture includes:
|
||||
|
||||
- Specific technology versions to use
|
||||
- Implementation patterns that prevent conflicts
|
||||
- Clear project structure and boundaries
|
||||
- Validation that all requirements are supported"
|
||||
|
||||
### 4. Generate Completion Content
|
||||
|
||||
Prepare the final content to append to the document:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Architecture Completion Summary
|
||||
|
||||
### Workflow Completion
|
||||
|
||||
**Architecture Decision Workflow:** COMPLETED ✅
|
||||
**Total Steps Completed:** 8
|
||||
**Date Completed:** {{current_date}}
|
||||
**Document Location:** {planning_artifacts}/architecture.md
|
||||
|
||||
### Final Architecture Deliverables
|
||||
|
||||
**📋 Complete Architecture Document**
|
||||
|
||||
- All architectural decisions documented with specific versions
|
||||
- Implementation patterns ensuring AI agent consistency
|
||||
- Complete project structure with all files and directories
|
||||
- Requirements to architecture mapping
|
||||
- Validation confirming coherence and completeness
|
||||
|
||||
**🏗️ Implementation Ready Foundation**
|
||||
|
||||
- {{decision_count}} architectural decisions made
|
||||
- {{pattern_count}} implementation patterns defined
|
||||
- {{component_count}} architectural components specified
|
||||
- {{requirement_count}} requirements fully supported
|
||||
|
||||
**📚 AI Agent Implementation Guide**
|
||||
|
||||
- Technology stack with verified versions
|
||||
- Consistency rules that prevent implementation conflicts
|
||||
- Project structure with clear boundaries
|
||||
- Integration patterns and communication standards
|
||||
|
||||
### Implementation Handoff
|
||||
|
||||
**For AI Agents:**
|
||||
This architecture document is your complete guide for implementing {{project_name}}. Follow all decisions, patterns, and structures exactly as documented.
|
||||
|
||||
**First Implementation Priority:**
|
||||
{{starter_template_command_or_initialization_step}}
|
||||
|
||||
**Development Sequence:**
|
||||
|
||||
1. Initialize project using documented starter template
|
||||
2. Set up development environment per architecture
|
||||
3. Implement core architectural foundations
|
||||
4. Build features following established patterns
|
||||
5. Maintain consistency with documented rules
|
||||
|
||||
### Quality Assurance Checklist
|
||||
|
||||
**✅ Architecture Coherence**
|
||||
|
||||
- [x] All decisions work together without conflicts
|
||||
- [x] Technology choices are compatible
|
||||
- [x] Patterns support the architectural decisions
|
||||
- [x] Structure aligns with all choices
|
||||
|
||||
**✅ Requirements Coverage**
|
||||
|
||||
- [x] All functional requirements are supported
|
||||
- [x] All non-functional requirements are addressed
|
||||
- [x] Cross-cutting concerns are handled
|
||||
- [x] Integration points are defined
|
||||
|
||||
**✅ Implementation Readiness**
|
||||
|
||||
- [x] Decisions are specific and actionable
|
||||
- [x] Patterns prevent agent conflicts
|
||||
- [x] Structure is complete and unambiguous
|
||||
- [x] Examples are provided for clarity
|
||||
|
||||
### Project Success Factors
|
||||
|
||||
**🎯 Clear Decision Framework**
|
||||
Every technology choice was made collaboratively with clear rationale, ensuring all stakeholders understand the architectural direction.
|
||||
|
||||
**🔧 Consistency Guarantee**
|
||||
Implementation patterns and rules ensure that multiple AI agents will produce compatible, consistent code that works together seamlessly.
|
||||
|
||||
**📋 Complete Coverage**
|
||||
All project requirements are architecturally supported, with clear mapping from business needs to technical implementation.
|
||||
|
||||
**🏗️ Solid Foundation**
|
||||
The chosen starter template and architectural patterns provide a production-ready foundation following current best practices.
|
||||
|
||||
---
|
||||
|
||||
**Architecture Status:** READY FOR IMPLEMENTATION ✅
|
||||
|
||||
**Next Phase:** Begin implementation using the architectural decisions and patterns documented herein.
|
||||
|
||||
**Document Maintenance:** Update this architecture when major technical decisions are made during implementation.
|
||||
```
|
||||
|
||||
### 5. Complete Workflow Finalization
|
||||
|
||||
**Save Final Document:**
|
||||
|
||||
- Ensure all content is properly appended to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter with completion status
|
||||
- Verify document is complete and coherent
|
||||
|
||||
**Workflow Status Update:**
|
||||
If not in standalone mode, update workflow status:
|
||||
|
||||
- Load `{planning_artifacts}/bmm-workflow-status.yaml`
|
||||
- Update workflow_status["create-architecture"] = "{planning_artifacts}/architecture.md"
|
||||
- Save file with all structure and comments preserved
|
||||
|
||||
### 6. Present Completion to User
|
||||
|
||||
"🎉 **Architecture Workflow Complete!**
|
||||
|
||||
Your architecture for {{project_name}} is comprehensive, validated, and ready for implementation.
|
||||
|
||||
**✅ What's been delivered:**
|
||||
|
||||
- Complete architecture document with all decisions and patterns
|
||||
- Project structure ready for AI agent implementation
|
||||
- Validation confirming everything works together coherently
|
||||
- Implementation guidance for the development phase
|
||||
|
||||
**📍 Where to find it:**
|
||||
`{planning_artifacts}/architecture.md`
|
||||
|
||||
**🚀 What's next:**
|
||||
|
||||
1. Review your complete architecture document
|
||||
2. Begin implementation using the starter template command
|
||||
3. Create stories for AI agents to implement following your architectural decisions
|
||||
|
||||
Your architecture will ensure consistent, high-quality implementation across all development work. Great job collaborating through these important architectural decisions!
|
||||
|
||||
**💡 Optional Enhancement: Project Context File**
|
||||
|
||||
Would you like to create a `project-context.md` file? This is a concise, optimized guide for AI agents that captures:
|
||||
|
||||
- Critical language and framework rules they might miss
|
||||
- Specific patterns and conventions for your project
|
||||
- Testing and code quality requirements
|
||||
- Anti-patterns and edge cases to avoid
|
||||
|
||||
{if_existing_project_context}
|
||||
I noticed you already have a project context file. Would you like to update it with your new architectural decisions?
|
||||
{else}
|
||||
This file helps ensure AI agents implement code consistently with your project's unique requirements and patterns.
|
||||
{/if_existing_project_context}
|
||||
|
||||
**Create/Update project context?** [Y/N]
|
||||
|
||||
**Ready to move to the next phase of your project development?**"
|
||||
|
||||
### 7. Handle Project Context Creation Choice
|
||||
|
||||
If user responds 'Y' or 'yes' to creating/updating project context:
|
||||
|
||||
"Excellent choice! Let me launch the Generate Project Context workflow to create a comprehensive guide for AI agents.
|
||||
|
||||
This will help ensure consistent implementation by capturing:
|
||||
|
||||
- Language-specific patterns and rules
|
||||
- Framework conventions from your architecture
|
||||
- Testing and quality standards
|
||||
- Anti-patterns to avoid
|
||||
|
||||
The workflow will collaborate with you to create an optimized `project-context.md` file that AI agents will read before implementing any code."
|
||||
|
||||
**Execute the Generate Project Context workflow:**
|
||||
|
||||
- Load and execute: `{project-root}/_bmad/bmm/workflows/generate-project-context/workflow.md`
|
||||
- The workflow will handle discovery, generation, and completion of the project context file
|
||||
- After completion, return here for final handoff
|
||||
|
||||
If user responds 'N' or 'no':
|
||||
"Understood! Your architecture is complete and ready for implementation. You can always create a project context file later using the Generate Project Context workflow if needed."
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
@@ -143,3 +143,7 @@ If all validations pass:
|
||||
**All validations complete!** [C] Complete Workflow
|
||||
|
||||
When C is selected, the workflow is complete and the epics.md is ready for development.
|
||||
|
||||
Execute task `_bmad/bmm/tasks/whats-after.md` with argument `Create Epics and Stories`.
|
||||
|
||||
Upon Completion of task output: offer to answer any questions about the Epics and Stories.
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
---
|
||||
project_name: '{{project_name}}'
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
sections_completed: ['technology_stack']
|
||||
existing_patterns_found: { { number_of_patterns_discovered } }
|
||||
---
|
||||
|
||||
# Project Context for AI Agents
|
||||
|
||||
_This file contains critical rules and patterns that AI agents must follow when implementing code in this project. Focus on unobvious details that agents might otherwise miss._
|
||||
|
||||
---
|
||||
|
||||
## Technology Stack & Versions
|
||||
|
||||
_Documented after discovery phase_
|
||||
|
||||
## Critical Implementation Rules
|
||||
|
||||
_Documented after discovery phase_
|
||||
@@ -1,184 +0,0 @@
|
||||
# Step 1: Context Discovery & Initialization
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- ✅ ALWAYS treat this as collaborative discovery between technical peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on discovering existing project context and technology stack
|
||||
- 🎯 IDENTIFY critical implementation rules that AI agents need
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 📖 Read existing project files to understand current context
|
||||
- 💾 Initialize document and update frontmatter
|
||||
- 🚫 FORBIDDEN to load next step until discovery is complete
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Variables from workflow.md are available in memory
|
||||
- Focus on existing project files and architecture decisions
|
||||
- Look for patterns, conventions, and unique requirements
|
||||
- Prioritize rules that prevent implementation mistakes
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Discover the project's technology stack, existing patterns, and critical implementation rules that AI agents must follow when writing code.
|
||||
|
||||
## DISCOVERY SEQUENCE:
|
||||
|
||||
### 1. Check for Existing Project Context
|
||||
|
||||
First, check if project context already exists:
|
||||
|
||||
- Look for file at `{project_knowledge}/project-context.md or {project-root}/**/project-context.md`
|
||||
- If exists: Read complete file to understand existing rules
|
||||
- Present to user: "Found existing project context with {number_of_sections} sections. Would you like to update this or create a new one?"
|
||||
|
||||
### 2. Discover Project Technology Stack
|
||||
|
||||
Load and analyze project files to identify technologies:
|
||||
|
||||
**Architecture Document:**
|
||||
|
||||
- Look for `{planning_artifacts}/architecture.md`
|
||||
- Extract technology choices with specific versions
|
||||
- Note architectural decisions that affect implementation
|
||||
|
||||
**Package Files:**
|
||||
|
||||
- Check for `package.json`, `requirements.txt`, `Cargo.toml`, etc.
|
||||
- Extract exact versions of all dependencies
|
||||
- Note development vs production dependencies
|
||||
|
||||
**Configuration Files:**
|
||||
|
||||
- Look for project language specific configs ( example: `tsconfig.json`)
|
||||
- Build tool configs (webpack, vite, next.config.js, etc.)
|
||||
- Linting and formatting configs (.eslintrc, .prettierrc, etc.)
|
||||
- Testing configurations (jest.config.js, vitest.config.ts, etc.)
|
||||
|
||||
### 3. Identify Existing Code Patterns
|
||||
|
||||
Search through existing codebase for patterns:
|
||||
|
||||
**Naming Conventions:**
|
||||
|
||||
- File naming patterns (PascalCase, kebab-case, etc.)
|
||||
- Component/function naming conventions
|
||||
- Variable naming patterns
|
||||
- Test file naming patterns
|
||||
|
||||
**Code Organization:**
|
||||
|
||||
- How components are structured
|
||||
- Where utilities and helpers are placed
|
||||
- How services are organized
|
||||
- Test organization patterns
|
||||
|
||||
**Documentation Patterns:**
|
||||
|
||||
- Comment styles and conventions
|
||||
- Documentation requirements
|
||||
- README and API doc patterns
|
||||
|
||||
### 4. Extract Critical Implementation Rules
|
||||
|
||||
Look for rules that AI agents might miss:
|
||||
|
||||
**Language-Specific Rules:**
|
||||
|
||||
- TypeScript strict mode requirements
|
||||
- Import/export conventions
|
||||
- Async/await vs Promise usage patterns
|
||||
- Error handling patterns specific to the language
|
||||
|
||||
**Framework-Specific Rules:**
|
||||
|
||||
- React hooks usage patterns
|
||||
- API route conventions
|
||||
- Middleware usage patterns
|
||||
- State management patterns
|
||||
|
||||
**Testing Rules:**
|
||||
|
||||
- Test structure requirements
|
||||
- Mock usage conventions
|
||||
- Integration vs unit test boundaries
|
||||
- Coverage requirements
|
||||
|
||||
**Development Workflow Rules:**
|
||||
|
||||
- Branch naming conventions
|
||||
- Commit message patterns
|
||||
- PR review requirements
|
||||
- Deployment procedures
|
||||
|
||||
### 5. Initialize Project Context Document
|
||||
|
||||
Based on discovery, create or update the context document:
|
||||
|
||||
#### A. Fresh Document Setup (if no existing context)
|
||||
|
||||
Copy template from `{installed_path}/project-context-template.md` to `{output_folder}/project-context.md`
|
||||
Initialize frontmatter fields.
|
||||
|
||||
#### B. Existing Document Update
|
||||
|
||||
Load existing context and prepare for updates
|
||||
Set frontmatter `sections_completed` to track what will be updated
|
||||
|
||||
### 6. Present Discovery Summary
|
||||
|
||||
Report findings to user:
|
||||
|
||||
"Welcome {{user_name}}! I've analyzed your project for {{project_name}} to discover the context that AI agents need.
|
||||
|
||||
**Technology Stack Discovered:**
|
||||
{{list_of_technologies_with_versions}}
|
||||
|
||||
**Existing Patterns Found:**
|
||||
|
||||
- {{number_of_patterns}} implementation patterns
|
||||
- {{number_of_conventions}} coding conventions
|
||||
- {{number_of_rules}} critical rules
|
||||
|
||||
**Key Areas for Context Rules:**
|
||||
|
||||
- {{area_1}} (e.g., TypeScript configuration)
|
||||
- {{area_2}} (e.g., Testing patterns)
|
||||
- {{area_3}} (e.g., Code organization)
|
||||
|
||||
{if_existing_context}
|
||||
**Existing Context:** Found {{sections}} sections already defined. We can update or add to these.
|
||||
{/if_existing_context}
|
||||
|
||||
Ready to create/update your project context. This will help AI agents implement code consistently with your project's standards.
|
||||
|
||||
[C] Continue to context generation"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Existing project context properly detected and handled
|
||||
✅ Technology stack accurately identified with versions
|
||||
✅ Critical implementation patterns discovered
|
||||
✅ Project context document properly initialized
|
||||
✅ Discovery findings clearly presented to user
|
||||
✅ User ready to proceed with context generation
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not checking for existing project context before creating new one
|
||||
❌ Missing critical technology versions or configurations
|
||||
❌ Overlooking important coding patterns or conventions
|
||||
❌ Not initializing frontmatter properly
|
||||
❌ Not presenting clear discovery summary to user
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, load `./step-02-generate.md` to collaboratively generate the specific project context rules.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and discovery is confirmed and the initial file has been written as directed in this discovery step!
|
||||
@@ -1,318 +0,0 @@
|
||||
# Step 2: Context Rules Generation
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- ✅ ALWAYS treat this as collaborative discovery between technical peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on unobvious rules that AI agents need to be reminded of
|
||||
- 🎯 KEEP CONTENT LEAN - optimize for LLM context efficiency
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 📝 Focus on specific, actionable rules rather than general advice
|
||||
- ⚠️ Present A/P/C menu after each major rule category
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter with completed sections
|
||||
- 🚫 FORBIDDEN to load next step until all sections are complete
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
This step will generate content and present choices for each rule category:
|
||||
|
||||
- **A (Advanced Elicitation)**: Use discovery protocols to explore nuanced implementation rules
|
||||
- **P (Party Mode)**: Bring multiple perspectives to identify critical edge cases
|
||||
- **C (Continue)**: Save the current rules and proceed to next category
|
||||
|
||||
## PROTOCOL INTEGRATION:
|
||||
|
||||
- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
|
||||
- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode
|
||||
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
||||
- User accepts/rejects protocol changes before proceeding
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Discovery results from step-1 are available
|
||||
- Technology stack and existing patterns are identified
|
||||
- Focus on rules that prevent implementation mistakes
|
||||
- Prioritize unobvious details that AI agents might miss
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Collaboratively generate specific, critical rules that AI agents must follow when implementing code in this project.
|
||||
|
||||
## CONTEXT GENERATION SEQUENCE:
|
||||
|
||||
### 1. Technology Stack & Versions
|
||||
|
||||
Document the exact technology stack from discovery:
|
||||
|
||||
**Core Technologies:**
|
||||
Based on user skill level, present findings:
|
||||
|
||||
**Expert Mode:**
|
||||
"Technology stack from your architecture and package files:
|
||||
{{exact_technologies_with_versions}}
|
||||
|
||||
Any critical version constraints I should document for agents?"
|
||||
|
||||
**Intermediate Mode:**
|
||||
"I found your technology stack:
|
||||
|
||||
**Core Technologies:**
|
||||
{{main_technologies_with_versions}}
|
||||
|
||||
**Key Dependencies:**
|
||||
{{important_dependencies_with_versions}}
|
||||
|
||||
Are there any version constraints or compatibility notes agents should know about?"
|
||||
|
||||
**Beginner Mode:**
|
||||
"Here are the technologies you're using:
|
||||
|
||||
**Main Technologies:**
|
||||
{{friendly_description_of_tech_stack}}
|
||||
|
||||
**Important Notes:**
|
||||
{{key_things_agents_need_to_know_about_versions}}
|
||||
|
||||
Should I document any special version rules or compatibility requirements?"
|
||||
|
||||
### 2. Language-Specific Rules
|
||||
|
||||
Focus on unobvious language patterns agents might miss:
|
||||
|
||||
**TypeScript/JavaScript Rules:**
|
||||
"Based on your codebase, I notice some specific patterns:
|
||||
|
||||
**Configuration Requirements:**
|
||||
{{typescript_config_rules}}
|
||||
|
||||
**Import/Export Patterns:**
|
||||
{{import_export_conventions}}
|
||||
|
||||
**Error Handling Patterns:**
|
||||
{{error_handling_requirements}}
|
||||
|
||||
Are these patterns correct? Any other language-specific rules agents should follow?"
|
||||
|
||||
**Python/Ruby/Other Language Rules:**
|
||||
Adapt to the actual language in use with similar focused questions.
|
||||
|
||||
### 3. Framework-Specific Rules
|
||||
|
||||
Document framework-specific patterns:
|
||||
|
||||
**React Rules (if applicable):**
|
||||
"For React development, I see these patterns:
|
||||
|
||||
**Hooks Usage:**
|
||||
{{hooks_usage_patterns}}
|
||||
|
||||
**Component Structure:**
|
||||
{{component_organization_rules}}
|
||||
|
||||
**State Management:**
|
||||
{{state_management_patterns}}
|
||||
|
||||
**Performance Rules:**
|
||||
{{performance_optimization_requirements}}
|
||||
|
||||
Should I add any other React-specific rules?"
|
||||
|
||||
**Other Framework Rules:**
|
||||
Adapt for Vue, Angular, Next.js, Express, etc.
|
||||
|
||||
### 4. Testing Rules
|
||||
|
||||
Focus on testing patterns that ensure consistency:
|
||||
|
||||
**Test Structure Rules:**
|
||||
"Your testing setup shows these patterns:
|
||||
|
||||
**Test Organization:**
|
||||
{{test_file_organization}}
|
||||
|
||||
**Mock Usage:**
|
||||
{{mock_patterns_and_conventions}}
|
||||
|
||||
**Test Coverage Requirements:**
|
||||
{{coverage_expectations}}
|
||||
|
||||
**Integration vs Unit Test Rules:**
|
||||
{{test_boundary_patterns}}
|
||||
|
||||
Are there testing rules agents should always follow?"
|
||||
|
||||
### 5. Code Quality & Style Rules
|
||||
|
||||
Document critical style and quality rules:
|
||||
|
||||
**Linting/Formatting:**
|
||||
"Your code style configuration requires:
|
||||
|
||||
**ESLint/Prettier Rules:**
|
||||
{{specific_linting_rules}}
|
||||
|
||||
**Code Organization:**
|
||||
{{file_and_folder_structure_rules}}
|
||||
|
||||
**Naming Conventions:**
|
||||
{{naming_patterns_agents_must_follow}}
|
||||
|
||||
**Documentation Requirements:**
|
||||
{{comment_and_documentation_patterns}}
|
||||
|
||||
Any additional code quality rules?"
|
||||
|
||||
### 6. Development Workflow Rules
|
||||
|
||||
Document workflow patterns that affect implementation:
|
||||
|
||||
**Git/Repository Rules:**
|
||||
"Your project uses these patterns:
|
||||
|
||||
**Branch Naming:**
|
||||
{{branch_naming_conventions}}
|
||||
|
||||
**Commit Message Format:**
|
||||
{{commit_message_patterns}}
|
||||
|
||||
**PR Requirements:**
|
||||
{{pull_request_checklist}}
|
||||
|
||||
**Deployment Patterns:**
|
||||
{{deployment_considerations}}
|
||||
|
||||
Should I document any other workflow rules?"
|
||||
|
||||
### 7. Critical Don't-Miss Rules
|
||||
|
||||
Identify rules that prevent common mistakes:
|
||||
|
||||
**Anti-Patterns to Avoid:**
|
||||
"Based on your codebase, here are critical things agents must NOT do:
|
||||
|
||||
{{critical_anti_patterns_with_examples}}
|
||||
|
||||
**Edge Cases:**
|
||||
{{specific_edge_cases_agents_should_handle}}
|
||||
|
||||
**Security Rules:**
|
||||
{{security_considerations_agents_must_follow}}
|
||||
|
||||
**Performance Gotchas:**
|
||||
{{performance_patterns_to_avoid}}
|
||||
|
||||
Are there other 'gotchas' agents should know about?"
|
||||
|
||||
### 8. Generate Context Content
|
||||
|
||||
For each category, prepare lean content for the project context file:
|
||||
|
||||
#### Content Structure:
|
||||
|
||||
```markdown
|
||||
## Technology Stack & Versions
|
||||
|
||||
{{concise_technology_list_with_exact_versions}}
|
||||
|
||||
## Critical Implementation Rules
|
||||
|
||||
### Language-Specific Rules
|
||||
|
||||
{{bullet_points_of_critical_language_rules}}
|
||||
|
||||
### Framework-Specific Rules
|
||||
|
||||
{{bullet_points_of_framework_patterns}}
|
||||
|
||||
### Testing Rules
|
||||
|
||||
{{bullet_points_of_testing_requirements}}
|
||||
|
||||
### Code Quality & Style Rules
|
||||
|
||||
{{bullet_points_of_style_and_quality_rules}}
|
||||
|
||||
### Development Workflow Rules
|
||||
|
||||
{{bullet_points_of_workflow_patterns}}
|
||||
|
||||
### Critical Don't-Miss Rules
|
||||
|
||||
{{bullet_points_of_anti_patterns_and_edge_cases}}
|
||||
```
|
||||
|
||||
### 9. Present Content and Menu
|
||||
|
||||
After each category, show the generated rules and present choices:
|
||||
|
||||
"I've drafted the {{category_name}} rules for your project context.
|
||||
|
||||
**Here's what I'll add:**
|
||||
|
||||
[Show the complete markdown content for this category]
|
||||
|
||||
**What would you like to do?**
|
||||
[A] Advanced Elicitation - Explore nuanced rules for this category
|
||||
[P] Party Mode - Review from different implementation perspectives
|
||||
[C] Continue - Save these rules and move to next category"
|
||||
|
||||
### 10. Handle Menu Selection
|
||||
|
||||
#### If 'A' (Advanced Elicitation):
|
||||
|
||||
- Execute advanced-elicitation.xml with current category rules
|
||||
- Process enhanced rules that come back
|
||||
- Ask user: "Accept these enhanced rules for {{category}}? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'P' (Party Mode):
|
||||
|
||||
- Execute party-mode workflow with category rules context
|
||||
- Process collaborative insights on implementation patterns
|
||||
- Ask user: "Accept these changes to {{category}} rules? (y/n)"
|
||||
- If yes: Update content, then return to A/P/C menu
|
||||
- If no: Keep original content, then return to A/P/C menu
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Save the current category content to project context file
|
||||
- Update frontmatter: `sections_completed: [...]`
|
||||
- Proceed to next category or step-03 if complete
|
||||
|
||||
## APPEND TO PROJECT CONTEXT:
|
||||
|
||||
When user selects 'C' for a category, append the content directly to `{output_folder}/project-context.md` using the structure from step 8.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All critical technology versions accurately documented
|
||||
✅ Language-specific rules cover unobvious patterns
|
||||
✅ Framework rules capture project-specific conventions
|
||||
✅ Testing rules ensure consistent test quality
|
||||
✅ Code quality rules maintain project standards
|
||||
✅ Workflow rules prevent implementation conflicts
|
||||
✅ Content is lean and optimized for LLM context
|
||||
✅ A/P/C menu presented and handled correctly for each category
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Including obvious rules that agents already know
|
||||
❌ Making content too verbose for LLM context efficiency
|
||||
❌ Missing critical anti-patterns or edge cases
|
||||
❌ Not getting user validation for each rule category
|
||||
❌ Not documenting exact versions and configurations
|
||||
❌ Not presenting A/P/C menu after content generation
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After completing all rule categories and user selects 'C' for the final category, load `./step-03-complete.md` to finalize the project context file.
|
||||
|
||||
Remember: Do NOT proceed to step-03 until all categories are complete and user explicitly selects 'C' for each!
|
||||
@@ -1,278 +0,0 @@
|
||||
# Step 3: Context Completion & Finalization
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- ✅ ALWAYS treat this as collaborative completion between technical peers
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on finalizing a lean, LLM-optimized project context
|
||||
- 🎯 ENSURE all critical rules are captured and actionable
|
||||
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 📝 Review and optimize content for LLM context efficiency
|
||||
- 📖 Update frontmatter with completion status
|
||||
- 🚫 NO MORE STEPS - this is the final step
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- All rule categories from step-2 are complete
|
||||
- Technology stack and versions are documented
|
||||
- Focus on final review, optimization, and completion
|
||||
- Ensure the context file is ready for AI agent consumption
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Complete the project context file, optimize it for LLM efficiency, and provide guidance for usage and maintenance.
|
||||
|
||||
## COMPLETION SEQUENCE:
|
||||
|
||||
### 1. Review Complete Context File
|
||||
|
||||
Read the entire project context file and analyze:
|
||||
|
||||
**Content Analysis:**
|
||||
|
||||
- Total length and readability for LLMs
|
||||
- Clarity and specificity of rules
|
||||
- Coverage of all critical areas
|
||||
- Actionability of each rule
|
||||
|
||||
**Structure Analysis:**
|
||||
|
||||
- Logical organization of sections
|
||||
- Consistency of formatting
|
||||
- Absence of redundant or obvious information
|
||||
- Optimization for quick scanning
|
||||
|
||||
### 2. Optimize for LLM Context
|
||||
|
||||
Ensure the file is lean and efficient:
|
||||
|
||||
**Content Optimization:**
|
||||
|
||||
- Remove any redundant rules or obvious information
|
||||
- Combine related rules into concise bullet points
|
||||
- Use specific, actionable language
|
||||
- Ensure each rule provides unique value
|
||||
|
||||
**Formatting Optimization:**
|
||||
|
||||
- Use consistent markdown formatting
|
||||
- Implement clear section hierarchy
|
||||
- Ensure scannability with strategic use of bolding
|
||||
- Maintain readability while maximizing information density
|
||||
|
||||
### 3. Final Content Structure
|
||||
|
||||
Ensure the final structure follows this optimized format:
|
||||
|
||||
```markdown
|
||||
# Project Context for AI Agents
|
||||
|
||||
_This file contains critical rules and patterns that AI agents must follow when implementing code in this project. Focus on unobvious details that agents might otherwise miss._
|
||||
|
||||
---
|
||||
|
||||
## Technology Stack & Versions
|
||||
|
||||
{{concise_technology_list}}
|
||||
|
||||
## Critical Implementation Rules
|
||||
|
||||
### Language-Specific Rules
|
||||
|
||||
{{specific_language_rules}}
|
||||
|
||||
### Framework-Specific Rules
|
||||
|
||||
{{framework_patterns}}
|
||||
|
||||
### Testing Rules
|
||||
|
||||
{{testing_requirements}}
|
||||
|
||||
### Code Quality & Style Rules
|
||||
|
||||
{{style_and_quality_patterns}}
|
||||
|
||||
### Development Workflow Rules
|
||||
|
||||
{{workflow_patterns}}
|
||||
|
||||
### Critical Don't-Miss Rules
|
||||
|
||||
{{anti_patterns_and_edge_cases}}
|
||||
|
||||
---
|
||||
|
||||
## Usage Guidelines
|
||||
|
||||
**For AI Agents:**
|
||||
|
||||
- Read this file before implementing any code
|
||||
- Follow ALL rules exactly as documented
|
||||
- When in doubt, prefer the more restrictive option
|
||||
- Update this file if new patterns emerge
|
||||
|
||||
**For Humans:**
|
||||
|
||||
- Keep this file lean and focused on agent needs
|
||||
- Update when technology stack changes
|
||||
- Review quarterly for outdated rules
|
||||
- Remove rules that become obvious over time
|
||||
|
||||
Last Updated: {{date}}
|
||||
```
|
||||
|
||||
### 4. Present Completion Summary
|
||||
|
||||
Based on user skill level, present the completion:
|
||||
|
||||
**Expert Mode:**
|
||||
"Project context complete. Optimized for LLM consumption with {{rule_count}} critical rules across {{section_count}} sections.
|
||||
|
||||
File saved to: `{output_folder}/project-context.md`
|
||||
|
||||
Ready for AI agent integration."
|
||||
|
||||
**Intermediate Mode:**
|
||||
"Your project context is complete and optimized for AI agents!
|
||||
|
||||
**What we created:**
|
||||
|
||||
- {{rule_count}} critical implementation rules
|
||||
- Technology stack with exact versions
|
||||
- Framework-specific patterns and conventions
|
||||
- Testing and quality guidelines
|
||||
- Workflow and anti-pattern rules
|
||||
|
||||
**Key benefits:**
|
||||
|
||||
- AI agents will implement consistently with your standards
|
||||
- Reduced context switching and implementation errors
|
||||
- Clear guidance for unobvious project requirements
|
||||
|
||||
**Next steps:**
|
||||
|
||||
- AI agents should read this file before implementing
|
||||
- Update as your project evolves
|
||||
- Review periodically for optimization"
|
||||
|
||||
**Beginner Mode:**
|
||||
"Excellent! Your project context guide is ready! 🎉
|
||||
|
||||
**What this does:**
|
||||
Think of this as a 'rules of the road' guide for AI agents working on your project. It ensures they all follow the same patterns and avoid common mistakes.
|
||||
|
||||
**What's included:**
|
||||
|
||||
- Exact technology versions to use
|
||||
- Critical coding rules they might miss
|
||||
- Testing and quality standards
|
||||
- Workflow patterns to follow
|
||||
|
||||
**How AI agents use it:**
|
||||
They read this file before writing any code, ensuring everything they create follows your project's standards perfectly.
|
||||
|
||||
Your project context is saved and ready to help agents implement consistently!"
|
||||
|
||||
### 5. Final File Updates
|
||||
|
||||
Update the project context file with completion information:
|
||||
|
||||
**Frontmatter Update:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
project_name: '{{project_name}}'
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
sections_completed:
|
||||
['technology_stack', 'language_rules', 'framework_rules', 'testing_rules', 'quality_rules', 'workflow_rules', 'anti_patterns']
|
||||
status: 'complete'
|
||||
rule_count: { { total_rules } }
|
||||
optimized_for_llm: true
|
||||
---
|
||||
```
|
||||
|
||||
**Add Usage Section:**
|
||||
Append the usage guidelines from step 3 to complete the document.
|
||||
|
||||
### 6. Completion Validation
|
||||
|
||||
Final checks before completion:
|
||||
|
||||
**Content Validation:**
|
||||
✅ All critical technology versions documented
|
||||
✅ Language-specific rules are specific and actionable
|
||||
✅ Framework rules cover project conventions
|
||||
✅ Testing rules ensure consistency
|
||||
✅ Code quality rules maintain standards
|
||||
✅ Workflow rules prevent conflicts
|
||||
✅ Anti-pattern rules prevent common mistakes
|
||||
|
||||
**Format Validation:**
|
||||
✅ Content is lean and optimized for LLMs
|
||||
✅ Structure is logical and scannable
|
||||
✅ No redundant or obvious information
|
||||
✅ Consistent formatting throughout
|
||||
|
||||
### 7. Completion Message
|
||||
|
||||
Present final completion to user:
|
||||
|
||||
"✅ **Project Context Generation Complete!**
|
||||
|
||||
Your optimized project context file is ready at:
|
||||
`{output_folder}/project-context.md`
|
||||
|
||||
**📊 Context Summary:**
|
||||
|
||||
- {{rule_count}} critical rules for AI agents
|
||||
- {{section_count}} comprehensive sections
|
||||
- Optimized for LLM context efficiency
|
||||
- Ready for immediate agent integration
|
||||
|
||||
**🎯 Key Benefits:**
|
||||
|
||||
- Consistent implementation across all AI agents
|
||||
- Reduced common mistakes and edge cases
|
||||
- Clear guidance for project-specific patterns
|
||||
- Minimal LLM context usage
|
||||
|
||||
**📋 Next Steps:**
|
||||
|
||||
1. AI agents will automatically read this file when implementing
|
||||
2. Update this file when your technology stack or patterns evolve
|
||||
3. Review quarterly to optimize and remove outdated rules
|
||||
|
||||
Your project context will help ensure high-quality, consistent implementation across all development work. Great work capturing your project's critical implementation requirements!"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Complete project context file with all critical rules
|
||||
✅ Content optimized for LLM context efficiency
|
||||
✅ All technology versions and patterns documented
|
||||
✅ File structure is logical and scannable
|
||||
✅ Usage guidelines included for agents and humans
|
||||
✅ Frontmatter properly updated with completion status
|
||||
✅ User provided with clear next steps and benefits
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Final content is too verbose for LLM consumption
|
||||
❌ Missing critical implementation rules or patterns
|
||||
❌ Not optimizing content for agent readability
|
||||
❌ Not providing clear usage guidelines
|
||||
❌ Frontmatter not properly updated
|
||||
❌ Not validating file completion before ending
|
||||
|
||||
## WORKFLOW COMPLETE:
|
||||
|
||||
This is the final step of the Generate Project Context workflow. The user now has a comprehensive, optimized project context file that will ensure consistent, high-quality implementation across all AI agents working on the project.
|
||||
|
||||
The project context file serves as the critical "rules of the road" that agents need to implement code consistently with the project's standards and patterns.
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
name: generate-project-context
|
||||
description: Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.
|
||||
---
|
||||
|
||||
# Generate Project Context Workflow
|
||||
|
||||
**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of.
|
||||
|
||||
**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project.
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **micro-file architecture** for disciplined execution:
|
||||
|
||||
- Each step is a self-contained file with embedded rules
|
||||
- Sequential progression with user control at each step
|
||||
- Document state tracked in frontmatter
|
||||
- Focus on lean, LLM-optimized content generation
|
||||
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION
|
||||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as system-generated current datetime
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/_bmad/bmm/workflows/generate-project-context`
|
||||
- `template_path` = `{installed_path}/project-context-template.md`
|
||||
- `output_file` = `{output_folder}/project-context.md`
|
||||
|
||||
---
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Load and execute `steps/step-01-discover.md` to begin the workflow.
|
||||
|
||||
**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md.
|
||||
Reference in New Issue
Block a user