bmad-method 6.0.0-alpha.1 → 6.0.0-alpha.10

package/src/modules/bmm/workflows/document-project/workflows/deep-dive.yaml

@@ -4,22 +4,22 @@ description: "Exhaustive deep-dive documentation of specific project areas"
 author: "BMad"
 
 # This is a sub-workflow called by document-project/workflow.yaml
-parent_workflow: "{project-root}/bmad/bmm/workflows/document-project/workflow.yaml"
+parent_workflow: "{project-root}/{bmad_folder}/bmm/workflows/document-project/workflow.yaml"
 
 # Critical variables inherited from parent
-config_source: "{project-root}/bmad/bmb/config.yaml"
+config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
 date: system-generated
 
 # Module path and component files
-installed_path: "{project-root}/bmad/bmm/workflows/document-project/workflows"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/document-project/workflows"
 template: false # Action workflow
 instructions: "{installed_path}/deep-dive-instructions.md"
-validation: "{project-root}/bmad/bmm/workflows/document-project/checklist.md"
+validation: "{project-root}/{bmad_folder}/bmm/workflows/document-project/checklist.md"
 
 # Templates
-deep_dive_template: "{project-root}/bmad/bmm/workflows/document-project/templates/deep-dive-template.md"
+deep_dive_template: "{project-root}/{bmad_folder}/bmm/workflows/document-project/templates/deep-dive-template.md"
 
 # Runtime inputs (passed from parent workflow)
 workflow_mode: "deep_dive"

package/src/modules/bmm/workflows/document-project/workflows/full-scan-instructions.md

@@ -325,11 +325,11 @@ findings.batches_completed: [
   </check>
 
 <action>Build API contracts catalog</action>
-<action>IMMEDIATELY write to: {output*folder}/api-contracts-{part_id}.md</action>
+<action>IMMEDIATELY write to: {output_folder}/api-contracts-{part_id}.md</action>
 <action>Validate document has all required sections</action>
 <action>Update state file with output generated</action>
 <action>PURGE detailed API data, keep only: "{{api_count}} endpoints documented"</action>
-<template-output>api_contracts*{part_id}</template-output>
+<template-output>api_contracts\*{part_id}</template-output>
 </check>
 
 <check if="requires_data_models == true">
@@ -346,11 +346,11 @@ findings.batches_completed: [
   </check>
 
 <action>Build database schema documentation</action>
-<action>IMMEDIATELY write to: {output*folder}/data-models-{part_id}.md</action>
+<action>IMMEDIATELY write to: {output_folder}/data-models-{part_id}.md</action>
 <action>Validate document completeness</action>
 <action>Update state file with output generated</action>
 <action>PURGE detailed schema data, keep only: "{{table_count}} tables documented"</action>
-<template-output>data_models*{part_id}</template-output>
+<template-output>data_models\*{part_id}</template-output>
 </check>
 
 <check if="requires_state_management == true">
@@ -758,15 +758,15 @@ When a document SHOULD be generated but wasn't (due to quick scan, missing data,
 ### Generated Documentation
 
 - [Project Overview](./project-overview.md)
-- [Architecture](./architecture{{#if multi-part}}-{part*id}{{/if}}.md){{#unless architecture_file_exists}} *(To be generated)\_{{/unless}}
+- [Architecture](./architecture{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless architecture_file_exists}} (To be generated) {{/unless}}
 - [Source Tree Analysis](./source-tree-analysis.md)
-- [Component Inventory](./component-inventory{{#if multi-part}}-{part*id}{{/if}}.md){{#unless component_inventory_exists}} *(To be generated)\_{{/unless}}
-- [Development Guide](./development-guide{{#if multi-part}}-{part*id}{{/if}}.md){{#unless dev_guide_exists}} *(To be generated)_{{/unless}}
-  {{#if deployment_found}}- [Deployment Guide](./deployment-guide.md){{#unless deployment_guide_exists}} _(To be generated)_{{/unless}}{{/if}}
+- [Component Inventory](./component-inventory{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless component_inventory_exists}} (To be generated) {{/unless}}
+- [Development Guide](./development-guide{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless dev_guide_exists}} (To be generated) {{/unless}}
+  {{#if deployment_found}}- [Deployment Guide](./deployment-guide.md){{#unless deployment_guide_exists}} (To be generated) {{/unless}}{{/if}}
   {{#if contribution_found}}- [Contribution Guide](./contribution-guide.md){{/if}}
-  {{#if api_documented}}- [API Contracts](./api-contracts{{#if multi-part}}-{part_id}{{/if}}.md){{#unless api_contracts_exists}} _(To be generated)_{{/unless}}{{/if}}
-  {{#if data_models_documented}}- [Data Models](./data-models{{#if multi-part}}-{part_id}{{/if}}.md){{#unless data_models_exists}} _(To be generated)_{{/unless}}{{/if}}
-  {{#if multi-part}}- [Integration Architecture](./integration-architecture.md){{#unless integration_arch_exists}} _(To be generated)\_{{/unless}}{{/if}}
+  {{#if api_documented}}- [API Contracts](./api-contracts{{#if multi-part}}-{part_id}{{/if}}.md){{#unless api_contracts_exists}} (To be generated) {{/unless}}{{/if}}
+  {{#if data_models_documented}}- [Data Models](./data-models{{#if multi-part}}-{part_id}{{/if}}.md){{#unless data_models_exists}} (To be generated) {{/unless}}{{/if}}
+  {{#if multi-part}}- [Integration Architecture](./integration-architecture.md){{#unless integration_arch_exists}} (To be generated) {{/unless}}{{/if}}
 
 ### Existing Documentation
 
@@ -850,10 +850,10 @@ Set {{incomplete_docs_list}} = {{incomplete_docs_strict}} + {{incomplete_docs_fu
 For each item store structure:
 {
 "title": "Architecture – Server",
-"file*path": "./architecture-server.md",
+"file\*path": "./architecture-server.md",
 "doc_type": "architecture",
 "part_id": "server",
-"line_text": "- [Architecture – Server](./architecture-server.md) *(To be generated)\_",
+"line_text": "- [Architecture – Server](./architecture-server.md) (To be generated)",
 "fuzzy_match": false
 }
 </action>

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

@@ -4,22 +4,22 @@ description: "Complete project documentation workflow (initial scan or full resc
 author: "BMad"
 
 # This is a sub-workflow called by document-project/workflow.yaml
-parent_workflow: "{project-root}/bmad/bmm/workflows/document-project/workflow.yaml"
+parent_workflow: "{project-root}/{bmad_folder}/bmm/workflows/document-project/workflow.yaml"
 
 # Critical variables inherited from parent
-config_source: "{project-root}/bmad/bmb/config.yaml"
+config_source: "{project-root}/{bmad_folder}/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"
+documentation_requirements_csv: "{project-root}/{bmad_folder}/bmm/workflows/document-project/documentation-requirements.csv"
 
 # Module path and component files
-installed_path: "{project-root}/bmad/bmm/workflows/document-project/workflows"
+installed_path: "{project-root}/{bmad_folder}/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"
+validation: "{project-root}/{bmad_folder}/bmm/workflows/document-project/checklist.md"
 
 # Runtime inputs (passed from parent workflow)
 workflow_mode: "" # "initial_scan" or "full_rescan"

package/src/modules/bmm/workflows/frame-expert/_shared/excalidraw-helpers.md

@@ -0,0 +1,127 @@
+# Excalidraw Element Creation Guidelines
+
+## Text Width Calculation
+
+For text elements inside shapes (labels):
+
+```
+text_width = (text.length × fontSize × 0.6) + 20
+```
+
+Round to nearest 10 for grid alignment.
+
+## Element Grouping Rules
+
+**CRITICAL:** When creating shapes with labels:
+
+1. Generate unique IDs:
+   - `shape-id` for the shape
+   - `text-id` for the text
+   - `group-id` for the group
+
+2. Shape element must have:
+   - `groupIds: [group-id]`
+   - `boundElements: [{type: "text", id: text-id}]`
+
+3. Text element must have:
+   - `containerId: shape-id`
+   - `groupIds: [group-id]` (SAME as shape)
+   - `textAlign: "center"`
+   - `verticalAlign: "middle"`
+   - `width: calculated_width`
+
+## Grid Alignment
+
+- Snap all `x`, `y` coordinates to 20px grid
+- Formula: `Math.round(value / 20) * 20`
+- Spacing between elements: 60px minimum
+
+## Arrow Creation
+
+### Straight Arrows
+
+Use for forward flow (left-to-right, top-to-bottom):
+
+```json
+{
+  "type": "arrow",
+  "startBinding": {
+    "elementId": "source-shape-id",
+    "focus": 0,
+    "gap": 10
+  },
+  "endBinding": {
+    "elementId": "target-shape-id",
+    "focus": 0,
+    "gap": 10
+  },
+  "points": [[0, 0], [distance_x, distance_y]]
+}
+```
+
+### Elbow Arrows
+
+Use for upward flow, backward flow, or complex routing:
+
+```json
+{
+  "type": "arrow",
+  "startBinding": {...},
+  "endBinding": {...},
+  "points": [
+    [0, 0],
+    [intermediate_x, 0],
+    [intermediate_x, intermediate_y],
+    [final_x, final_y]
+  ],
+  "elbowed": true
+}
+```
+
+### Update Connected Shapes
+
+After creating arrow, update `boundElements` on both connected shapes:
+
+```json
+{
+  "id": "shape-id",
+  "boundElements": [
+    { "type": "text", "id": "text-id" },
+    { "type": "arrow", "id": "arrow-id" }
+  ]
+}
+```
+
+## Theme Application
+
+Theme colors should be applied consistently:
+
+- **Shapes**: `backgroundColor` from theme primary fill
+- **Borders**: `strokeColor` from theme accent
+- **Text**: `strokeColor` = "#1e1e1e" (dark text)
+- **Arrows**: `strokeColor` from theme accent
+
+## Validation Checklist
+
+Before saving, verify:
+
+- [ ] All shapes with labels have matching `groupIds`
+- [ ] All text elements have `containerId` pointing to parent shape
+- [ ] Text width calculated properly (no cutoff)
+- [ ] Text alignment set (`textAlign` + `verticalAlign`)
+- [ ] All elements snapped to 20px grid
+- [ ] All arrows have `startBinding` and `endBinding`
+- [ ] `boundElements` array updated on connected shapes
+- [ ] Theme colors applied consistently
+- [ ] No metadata or history in final output
+- [ ] All IDs are unique
+
+## Optimization
+
+Remove from final output:
+
+- `appState` object
+- `files` object (unless images used)
+- All elements with `isDeleted: true`
+- Unused library items
+- Version history

package/src/modules/bmm/workflows/frame-expert/_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/modules/bmm/workflows/frame-expert/_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/modules/bmm/workflows/frame-expert/_shared/validate-json-instructions.md

@@ -0,0 +1,79 @@
+# JSON Validation Instructions
+
+## Purpose
+
+Validate Excalidraw JSON files after saving to catch syntax errors (missing commas, brackets, quotes).
+
+## How to Validate
+
+Use Node.js built-in JSON parsing to validate the file:
+
+```bash
+node -e "JSON.parse(require('fs').readFileSync('FILE_PATH', 'utf8')); console.log('✓ Valid JSON')"
+```
+
+Replace `FILE_PATH` with the actual file path.
+
+## Exit Codes
+
+- Exit code 0 = Valid JSON
+- Exit code 1 = Invalid JSON (syntax error)
+
+## Error Output
+
+If invalid, Node.js will output:
+
+- Error message with description
+- Position in file where error occurred
+- Line and column information (if available)
+
+## Common Errors and Fixes
+
+### Missing Comma
+
+```
+SyntaxError: Expected ',' or '}' after property value
+```
+
+**Fix:** Add comma after the property value
+
+### Missing Bracket/Brace
+
+```
+SyntaxError: Unexpected end of JSON input
+```
+
+**Fix:** Add missing closing bracket `]` or brace `}`
+
+### Extra Comma (Trailing)
+
+```
+SyntaxError: Unexpected token ,
+```
+
+**Fix:** Remove the trailing comma before `]` or `}`
+
+### Missing Quote
+
+```
+SyntaxError: Unexpected token
+```
+
+**Fix:** Add missing quote around string value
+
+## Workflow Integration
+
+After saving an Excalidraw file, run validation:
+
+1. Save the file
+2. Run: `node -e "JSON.parse(require('fs').readFileSync('{{save_location}}', 'utf8')); console.log('✓ Valid JSON')"`
+3. If validation fails:
+   - Read the error message for line/position
+   - Open the file at that location
+   - Fix the syntax error
+   - Save and re-validate
+4. Repeat until validation passes
+
+## Critical Rule
+
+**NEVER delete the file due to validation errors - always fix the syntax error at the reported location.**

package/src/modules/bmm/workflows/frame-expert/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