bmad-method 5.1.2 → 6.0.0-Beta.0

package/src/bmm/workflows/document-project/workflows/full-scan.yaml

@@ -0,0 +1,31 @@
+# Full Project Scan Workflow Configuration
+name: "document-project-full-scan"
+description: "Complete project documentation workflow (initial scan or full rescan)"
+author: "BMad"
+
+# This is a sub-workflow called by document-project/workflow.yaml
+parent_workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
+
+# Critical variables inherited from parent
+config_source: "{project-root}/_bmad/bmb/config.yaml"
+output_folder: "{config_source}:output_folder"
+user_name: "{config_source}:user_name"
+date: system-generated
+
+# Data files
+documentation_requirements_csv: "{project-root}/_bmad/bmm/workflows/document-project/documentation-requirements.csv"
+
+# Module path and component files
+installed_path: "{project-root}/_bmad/bmm/workflows/document-project/workflows"
+template: false # Action workflow
+instructions: "{installed_path}/full-scan-instructions.md"
+validation: "{project-root}/_bmad/bmm/workflows/document-project/checklist.md"
+
+# Runtime inputs (passed from parent workflow)
+workflow_mode: "" # "initial_scan" or "full_rescan"
+scan_level: "" # "quick", "deep", or "exhaustive"
+resume_mode: false
+project_root_path: ""
+
+# Configuration
+autonomous: false # Requires user input at key decision points

package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json

@@ -0,0 +1,90 @@
+{
+  "type": "excalidrawlib",
+  "version": 2,
+  "library": [
+    {
+      "id": "start-end-circle",
+      "status": "published",
+      "elements": [
+        {
+          "type": "ellipse",
+          "width": 120,
+          "height": 60,
+          "strokeColor": "#1976d2",
+          "backgroundColor": "#e3f2fd",
+          "fillStyle": "solid",
+          "strokeWidth": 2,
+          "roughness": 0
+        }
+      ]
+    },
+    {
+      "id": "process-rectangle",
+      "status": "published",
+      "elements": [
+        {
+          "type": "rectangle",
+          "width": 160,
+          "height": 80,
+          "strokeColor": "#1976d2",
+          "backgroundColor": "#e3f2fd",
+          "fillStyle": "solid",
+          "strokeWidth": 2,
+          "roughness": 0,
+          "roundness": {
+            "type": 3,
+            "value": 8
+          }
+        }
+      ]
+    },
+    {
+      "id": "decision-diamond",
+      "status": "published",
+      "elements": [
+        {
+          "type": "diamond",
+          "width": 140,
+          "height": 100,
+          "strokeColor": "#f57c00",
+          "backgroundColor": "#fff3e0",
+          "fillStyle": "solid",
+          "strokeWidth": 2,
+          "roughness": 0
+        }
+      ]
+    },
+    {
+      "id": "data-store",
+      "status": "published",
+      "elements": [
+        {
+          "type": "rectangle",
+          "width": 140,
+          "height": 80,
+          "strokeColor": "#388e3c",
+          "backgroundColor": "#e8f5e9",
+          "fillStyle": "solid",
+          "strokeWidth": 2,
+          "roughness": 0
+        }
+      ]
+    },
+    {
+      "id": "external-entity",
+      "status": "published",
+      "elements": [
+        {
+          "type": "rectangle",
+          "width": 120,
+          "height": 80,
+          "strokeColor": "#7b1fa2",
+          "backgroundColor": "#f3e5f5",
+          "fillStyle": "solid",
+          "strokeWidth": 3,
+          "roughness": 0
+        }
+      ]
+    }
+  ]
+}

package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml

@@ -0,0 +1,127 @@
+flowchart:
+  viewport:
+    x: 0
+    y: 0
+    zoom: 1
+  grid:
+    size: 20
+  spacing:
+    vertical: 100
+    horizontal: 180
+  elements:
+    start:
+      type: ellipse
+      width: 120
+      height: 60
+      label: "Start"
+    process:
+      type: rectangle
+      width: 160
+      height: 80
+      roundness: 8
+    decision:
+      type: diamond
+      width: 140
+      height: 100
+    end:
+      type: ellipse
+      width: 120
+      height: 60
+      label: "End"
+
+diagram:
+  viewport:
+    x: 0
+    y: 0
+    zoom: 1
+  grid:
+    size: 20
+  spacing:
+    vertical: 120
+    horizontal: 200
+  elements:
+    component:
+      type: rectangle
+      width: 180
+      height: 100
+      roundness: 8
+    database:
+      type: rectangle
+      width: 140
+      height: 80
+    service:
+      type: rectangle
+      width: 160
+      height: 90
+      roundness: 12
+    external:
+      type: rectangle
+      width: 140
+      height: 80
+
+wireframe:
+  viewport:
+    x: 0
+    y: 0
+    zoom: 0.8
+  grid:
+    size: 20
+  spacing:
+    vertical: 40
+    horizontal: 40
+  elements:
+    container:
+      type: rectangle
+      width: 800
+      height: 600
+      strokeStyle: solid
+      strokeWidth: 2
+    header:
+      type: rectangle
+      width: 800
+      height: 80
+    button:
+      type: rectangle
+      width: 120
+      height: 40
+      roundness: 4
+    input:
+      type: rectangle
+      width: 300
+      height: 40
+      roundness: 4
+    text:
+      type: text
+      fontSize: 16
+
+dataflow:
+  viewport:
+    x: 0
+    y: 0
+    zoom: 1
+  grid:
+    size: 20
+  spacing:
+    vertical: 120
+    horizontal: 200
+  elements:
+    process:
+      type: ellipse
+      width: 140
+      height: 80
+      label: "Process"
+    datastore:
+      type: rectangle
+      width: 140
+      height: 80
+      label: "Data Store"
+    external:
+      type: rectangle
+      width: 120
+      height: 80
+      strokeWidth: 3
+      label: "External Entity"
+    dataflow:
+      type: arrow
+      strokeWidth: 2
+      label: "Data Flow"

package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md

@@ -0,0 +1,39 @@
+# Create Data Flow Diagram - Validation Checklist
+
+## DFD Notation
+
+- [ ] Processes shown as circles/ellipses
+- [ ] Data stores shown as parallel lines or rectangles
+- [ ] External entities shown as rectangles
+- [ ] Data flows shown as labeled arrows
+- [ ] Follows standard DFD notation
+
+## Structure
+
+- [ ] All processes numbered correctly
+- [ ] All data flows labeled with data names
+- [ ] All data stores named appropriately
+- [ ] External entities clearly identified
+
+## Completeness
+
+- [ ] All inputs and outputs accounted for
+- [ ] No orphaned processes (unconnected)
+- [ ] Data conservation maintained
+- [ ] Level appropriate (context/level 0/level 1)
+
+## Layout
+
+- [ ] Logical flow direction (left to right, top to bottom)
+- [ ] No crossing data flows where avoidable
+- [ ] Balanced layout
+- [ ] Grid alignment maintained
+
+## Technical Quality
+
+- [ ] All elements properly grouped
+- [ ] Arrows have proper bindings
+- [ ] Text readable and properly sized
+- [ ] No elements with `isDeleted: true`
+- [ ] JSON is valid
+- [ ] File saved to correct location

package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md

@@ -0,0 +1,130 @@
+# Create Data Flow Diagram - Workflow Instructions
+
+```xml
+<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
+<critical>This workflow creates data flow diagrams (DFD) in Excalidraw format.</critical>
+
+<workflow>
+
+  <step n="0" goal="Contextual Analysis">
+    <action>Review user's request and extract: DFD level, processes, data stores, external entities</action>
+    <check if="ALL requirements clear"><action>Skip to Step 4</action></check>
+  </step>
+
+  <step n="1" goal="Identify DFD Level" elicit="true">
+    <action>Ask: "What level of DFD do you need?"</action>
+    <action>Present options:
+      1. Context Diagram (Level 0) - Single process showing system boundaries
+      2. Level 1 DFD - Major processes and data flows
+      3. Level 2 DFD - Detailed sub-processes
+      4. Custom - Specify your requirements
+    </action>
+    <action>WAIT for selection</action>
+  </step>
+
+  <step n="2" goal="Gather Requirements" elicit="true">
+    <action>Ask: "Describe the processes, data stores, and external entities in your system"</action>
+    <action>WAIT for user description</action>
+    <action>Summarize what will be included and confirm with user</action>
+  </step>
+
+  <step n="3" goal="Theme Setup" elicit="true">
+    <action>Check for existing theme.json, ask to use if exists</action>
+    <check if="no existing theme">
+      <action>Ask: "Choose a DFD color scheme:"</action>
+      <action>Present numbered options:
+        1. Standard DFD
+           - Process: #e3f2fd (light blue)
+           - Data Store: #e8f5e9 (light green)
+           - External Entity: #f3e5f5 (light purple)
+           - Border: #1976d2 (blue)
+
+        2. Colorful DFD
+           - Process: #fff9c4 (light yellow)
+           - Data Store: #c5e1a5 (light lime)
+           - External Entity: #ffccbc (light coral)
+           - Border: #f57c00 (orange)
+
+        3. Minimal DFD
+           - Process: #f5f5f5 (light gray)
+           - Data Store: #eeeeee (gray)
+           - External Entity: #e0e0e0 (medium gray)
+           - Border: #616161 (dark gray)
+
+        4. Custom - Define your own colors
+      </action>
+      <action>WAIT for selection</action>
+      <action>Create theme.json based on selection</action>
+    </check>
+  </step>
+
+  <step n="4" goal="Plan DFD Structure">
+    <action>List all processes with numbers (1.0, 2.0, etc.)</action>
+    <action>List all data stores (D1, D2, etc.)</action>
+    <action>List all external entities</action>
+    <action>Map all data flows with labels</action>
+    <action>Show planned structure, confirm with user</action>
+  </step>
+
+  <step n="5" goal="Load Resources">
+    <action>Load {{templates}} and extract `dataflow` section</action>
+    <action>Load {{library}}</action>
+    <action>Load theme.json</action>
+    <action>Load {{helpers}}</action>
+  </step>
+
+  <step n="6" goal="Build DFD Elements">
+    <critical>Follow standard DFD notation from {{helpers}}</critical>
+
+    <substep>Build Order:
+      1. External entities (rectangles, bold border)
+      2. Processes (circles/ellipses with numbers)
+      3. Data stores (parallel lines or rectangles)
+      4. Data flows (labeled arrows)
+    </substep>
+
+    <substep>DFD Rules:
+      - Processes: Numbered (1.0, 2.0), verb phrases
+      - Data stores: Named (D1, D2), noun phrases
+      - External entities: Named, noun phrases
+      - Data flows: Labeled with data names, arrows show direction
+      - No direct flow between external entities
+      - No direct flow between data stores
+    </substep>
+
+    <substep>Layout:
+      - External entities at edges
+      - Processes in center
+      - Data stores between processes
+      - Minimize crossing flows
+      - Left-to-right or top-to-bottom flow
+    </substep>
+  </step>
+
+  <step n="7" goal="Optimize and Save">
+    <action>Verify DFD rules compliance</action>
+    <action>Strip unused elements and elements with isDeleted: true</action>
+    <action>Save to {{default_output_file}}</action>
+  </step>
+
+  <step n="8" goal="Validate JSON Syntax">
+    <critical>NEVER delete the file if validation fails - always fix syntax errors</critical>
+    <action>Run: node -e "JSON.parse(require('fs').readFileSync('{{default_output_file}}', 'utf8')); console.log('✓ Valid JSON')"</action>
+    <check if="validation fails (exit code 1)">
+      <action>Read the error message carefully - it shows the syntax error and position</action>
+      <action>Open the file and navigate to the error location</action>
+      <action>Fix the syntax error (add missing comma, bracket, or quote as indicated)</action>
+      <action>Save the file</action>
+      <action>Re-run validation with the same command</action>
+      <action>Repeat until validation passes</action>
+    </check>
+    <action>Once validation passes, confirm with user</action>
+  </step>
+
+  <step n="9" goal="Validate Content">
+    <invoke-task>Validate against {{validation}}</invoke-task>
+  </step>
+
+</workflow>
+```

package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml

@@ -0,0 +1,27 @@
+name: create-excalidraw-dataflow
+description: "Create data flow diagrams (DFD) in Excalidraw format"
+author: "BMad"
+
+# Config values
+config_source: "{project-root}/_bmad/bmm/config.yaml"
+output_folder: "{config_source}:output_folder"
+
+# Workflow components
+installed_path: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow"
+shared_path: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/_shared"
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Core Excalidraw resources (universal knowledge)
+helpers: "{project-root}/_bmad/core/resources/excalidraw/excalidraw-helpers.md"
+json_validation: "{project-root}/_bmad/core/resources/excalidraw/validate-json-instructions.md"
+
+# Domain-specific resources (technical diagrams)
+templates: "{shared_path}/excalidraw-templates.yaml"
+library: "{shared_path}/excalidraw-library.json"
+
+# Output file (respects user's configured output_folder)
+default_output_file: "{output_folder}/excalidraw-diagrams/dataflow-{timestamp}.excalidraw"
+
+standalone: true
+web_bundle: false

package/src/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md

@@ -0,0 +1,43 @@
+# Create Diagram - Validation Checklist
+
+## Element Structure
+
+- [ ] All components with labels have matching `groupIds`
+- [ ] All text elements have `containerId` pointing to parent component
+- [ ] Text width calculated properly (no cutoff)
+- [ ] Text alignment appropriate for diagram type
+
+## Layout and Alignment
+
+- [ ] All elements snapped to 20px grid
+- [ ] Component spacing consistent (40px/60px)
+- [ ] Hierarchical alignment maintained
+- [ ] No overlapping elements
+
+## Connections
+
+- [ ] All arrows have `startBinding` and `endBinding`
+- [ ] `boundElements` array updated on connected components
+- [ ] Arrow routing avoids overlaps
+- [ ] Relationship types clearly indicated
+
+## Notation and Standards
+
+- [ ] Follows specified notation standard (UML/ERD/etc)
+- [ ] Symbols used correctly
+- [ ] Cardinality/multiplicity shown where needed
+- [ ] Labels and annotations clear
+
+## Theme and Styling
+
+- [ ] Theme colors applied consistently
+- [ ] Component types visually distinguishable
+- [ ] Text is readable
+- [ ] Professional appearance
+
+## Output Quality
+
+- [ ] Element count under 80
+- [ ] No elements with `isDeleted: true`
+- [ ] JSON is valid
+- [ ] File saved to correct location

package/src/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md

@@ -0,0 +1,141 @@
+# Create Diagram - Workflow Instructions
+
+```xml
+<critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
+<critical>This workflow creates system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format.</critical>
+
+<workflow>
+
+  <step n="0" goal="Contextual Analysis">
+    <action>Review user's request and extract: diagram type, components/entities, relationships, notation preferences</action>
+    <check if="ALL requirements clear"><action>Skip to Step 5</action></check>
+    <check if="SOME requirements clear"><action>Only ask about missing info in Steps 1-2</action></check>
+  </step>
+
+  <step n="1" goal="Identify Diagram Type" elicit="true">
+    <action>Ask: "What type of technical diagram do you need?"</action>
+    <action>Present options:
+      1. System Architecture
+      2. Entity-Relationship Diagram (ERD)
+      3. UML Class Diagram
+      4. UML Sequence Diagram
+      5. UML Use Case Diagram
+      6. Network Diagram
+      7. Other
+    </action>
+    <action>WAIT for selection</action>
+  </step>
+
+  <step n="2" goal="Gather Requirements" elicit="true">
+    <action>Ask: "Describe the components/entities and their relationships"</action>
+    <action>Ask: "What notation standard? (Standard/Simplified/Strict UML-ERD)"</action>
+    <action>WAIT for user input</action>
+    <action>Summarize what will be included and confirm with user</action>
+  </step>
+
+  <step n="3" goal="Check for Existing Theme" elicit="true">
+    <action>Check if theme.json exists at output location</action>
+    <check if="exists"><action>Ask to use it, load if yes, else proceed to Step 4</action></check>
+    <check if="not exists"><action>Proceed to Step 4</action></check>
+  </step>
+
+  <step n="4" goal="Create Theme" elicit="true">
+    <action>Ask: "Choose a color scheme for your diagram:"</action>
+    <action>Present numbered options:
+      1. Professional
+         - Component: #e3f2fd (light blue)
+         - Database: #e8f5e9 (light green)
+         - Service: #fff3e0 (light orange)
+         - Border: #1976d2 (blue)
+
+      2. Colorful
+         - Component: #e1bee7 (light purple)
+         - Database: #c5e1a5 (light lime)
+         - Service: #ffccbc (light coral)
+         - Border: #7b1fa2 (purple)
+
+      3. Minimal
+         - Component: #f5f5f5 (light gray)
+         - Database: #eeeeee (gray)
+         - Service: #e0e0e0 (medium gray)
+         - Border: #616161 (dark gray)
+
+      4. Custom - Define your own colors
+    </action>
+    <action>WAIT for selection</action>
+    <action>Create theme.json based on selection</action>
+    <action>Show preview and confirm</action>
+  </step>
+
+  <step n="5" goal="Plan Diagram Structure">
+    <action>List all components/entities</action>
+    <action>Map all relationships</action>
+    <action>Show planned layout</action>
+    <action>Ask: "Structure looks correct? (yes/no)"</action>
+    <check if="no"><action>Adjust and repeat</action></check>
+  </step>
+
+  <step n="6" goal="Load Resources">
+    <action>Load {{templates}} and extract `diagram` section</action>
+    <action>Load {{library}}</action>
+    <action>Load theme.json and merge with template</action>
+    <action>Load {{helpers}} for guidelines</action>
+  </step>
+
+  <step n="7" goal="Build Diagram Elements">
+    <critical>Follow {{helpers}} for proper element creation</critical>
+
+    <substep>For Each Component:
+      - Generate unique IDs (component-id, text-id, group-id)
+      - Create shape with groupIds
+      - Calculate text width
+      - Create text with containerId and matching groupIds
+      - Add boundElements
+    </substep>
+
+    <substep>For Each Connection:
+      - Determine arrow type (straight/elbow)
+      - Create with startBinding and endBinding
+      - Update boundElements on both components
+    </substep>
+
+    <substep>Build Order by Type:
+      - Architecture: Services → Databases → Connections → Labels
+      - ERD: Entities → Attributes → Relationships → Cardinality
+      - UML Class: Classes → Attributes → Methods → Relationships
+      - UML Sequence: Actors → Lifelines → Messages → Returns
+      - UML Use Case: Actors → Use Cases → Relationships
+    </substep>
+
+    <substep>Alignment:
+      - Snap to 20px grid
+      - Space: 40px between components, 60px between sections
+    </substep>
+  </step>
+
+  <step n="8" goal="Optimize and Save">
+    <action>Strip unused elements and elements with isDeleted: true</action>
+    <action>Save to {{default_output_file}}</action>
+  </step>
+
+  <step n="9" goal="Validate JSON Syntax">
+    <critical>NEVER delete the file if validation fails - always fix syntax errors</critical>
+    <action>Run: node -e "JSON.parse(require('fs').readFileSync('{{default_output_file}}', 'utf8')); console.log('✓ Valid JSON')"</action>
+    <check if="validation fails (exit code 1)">
+      <action>Read the error message carefully - it shows the syntax error and position</action>
+      <action>Open the file and navigate to the error location</action>
+      <action>Fix the syntax error (add missing comma, bracket, or quote as indicated)</action>
+      <action>Save the file</action>
+      <action>Re-run validation with the same command</action>
+      <action>Repeat until validation passes</action>
+    </check>
+    <action>Once validation passes, confirm: "Diagram created at {{default_output_file}}. Open to view?"</action>
+  </step>
+
+  <step n="10" goal="Validate Content">
+    <invoke-task>Validate against {{validation}} using {_bmad}/core/tasks/validate-workflow.xml</invoke-task>
+  </step>
+
+</workflow>
+```

package/src/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml

@@ -0,0 +1,27 @@
+name: create-excalidraw-diagram
+description: "Create system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format"
+author: "BMad"
+
+# Config values
+config_source: "{project-root}/_bmad/bmm/config.yaml"
+output_folder: "{config_source}:output_folder"
+
+# Workflow components
+installed_path: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram"
+shared_path: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/_shared"
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Core Excalidraw resources (universal knowledge)
+helpers: "{project-root}/_bmad/core/resources/excalidraw/excalidraw-helpers.md"
+json_validation: "{project-root}/_bmad/core/resources/excalidraw/validate-json-instructions.md"
+
+# Domain-specific resources (technical diagrams)
+templates: "{shared_path}/excalidraw-templates.yaml"
+library: "{shared_path}/excalidraw-library.json"
+
+# Output file (respects user's configured output_folder)
+default_output_file: "{output_folder}/excalidraw-diagrams/diagram-{timestamp}.excalidraw"
+
+standalone: true
+web_bundle: false