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

package/src/core/resources/excalidraw/README.md

@@ -0,0 +1,160 @@
+# Core Excalidraw Resources
+
+Universal knowledge for creating Excalidraw diagrams. All agents that create Excalidraw files should reference these resources.
+
+## Purpose
+
+Provides the **HOW** (universal knowledge) while agents provide the **WHAT** (domain-specific application).
+
+**Core = "How to create Excalidraw elements"**
+
+- How to group shapes with text labels
+- How to calculate text width
+- How to create arrows with proper bindings
+- How to validate JSON syntax
+- Base structure and primitives
+
+**Agents = "What diagrams to create"**
+
+- Frame Expert (BMM): Technical flowcharts, architecture diagrams, wireframes
+- Presentation Master (CIS): Pitch decks, creative visuals, Rube Goldberg machines
+- Tech Writer (BMM): Documentation diagrams, concept explanations
+
+## Files in This Directory
+
+### excalidraw-helpers.md
+
+**Universal element creation patterns**
+
+- Text width calculation
+- Element grouping rules (shapes + labels)
+- Grid alignment
+- Arrow creation (straight, elbow)
+- Theme application
+- Validation checklist
+- Optimization rules
+
+**Agents reference this to:**
+
+- Create properly grouped shapes
+- Calculate text dimensions
+- Connect elements with arrows
+- Ensure valid structure
+
+### validate-json-instructions.md
+
+**Universal JSON validation process**
+
+- How to validate Excalidraw JSON
+- Common errors and fixes
+- Workflow integration
+- Error recovery
+
+**Agents reference this to:**
+
+- Validate files after creation
+- Fix syntax errors
+- Ensure files can be opened in Excalidraw
+
+### library-loader.md (Future)
+
+**How to load external .excalidrawlib files**
+
+- Programmatic library loading
+- Community library integration
+- Custom library management
+
+**Status:** To be developed when implementing external library support.
+
+## How Agents Use These Resources
+
+### Example: Frame Expert (Technical Diagrams)
+
+```yaml
+# workflows/diagrams/create-flowchart/workflow.yaml
+helpers: '{project-root}/{bmad_folder}/core/resources/excalidraw/excalidraw-helpers.md'
+json_validation: '{project-root}/{bmad_folder}/core/resources/excalidraw/validate-json-instructions.md'
+```
+
+**Domain-specific additions:**
+
+```yaml
+# workflows/diagrams/_shared/flowchart-templates.yaml
+flowchart:
+  start_node:
+    type: ellipse
+    width: 120
+    height: 60
+  process_box:
+    type: rectangle
+    width: 160
+    height: 80
+  decision_diamond:
+    type: diamond
+    width: 140
+    height: 100
+```
+
+### Example: Presentation Master (Creative Visuals)
+
+```yaml
+# workflows/create-visual-metaphor/workflow.yaml
+helpers: '{project-root}/{bmad_folder}/core/resources/excalidraw/excalidraw-helpers.md'
+json_validation: '{project-root}/{bmad_folder}/core/resources/excalidraw/validate-json-instructions.md'
+```
+
+**Domain-specific additions:**
+
+```yaml
+# workflows/_shared/creative-templates.yaml
+rube_goldberg:
+  whimsical_connector:
+    type: arrow
+    strokeStyle: dashed
+    roughness: 2
+  playful_box:
+    type: rectangle
+    roundness: 12
+```
+
+## What Doesn't Belong in Core
+
+**Domain-Specific Elements:**
+
+- Flowchart-specific templates (belongs in Frame Expert)
+- Pitch deck layouts (belongs in Presentation Master)
+- Documentation-specific styles (belongs in Tech Writer)
+
+**Agent Workflows:**
+
+- How to create a flowchart (Frame Expert workflow)
+- How to create a pitch deck (Presentation Master workflow)
+- Step-by-step diagram creation (agent-specific)
+
+**Theming:**
+
+- Currently in agent workflows
+- **Future:** Will be refactored to core as user-configurable themes
+
+## Architecture Principle
+
+**Single Source of Truth:**
+
+- Core holds universal knowledge
+- Agents reference core, don't duplicate
+- Updates to core benefit all agents
+- Agents specialize with domain knowledge
+
+**DRY (Don't Repeat Yourself):**
+
+- Element creation logic: ONCE in core
+- Text width calculation: ONCE in core
+- Validation process: ONCE in core
+- Arrow binding patterns: ONCE in core
+
+## Future Enhancements
+
+1. **External Library Loader** - Load .excalidrawlib files from libraries.excalidraw.com
+2. **Theme Management** - User-configurable color themes saved in core
+3. **Component Library** - Shared reusable components across agents
+4. **Layout Algorithms** - Auto-layout helpers for positioning elements

package/src/core/resources/excalidraw/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/core/resources/excalidraw/library-loader.md

@@ -0,0 +1,50 @@
+# External Library Loader
+
+**Status:** Placeholder for future implementation
+
+## Purpose
+
+Load external .excalidrawlib files from https://libraries.excalidraw.com or custom sources.
+
+## Planned Capabilities
+
+- Load libraries by URL
+- Load libraries from local files
+- Merge multiple libraries
+- Filter library components
+- Cache loaded libraries
+
+## API Reference
+
+Will document how to use:
+
+- `importLibrary(url)` - Load library from URL
+- `loadSceneOrLibraryFromBlob()` - Load from file
+- `mergeLibraryItems()` - Combine libraries
+
+## Usage Example
+
+```yaml
+# Future workflow.yaml structure
+libraries:
+  - url: 'https://libraries.excalidraw.com/libraries/...'
+    filter: ['aws', 'cloud']
+  - path: '{project-root}/_data/custom-library.excalidrawlib'
+```
+
+## Implementation Notes
+
+This will be developed when agents need to leverage the extensive library ecosystem available at https://libraries.excalidraw.com.
+
+Hundreds of pre-built component libraries exist for:
+
+- AWS/Cloud icons
+- UI/UX components
+- Business diagrams
+- Mind map shapes
+- Floor plans
+- And much more...
+
+## User Configuration
+
+Future: Users will be able to configure favorite libraries in their BMAD config for automatic loading.

package/src/core/resources/excalidraw/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/core/tasks/advanced-elicitation-methods.csv

@@ -0,0 +1,21 @@
+category,method_name,description,output_pattern
+core,Five Whys,Drill down to root causes by asking 'why' iteratively. Each answer becomes the basis for the next question. Particularly effective for problem analysis and understanding system failures.,problem → why1 → why2 → why3 → why4 → why5 → root cause
+core,First Principles,Break down complex problems into fundamental truths and rebuild from there. Question assumptions and reconstruct understanding from basic principles.,assumptions → deconstruction → fundamentals → reconstruction → solution
+structural,SWOT Analysis,Evaluate internal and external factors through Strengths Weaknesses Opportunities and Threats. Provides balanced strategic perspective.,strengths → weaknesses → opportunities → threats → strategic insights
+structural,Mind Mapping,Create visual representations of interconnected concepts branching from central idea. Reveals relationships and patterns not immediately obvious.,central concept → primary branches → secondary branches → connections → insights
+risk,Pre-mortem Analysis,Imagine project has failed and work backwards to identify potential failure points. Proactive risk identification through hypothetical failure scenarios.,future failure → contributing factors → warning signs → preventive measures
+risk,Risk Matrix,Evaluate risks by probability and impact to prioritize mitigation efforts. Visual framework for systematic risk assessment.,risk identification → probability assessment → impact analysis → prioritization → mitigation
+creative,SCAMPER,Systematic creative thinking through Substitute Combine Adapt Modify Put to other uses Eliminate Reverse. Generates innovative alternatives.,substitute → combine → adapt → modify → other uses → eliminate → reverse
+creative,Six Thinking Hats,Explore topic from six perspectives: facts (white) emotions (red) caution (black) optimism (yellow) creativity (green) process (blue).,facts → emotions → risks → benefits → alternatives → synthesis
+analytical,Root Cause Analysis,Systematic investigation to identify fundamental causes rather than symptoms. Uses various techniques to drill down to core issues.,symptoms → immediate causes → intermediate causes → root causes → solutions
+analytical,Fishbone Diagram,Visual cause-and-effect analysis organizing potential causes into categories. Also known as Ishikawa diagram for systematic problem analysis.,problem statement → major categories → potential causes → sub-causes → prioritization
+strategic,PESTLE Analysis,Examine Political Economic Social Technological Legal Environmental factors. Comprehensive external environment assessment.,political → economic → social → technological → legal → environmental → implications
+strategic,Value Chain Analysis,Examine activities that create value from raw materials to end customer. Identifies competitive advantages and improvement opportunities.,primary activities → support activities → linkages → value creation → optimization
+process,Journey Mapping,Visualize end-to-end experience identifying touchpoints pain points and opportunities. Understanding through customer or user perspective.,stages → touchpoints → actions → emotions → pain points → opportunities
+process,Service Blueprint,Map service delivery showing frontstage backstage and support processes. Reveals service complexity and improvement areas.,customer actions → frontstage → backstage → support processes → improvement areas
+stakeholder,Stakeholder Mapping,Identify and analyze stakeholders by interest and influence. Strategic approach to stakeholder engagement.,identification → interest analysis → influence assessment → engagement strategy
+stakeholder,Empathy Map,Understand stakeholder perspectives through what they think feel see say do. Deep understanding of user needs and motivations.,thinks → feels → sees → says → does → pains → gains
+decision,Decision Matrix,Evaluate options against weighted criteria for objective decision making. Systematic comparison of alternatives.,criteria definition → weighting → scoring → calculation → ranking → selection
+decision,Cost-Benefit Analysis,Compare costs against benefits to evaluate decision viability. Quantitative approach to decision validation.,cost identification → benefit identification → quantification → comparison → recommendation
+validation,Devil's Advocate,Challenge assumptions and proposals by arguing opposing viewpoint. Stress-testing through deliberate opposition.,proposal → counter-arguments → weaknesses → blind spots → strengthened proposal
+validation,Red Team Analysis,Simulate adversarial perspective to identify vulnerabilities. Security and robustness through adversarial thinking.,current approach → adversarial view → attack vectors → vulnerabilities → countermeasures

package/{bmad/core/tasks/adv-elicit.xml → src/core/tasks/advanced-elicitation.xml}

@@ -1,4 +1,6 @@
-<task id="bmad/core/tasks/adv-elicit.xml" name="Advanced Elicitation">
+<task id="{bmad_folder}/core/tasks/advanced-elicitation.xml" name="Advanced Elicitation" standalone="true"
+  methods="{project-root}/{bmad_folder}/core/tasks/advanced-elicitation-methods.csv"
+  agent-party="{project-root}/{bmad_folder}/_cfg/agent-manifest.csv">
   <llm critical="true">
     <i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
     <i>DO NOT skip steps or change the sequence</i>
@@ -9,7 +11,7 @@
 
   <integration description="When called from workflow">
     <desc>When called during template workflow processing:</desc>
-    <i>1. Receive the current section content that was just generated</i>
+    <i>1. Receive or review the current section content that was just generated or</i>
     <i>2. Apply elicitation methods iteratively to enhance that specific content</i>
     <i>3. Return the enhanced version back when user selects 'x' to proceed and return back</i>
     <i>4. The enhanced content replaces the original section content in the output document</i>
@@ -17,7 +19,7 @@
 
   <flow>
     <step n="1" title="Method Registry Loading">
-      <action>Load and read {project-root}/core/tasks/adv-elicit-methods.csv</action>
+      <action>Load and read {{methods}} and {{agent-party}}</action>
 
       <csv-structure>
         <i>category: Method grouping (core, structural, risk, etc.)</i>
@@ -66,7 +68,7 @@
           <i>CRITICAL: Re-present the same 1-5,r,x prompt to allow additional elicitations</i>
         </case>
         <case n="r">
-          <i>Select 5 different methods from adv-elicit-methods.csv, present new list with same prompt format</i>
+          <i>Select 5 different methods from advanced-elicitation-methods.csv, present new list with same prompt format</i>
         </case>
         <case n="x">
           <i>Complete elicitation and proceed</i>

package/src/core/tasks/index-docs.xml

@@ -1,4 +1,4 @@
-<task id="bmad/core/tasks/index-docs" name="Index Docs"
+<task id="{bmad_folder}/core/tasks/index-docs" name="Index Docs"
   description="Generates or updates an index.md of all documents in the specified directory" webskip="true" standalone="true">
   <llm critical="true">
     <i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>

package/src/core/tasks/validate-workflow.xml

@@ -1,4 +1,4 @@
-<task id="bmad/core/tasks/validate-workflow.xml" name="Validate Workflow Output">
+<task id="{bmad_folder}/core/tasks/validate-workflow.xml" name="Validate Workflow Output">
   <objective>Run a checklist against a document with thorough analysis and produce a validation report</objective>
 
   <inputs>