bmad-method 6.0.0-alpha.20 → 6.0.0-alpha.22

package/src/modules/bmb/workflows/agent/data/expert-agent-validation.md

@@ -0,0 +1,173 @@
+# Expert Agent Validation Checklist
+
+Validate Expert agents meet BMAD quality standards.
+
+---
+
+## YAML Structure
+
+- [ ] YAML parses without errors
+- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module`
+- [ ] `agent.metadata.module` is `stand-alone` or module code (`bmm`, `cis`, `bmgd`, etc.)
+- [ ] `agent.persona` exists with: `role`, `identity`, `communication_style`, `principles`
+- [ ] `agent.critical_actions` exists (MANDATORY for Expert)
+- [ ] `agent.menu` exists with at least one item
+- [ ] File named: `{agent-name}.agent.yaml` (lowercase, hyphenated)
+
+---
+
+## Persona Validation
+
+### Field Separation
+
+- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does)
+- [ ] **identity** contains ONLY background/experience/context (who agent is)
+- [ ] **communication_style** contains ONLY verbal patterns (tone, voice, mannerisms)
+- [ ] **communication_style** includes memory reference patterns ("Last time you mentioned...")
+- [ ] **principles** contains operating philosophy and behavioral guidelines
+
+### Communication Style Purity
+
+- [ ] Does NOT contain: "ensures", "makes sure", "always", "never"
+- [ ] Does NOT contain identity words: "experienced", "expert who", "senior", "seasoned"
+- [ ] Does NOT contain philosophy words: "believes in", "focused on", "committed to"
+- [ ] Does NOT contain behavioral descriptions: "who does X", "that does Y"
+- [ ] Is 1-2 sentences describing HOW they talk
+- [ ] Reading aloud: sounds like describing someone's voice/speech pattern
+
+---
+
+## critical_actions Validation (MANDATORY)
+
+- [ ] `critical_actions` section exists
+- [ ] Contains at minimum 3 actions
+- [ ] **Loads sidecar memories:** `{project-root}/_bmad/_memory/{sidecar-folder}/memories.md`
+- [ ] **Loads sidecar instructions:** `{project-root}/_bmad/_memory/{sidecar-folder}/instructions.md`
+- [ ] **Restricts file access:** `ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/`
+- [ ] No placeholder text in critical_actions
+- [ ] No compiler-injected steps (Load persona, Load config, greeting, etc.)
+
+---
+
+## Sidecar Path Format (CRITICAL)
+
+- [ ] ALL sidecar paths use: `{project-root}/_bmad/_memory/{sidecar-folder}/...`
+- [ ] `{project-root}` is literal (not replaced)
+- [ ] `{sidecar-folder}` is actual sidecar folder name (e.g., `journal-keeper-sidecar`)
+- [ ] No relative paths like `./{sidecar-folder}/`
+- [ ] No absolute paths like `/Users/...`
+
+---
+
+## Menu Validation
+
+### Required Fields
+
+- [ ] All menu items have `trigger` field
+- [ ] All menu items have `description` field
+- [ ] All menu items have handler: `action` or `exec` (if module agent)
+
+### Trigger Format
+
+- [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code)
+- [ ] Codes are unique within agent
+- [ ] No reserved codes used: MH, CH, PM, DA (auto-injected)
+
+### Description Format
+
+- [ ] Descriptions start with `[XX]` code
+- [ ] Code in description matches trigger code
+- [ ] Descriptions are clear and descriptive
+
+### Action Handlers
+
+- [ ] If `action: '#prompt-id'`, corresponding prompt exists
+- [ ] If action references sidecar file, uses correct path format
+- [ ] Sidecar update actions are clear and complete
+
+---
+
+## Prompts Validation (if present)
+
+- [ ] Each prompt has `id` field
+- [ ] Each prompt has `content` field
+- [ ] Prompt IDs are unique within agent
+- [ ] Prompts reference memories naturally when appropriate
+
+---
+
+## Sidecar Folder Validation
+
+### Structure
+
+- [ ] Sidecar folder exists: `{agent-name}-sidecar/`
+- [ ] Folder name matches agent name
+- [ ] `instructions.md` exists (recommended)
+- [ ] `memories.md` exists (recommended)
+
+### File References
+
+- [ ] All referenced files actually exist
+- [ ] No orphaned/unused files (unless intentional for future use)
+- [ ] Files are valid format (YAML parses, markdown well-formed, etc.)
+
+### Path Consistency
+
+- [ ] All YAML references use correct path format
+- [ ] References between sidecar files (if any) use relative paths
+- [ ] References from agent YAML to sidecar use `{project-root}/_bmad/_memory/` format
+
+---
+
+## Expert Agent Specific
+
+- [ ] Has sidecar folder with supporting files
+- [ ] Sidecar content is fully customizable (not limited to templates)
+- [ ] Memory patterns integrated into persona and prompts
+- [ ] Domain restrictions enforced via critical_actions
+- [ ] Compare with reference: `journal-keeper.agent.yaml`
+
+---
+
+## Quality Checks
+
+- [ ] No broken references or missing files
+- [ ] Indentation is consistent
+- [ ] Agent purpose is clear from reading persona
+- [ ] Agent name/title are descriptive
+- [ ] Icon emoji is appropriate
+- [ ] Memory reference patterns feel natural
+
+---
+
+## What the Compiler Adds (DO NOT validate presence)
+
+These are auto-injected, don't validate for them:
+- Frontmatter (`---name/description---`)
+- XML activation block (your critical_actions become numbered steps)
+- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit)
+- Rules section
+
+---
+
+## Common Issues
+
+### Issue: Wrong Sidecar Path Format
+
+**Wrong:** `./journal-keeper-sidecar/memories.md`
+
+**Fix:** `{project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md`
+
+### Issue: Missing critical_actions
+
+**Fix:** Add at minimum:
+```yaml
+critical_actions:
+  - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md'
+  - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md'
+  - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/'
+```
+
+### Issue: Communication Style Missing Memory References
+
+**Fix:** Add memory reference patterns: "I reference past naturally: 'Last time you mentioned...'"

package/src/modules/bmb/workflows/agent/data/module-agent-validation.md

@@ -0,0 +1,124 @@
+# Module Agent Validation Checklist
+
+Validate Module agents meet BMAD quality standards.
+
+**Run this AFTER Simple or Expert validation.**
+
+---
+
+## Module Integration Validation
+
+### Module Membership
+
+- [ ] Designed FOR specific module (BMM, BMGD, CIS, or other existing module)
+- [ ] Module code in `agent.metadata.module` matches target module
+- [ ] Agent integrates with module's existing agents/workflows
+
+### Workflow Integration
+
+- [ ] Menu items reference module workflows via `exec:`
+- [ ] Workflow paths are correct and exist
+- [ ] Workflow paths use: `{project-root}/_bmad/{module-code}/workflows/...`
+- [ ] For workflows from other modules: uses both `workflow:` and `workflow-install:`
+
+### Agent Coordination
+
+- [ ] If inputs from other module agents: documented in menu description
+- [ ] If outputs to other module agents: clear handoff points
+- [ ] Agent role within module team is clear
+
+---
+
+## YAML Structure (Module-Specific)
+
+### Module Agent Can Be Simple OR Expert
+
+**If Simple-structure Module Agent:**
+- [ ] Single .agent.yaml file (no sidecar)
+- [ ] Uses `exec:` for workflow references
+- [ ] Pass `simple-agent-validation.md` first
+
+**If Expert-structure Module Agent:**
+- [ ] Has sidecar folder
+- [ ] Uses `exec:` for workflow references
+- [ ] Sidecar paths use `{project-root}/_bmad/_memory/{sidecar-folder}/` format
+- [ ] Pass `expert-agent-validation.md` first
+
+---
+
+## Menu Validation (Module-Specific)
+
+### Workflow Handlers
+
+- [ ] Module agents use `exec:` for workflow references
+- [ ] Workflow paths use `{project-root}` variable
+- [ ] Workflow paths point to existing workflows
+
+### Unimplemented Features
+
+- [ ] If `exec: 'todo'`, feature is documented as planned
+- [ ] Description indicates "Coming soon" or similar
+
+### Data Parameters (if used)
+
+- [ ] `data:` parameter references valid files
+- [ ] Data paths use `{project-root}` variable
+
+---
+
+## Module-Specific Quality
+
+- [ ] Agent extends module capabilities (not redundant with existing agents)
+- [ ] Agent has clear purpose within module ecosystem
+- [ ] Compare with reference: `security-engineer.agent.yaml` (BMM module example)
+
+---
+
+## Workflow Path Validation
+
+### Module Workflow Paths
+
+- [ ] Format: `{project-root}/_bmad/{module-code}/workflows/{workflow-name}/workflow.{md|yaml}`
+- [ ] Module codes: `bmm`, `bmgd`, `cis`, or custom module
+- [ ] Paths are case-sensitive and match actual file structure
+
+### Core Workflow Paths
+
+- [ ] Format: `{project-root}/_bmad/core/workflows/{workflow-name}/workflow.{md|yaml}`
+- [ ] Core workflows: `brainstorming`, `party-mode`, `advanced-elicitation`, etc.
+
+---
+
+## What the Compiler Adds (DO NOT validate presence)
+
+These are auto-injected, don't validate for them:
+- Frontmatter (`---name/description---`)
+- XML activation block
+- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit)
+- Rules section
+
+---
+
+## Common Issues
+
+### Issue: Wrong Module Code
+
+**Wrong:** `module: standalone`
+
+**Fix:** `module: stand-alone` (with hyphen) OR actual module code like `bmm`
+
+### Issue: Hardcoded Workflow Path
+
+**Wrong:** `exec: '../../../bmm/workflows/create-prd/workflow.md'`
+
+**Fix:** `exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md'`
+
+### Issue: Action Instead of Exec for Workflows
+
+**Wrong:** `action: '{project-root}/_bmad/.../workflow.md'`
+
+**Fix:** `exec: '{project-root}/_bmad/.../workflow.md'`
+
+### Issue: Redundant with Existing Agent
+
+**Fix:** Ensure agent fills gap or adds specialized capability not already present in module

package/src/modules/bmb/workflows/agent/data/persona-properties.md

@@ -0,0 +1,266 @@
+# Persona Properties
+
+The four-field persona system for agent personality.
+
+---
+
+## Four-Field System
+
+Each field serves a DISTINCT purpose when the compiled agent LLM reads them:
+
+| Field | Purpose | What LLM Interprets |
+|-------|---------|---------------------|
+| `role` | WHAT the agent does | Capabilities, skills, expertise |
+| `identity` | WHO the agent is | Background, experience, context |
+| `communication_style` | HOW the agent talks | Verbal patterns, tone, voice |
+| `principles` | WHAT GUIDES decisions | Beliefs, operating philosophy |
+
+**Critical:** Keep fields SEPARATE. Do not blur purposes.
+
+---
+
+## role
+
+**Purpose:** What the agent does - knowledge, skills, capabilities.
+
+**Format:** 1-2 lines, professional title or capability description
+
+```yaml
+# ✅ CORRECT
+role: |
+  I am a Commit Message Artisan who crafts git commits following conventional commit format.
+  I understand commit messages are documentation and help teams understand code evolution.
+
+role: |
+  Strategic Business Analyst + Requirements Expert connecting market insights to actionable strategy.
+
+# ❌ WRONG - Contains identity words
+role: |
+  I am an experienced analyst with 8+ years...  # "experienced", "8+ years" = identity
+
+# ❌ WRONG - Contains beliefs
+role: |
+  I believe every commit tells a story...  # "believe" = principles
+```
+
+---
+
+## identity
+
+**Purpose:** Who the agent is - background, experience, context, flair and personality.
+
+**Format:** 2-5 lines establishing credibility
+
+```yaml
+# ✅ CORRECT
+identity: |
+  Senior analyst with 8+ years connecting market insights to strategy.
+  Specialized in competitive intelligence and trend analysis.
+  Approach problems systematically with evidence-based methodology.
+
+# ❌ WRONG - Contains capabilities
+identity: |
+  I analyze markets and write reports...  # "analyze", "write" = role
+
+# ❌ WRONG - Contains communication style
+identity: |
+  I speak like a treasure hunter...  # communication style
+```
+
+---
+
+## communication_style
+
+**Purpose:** HOW the agent talks - verbal patterns, word choice, mannerisms.
+
+**Format:** 1-2 sentences MAX describing speech patterns only
+
+```yaml
+# ✅ CORRECT
+communication_style: |
+  Speaks with poetic dramatic flair, using metaphors of craftsmanship and artistry.
+
+communication_style: |
+  Talks like a pulp superhero with heroic language and dramatic exclamations.
+
+# ❌ WRONG - Contains behavioral words
+communication_style: |
+  Ensures all stakeholders are heard...  # "ensures" = not speech
+
+# ❌ WRONG - Contains identity
+communication_style: |
+  Experienced senior consultant who speaks professionally...  # "experienced", "senior" = identity
+
+# ❌ WRONG - Contains principles
+communication_style: |
+  Believes in clear communication...  # "believes in" = principles
+
+# ❌ WRONG - Contains role
+communication_style: |
+  Analyzes data while speaking...  # "analyzes" = role
+```
+
+**Purity Test:** Reading aloud, it should sound like describing someone's VOICE, not what they do or who they are.
+
+---
+
+## principles
+
+**Purpose:** What guides decisions - beliefs, operating philosophy, behavioral guidelines.
+
+**Format:** 3-8 bullet points or short statements
+
+```yaml
+# ✅ CORRECT
+principles:
+  - Every business challenge has root causes - dig deep
+  - Ground findings in evidence, not speculation
+  - Consider multiple perspectives before concluding
+  - Present insights clearly with actionable recommendations
+  - Acknowledge uncertainty when data is limited
+
+# ❌ WRONG - Contains capabilities
+principles:
+  - Analyze market data...  # "analyze" = role
+
+# ❌ WRONG - Contains background
+principles:
+  - With 8+ years of experience...  # = identity
+```
+
+**Format:** Use "I believe..." or "I operate..." for consistency.
+
+---
+
+## Field Separation Checklist
+
+Use this to verify purity - each field should ONLY contain its designated content:
+
+| Field | MUST NOT Contain |
+|-------|------------------|
+| `role` | Background, experience, speech patterns, beliefs |
+| `identity` | Capabilities, speech patterns, beliefs |
+| `communication_style` | Capabilities, background, beliefs, behavioral words |
+| `principles` | Capabilities, background, speech patterns |
+
+**Forbidden words in `communication_style`:**
+- "ensures", "makes sure", "always", "never"
+- "experienced", "expert who", "senior", "seasoned"
+- "believes in", "focused on", "committed to"
+- "who does X", "that does Y"
+
+---
+
+## Reading Aloud Test
+
+For `communication_style`, read it aloud and ask:
+
+- Does this describe someone's VOICE? ✅
+- Does this describe what they DO? ❌ (belongs in role)
+- Does this describe who they ARE? ❌ (belongs in identity)
+- Does this describe what they BELIEVE? ❌ (belongs in principles)
+
+---
+
+## Common Issues
+
+### Issue: Communication Style Soup
+
+**Wrong:** Everything mixed into communication_style
+```yaml
+communication_style: |
+  Experienced senior consultant who ensures stakeholders are heard,
+  believes in collaborative approaches, speaks professionally,
+  and analyzes data with precision.
+```
+
+**Fix:** Separate into proper fields
+```yaml
+role: |
+  Business analyst specializing in data analysis and stakeholder alignment.
+
+identity: |
+  Senior consultant with 8+ years facilitating cross-functional collaboration.
+
+communication_style: |
+  Speaks clearly and directly with professional warmth.
+
+principles:
+  - Ensure all stakeholder voices are heard
+  - Collaborative approaches yield better outcomes
+```
+
+### Issue: Role Contains Everything
+
+**Wrong:** Role as a catch-all
+```yaml
+role: |
+  I am an experienced analyst who speaks like a data scientist,
+  believes in evidence-based decisions, and has 10+ years
+  of experience in the field.
+```
+
+**Fix:** Distribute to proper fields
+```yaml
+role: |
+  Data analyst specializing in business intelligence and insights.
+
+identity: |
+  Professional with 10+ years in analytics and business intelligence.
+
+communication_style: |
+  Precise and analytical with technical terminology.
+
+principles:
+  - Evidence-based decisions over speculation
+  - Clarity over complexity
+```
+
+### Issue: Identity Missing
+
+**Wrong:** No identity field
+```yaml
+role: |
+  Senior analyst with 8+ years of experience...
+```
+
+**Fix:** Move background to identity
+```yaml
+role: |
+  Strategic Business Analyst + Requirements Expert.
+
+identity: |
+  Senior analyst with 8+ years connecting market insights to strategy.
+  Specialized in competitive intelligence and trend analysis.
+```
+
+---
+
+## Complete Example
+
+```yaml
+agent:
+  metadata:
+    id: _bmad/agents/commit-poet/commit-poet.md
+    name: 'Inkwell Von Comitizen'
+    title: 'Commit Message Artisan'
+
+  persona:
+    role: |
+      I craft git commit messages following conventional commit format.
+      I understand commits are documentation helping teams understand code evolution.
+
+    identity: |
+      Poetic soul who believes every commit tells a story worth remembering.
+      Trained in the art of concise technical documentation.
+
+    communication_style: |
+      Speaks with poetic dramatic flair, using metaphors of craftsmanship and artistry.
+
+    principles:
+      - Every commit tells a story - capture the why
+      - Conventional commits enable automation and clarity
+      - Present tense, imperative mood for commit subjects
+      - Body text explains what and why, not how
+      - Keep it under 72 characters when possible
+```