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

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/techdoc/documentation-standards.md

@@ -0,0 +1,262 @@
+# Technical Documentation Standards for BMAD
+
+**For Agent: Technical Writer**
+**Purpose: Concise reference for documentation creation and review**
+
+---
+
+## CRITICAL RULES
+
+### Rule 1: CommonMark Strict Compliance
+
+ALL documentation MUST follow CommonMark specification exactly. No exceptions.
+
+### Rule 2: NO TIME ESTIMATES
+
+NEVER document time estimates, durations, or completion times for any workflow, task, or activity. This includes:
+
+- Workflow execution time (e.g., "30-60 min", "2-8 hours")
+- Task duration estimates
+- Reading time estimates
+- Implementation time ranges
+- Any temporal measurements
+
+Time varies dramatically based on:
+
+- Project complexity
+- Team experience
+- Tooling and environment
+- Context switching
+- Unforeseen blockers
+
+**Instead:** Focus on workflow steps, dependencies, and outputs. Let users determine their own timelines.
+
+### CommonMark Essentials
+
+**Headers:**
+
+- Use ATX-style ONLY: `#` `##` `###` (NOT Setext underlines)
+- Single space after `#`: `# Title` (NOT `#Title`)
+- No trailing `#`: `# Title` (NOT `# Title #`)
+- Hierarchical order: Don't skip levels (h1→h2→h3, not h1→h3)
+
+**Code Blocks:**
+
+- Use fenced blocks with language identifier:
+  ````markdown
+  ```javascript
+  const example = 'code';
+  ```
+  ````
+- NOT indented code blocks (ambiguous)
+
+**Lists:**
+
+- Consistent markers within list: all `-` or all `*` or all `+` (don't mix)
+- Proper indentation for nested items (2 or 4 spaces, stay consistent)
+- Blank line before/after list for clarity
+
+**Links:**
+
+- Inline: `[text](url)`
+- Reference: `[text][ref]` then `[ref]: url` at bottom
+- NO bare URLs without `<>` brackets
+
+**Emphasis:**
+
+- Italic: `*text*` or `_text_`
+- Bold: `**text**` or `__text__`
+- Consistent style within document
+
+**Line Breaks:**
+
+- Two spaces at end of line + newline, OR
+- Blank line between paragraphs
+- NO single line breaks (they're ignored)
+
+---
+
+## Mermaid Diagrams: Valid Syntax Required
+
+**Critical Rules:**
+
+1. Always specify diagram type first line
+2. Use valid Mermaid v10+ syntax
+3. Test syntax before outputting (mental validation)
+4. Keep focused: 5-10 nodes ideal, max 15
+
+**Diagram Type Selection:**
+
+- **flowchart** - Process flows, decision trees, workflows
+- **sequenceDiagram** - API interactions, message flows, time-based processes
+- **classDiagram** - Object models, class relationships, system structure
+- **erDiagram** - Database schemas, entity relationships
+- **stateDiagram-v2** - State machines, lifecycle stages
+- **gitGraph** - Branch strategies, version control flows
+
+**Formatting:**
+
+````markdown
+```mermaid
+flowchart TD
+    Start[Clear Label] --> Decision{Question?}
+    Decision -->|Yes| Action1[Do This]
+    Decision -->|No| Action2[Do That]
+```
+````
+
+---
+
+## Style Guide Principles (Distilled)
+
+Apply in this hierarchy:
+
+1. **Project-specific guide** (if exists) - always ask first
+2. **BMAD conventions** (this document)
+3. **Google Developer Docs style** (defaults below)
+4. **CommonMark spec** (when in doubt)
+
+### Core Writing Rules
+
+**Task-Oriented Focus:**
+
+- Write for user GOALS, not feature lists
+- Start with WHY, then HOW
+- Every doc answers: "What can I accomplish?"
+
+**Clarity Principles:**
+
+- Active voice: "Click the button" NOT "The button should be clicked"
+- Present tense: "The function returns" NOT "The function will return"
+- Direct language: "Use X for Y" NOT "X can be used for Y"
+- Second person: "You configure" NOT "Users configure" or "One configures"
+
+**Structure:**
+
+- One idea per sentence
+- One topic per paragraph
+- Headings describe content accurately
+- Examples follow explanations
+
+**Accessibility:**
+
+- Descriptive link text: "See the API reference" NOT "Click here"
+- Alt text for diagrams: Describe what it shows
+- Semantic heading hierarchy (don't skip levels)
+- Tables have headers
+- Emojis are acceptable if user preferences allow (modern accessibility tools support emojis well)
+
+---
+
+## OpenAPI/API Documentation
+
+**Required Elements:**
+
+- Endpoint path and method
+- Authentication requirements
+- Request parameters (path, query, body) with types
+- Request example (realistic, working)
+- Response schema with types
+- Response examples (success + common errors)
+- Error codes and meanings
+
+**Quality Standards:**
+
+- OpenAPI 3.0+ specification compliance
+- Complete schemas (no missing fields)
+- Examples that actually work
+- Clear error messages
+- Security schemes documented
+
+---
+
+## Documentation Types: Quick Reference
+
+**README:**
+
+- What (overview), Why (purpose), How (quick start)
+- Installation, Usage, Contributing, License
+- Under 500 lines (link to detailed docs)
+
+**API Reference:**
+
+- Complete endpoint coverage
+- Request/response examples
+- Authentication details
+- Error handling
+- Rate limits if applicable
+
+**User Guide:**
+
+- Task-based sections (How to...)
+- Step-by-step instructions
+- Screenshots/diagrams where helpful
+- Troubleshooting section
+
+**Architecture Docs:**
+
+- System overview diagram (Mermaid)
+- Component descriptions
+- Data flow
+- Technology decisions (ADRs)
+- Deployment architecture
+
+**Developer Guide:**
+
+- Setup/environment requirements
+- Code organization
+- Development workflow
+- Testing approach
+- Contribution guidelines
+
+---
+
+## Quality Checklist
+
+Before finalizing ANY documentation:
+
+- [ ] CommonMark compliant (no violations)
+- [ ] NO time estimates anywhere (Critical Rule 2)
+- [ ] Headers in proper hierarchy
+- [ ] All code blocks have language tags
+- [ ] Links work and have descriptive text
+- [ ] Mermaid diagrams render correctly
+- [ ] Active voice, present tense
+- [ ] Task-oriented (answers "how do I...")
+- [ ] Examples are concrete and working
+- [ ] Accessibility standards met
+- [ ] Spelling/grammar checked
+- [ ] Reads clearly at target skill level
+
+---
+
+## BMAD-Specific Conventions
+
+**File Organization:**
+
+- `README.md` at root of each major component
+- `docs/` folder for extensive documentation
+- Workflow-specific docs in workflow folder
+- Cross-references use relative paths
+
+**Frontmatter:**
+Use YAML frontmatter when appropriate:
+
+```yaml
+---
+title: Document Title
+description: Brief description
+author: Author name
+date: YYYY-MM-DD
+---
+```
+
+**Metadata:**
+
+- Always include last-updated date
+- Version info for versioned docs
+- Author attribution for accountability
+
+---
+
+**Remember: This is your foundation. Follow these rules consistently, and all documentation will be clear, accessible, and maintainable.**

package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md

@@ -355,8 +355,8 @@ See `tea-index.csv` for complete knowledge fragment mapping.
 
 - Ask in team standup
 - Tag @{tea_agent_username} in Slack/Discord
-- Refer to `testarch/README.md` for workflow documentation
-- Consult `testarch/knowledge/` for testing best practices
+- Refer to `./bmm/docs/tea-README.md` for workflow documentation
+- Consult `./bmm/testarch/knowledge` for testing best practices
 
 ---
 

package/src/modules/bmm/workflows/testarch/atdd/instructions.md

@@ -2,7 +2,7 @@
 
 # Acceptance Test-Driven Development (ATDD)
 
-**Workflow ID**: `bmad/bmm/testarch/atdd`
+**Workflow ID**: `{bmad_folder}/bmm/testarch/atdd`
 **Version**: 4.0 (BMad v6)
 
 ---
@@ -50,7 +50,7 @@ Generates failing acceptance tests BEFORE implementation following TDD's red-gre
 
 4. **Load Knowledge Base Fragments**
 
-   **Critical:** Consult `{project-root}/bmad/bmm/testarch/tea-index.csv` to load:
+   **Critical:** Consult `{project-root}/{bmad_folder}/bmm/testarch/tea-index.csv` to load:
    - `fixture-architecture.md` - Test fixture patterns with auto-cleanup (pure function → fixture → mergeTests composition, 406 lines, 5 examples)
    - `data-factories.md` - Factory patterns using faker (override patterns, nested factories, API seeding, 498 lines, 5 examples)
    - `component-tdd.md` - Component test strategies (red-green-refactor, provider isolation, accessibility, visual regression, 480 lines, 4 examples)

package/src/modules/bmm/workflows/testarch/atdd/workflow.yaml

@@ -4,7 +4,7 @@ description: "Generate failing acceptance tests before implementation using TDD
 author: "BMad"
 
 # Critical variables from config
-config_source: "{project-root}/bmad/bmm/config.yaml"
+config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
 communication_language: "{config_source}:communication_language"
@@ -12,7 +12,7 @@ document_output_language: "{config_source}:document_output_language"
 date: system-generated
 
 # Workflow components
-installed_path: "{project-root}/bmad/bmm/workflows/testarch/atdd"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/testarch/atdd"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 template: "{installed_path}/atdd-checklist-template.md"
@@ -32,13 +32,6 @@ required_tools:
   - list_files # Find existing fixtures and helpers
   - search_repo # Search for similar test patterns
 
-# Recommended inputs
-recommended_inputs:
-  - story: "Story markdown with acceptance criteria (required)"
-  - framework_config: "Test framework configuration (playwright.config.ts, cypress.config.ts)"
-  - existing_fixtures: "Current fixture patterns for consistency"
-  - test_design: "Test design document (optional, for risk/priority context)"
-
 tags:
   - qa
   - atdd

package/src/modules/bmm/workflows/testarch/automate/instructions.md

@@ -2,7 +2,7 @@
 
 # Test Automation Expansion
 
-**Workflow ID**: `bmad/bmm/testarch/automate`
+**Workflow ID**: `{bmad_folder}/bmm/testarch/automate`
 **Version**: 4.0 (BMad v6)
 
 ---
@@ -83,7 +83,7 @@ Expands test automation coverage by generating comprehensive test suites at appr
 
 5. **Load Knowledge Base Fragments**
 
-   **Critical:** Consult `{project-root}/bmad/bmm/testarch/tea-index.csv` to load:
+   **Critical:** Consult `{project-root}/{bmad_folder}/bmm/testarch/tea-index.csv` to load:
    - `test-levels-framework.md` - Test level selection (E2E vs API vs Component vs Unit with decision matrix, 467 lines, 4 examples)
    - `test-priorities-matrix.md` - Priority classification (P0-P3 with automated scoring, risk mapping, 389 lines, 2 examples)
    - `fixture-architecture.md` - Test fixture patterns (pure function → fixture → mergeTests, auto-cleanup, 406 lines, 5 examples)

package/src/modules/bmm/workflows/testarch/automate/workflow.yaml

@@ -4,7 +4,7 @@ description: "Expand test automation coverage after implementation or analyze ex
 author: "BMad"
 
 # Critical variables from config
-config_source: "{project-root}/bmad/bmm/config.yaml"
+config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
 communication_language: "{config_source}:communication_language"
@@ -12,7 +12,7 @@ document_output_language: "{config_source}:document_output_language"
 date: system-generated
 
 # Workflow components
-installed_path: "{project-root}/bmad/bmm/workflows/testarch/automate"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/testarch/automate"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 template: false
@@ -39,15 +39,6 @@ required_tools:
   - search_repo # Find coverage gaps and patterns
   - glob # Find test files and source files
 
-# Recommended inputs (optional - depends on mode)
-recommended_inputs:
-  - story: "Story markdown with acceptance criteria (optional - BMad mode only)"
-  - tech_spec: "Technical specification (optional - BMad mode only)"
-  - test_design: "Test design document with risk/priority (optional - BMad mode only)"
-  - source_code: "Feature implementation to analyze (required for standalone mode)"
-  - existing_tests: "Current test suite for gap analysis (always helpful)"
-  - framework_config: "Test framework configuration (playwright.config.ts, cypress.config.ts)"
-
 tags:
   - qa
   - automation

package/src/modules/bmm/workflows/testarch/ci/checklist.md

@@ -240,7 +240,7 @@ If workflow fails:
 
 **Checklist Complete**: Sign off when all items validated.
 
-**Completed by:** **\*\***\_\_\_**\*\***
-**Date:** **\*\***\_\_\_**\*\***
-**Platform:** **\*\***\_\_\_**\*\*** (GitHub Actions / GitLab CI)
-**Notes:** \***\*\*\*\*\***\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\***\*\*\*\*\***
+**Completed by:** {name}
+**Date:** {date}
+**Platform:** {GitHub Actions, GitLab CI, Other}
+**Notes:** {notes}

package/src/modules/bmm/workflows/testarch/ci/instructions.md

@@ -2,7 +2,7 @@
 
 # CI/CD Pipeline Setup
 
-**Workflow ID**: `bmad/bmm/testarch/ci`
+**Workflow ID**: `{bmad_folder}/bmm/testarch/ci`
 **Version**: 4.0 (BMad v6)
 
 ---
@@ -353,7 +353,7 @@ Scaffolds a production-ready CI/CD quality pipeline with test execution, burn-in
 
 ### Knowledge Base Integration
 
-**Critical:** Consult `{project-root}/bmad/bmm/testarch/tea-index.csv` to identify and load relevant knowledge fragments:
+**Critical:** Consult `{project-root}/{bmad_folder}/bmm/testarch/tea-index.csv` to identify and load relevant knowledge fragments:
 
 - `ci-burn-in.md` - Burn-in loop patterns: 10-iteration detection, GitHub Actions workflow, shard orchestration, selective execution (678 lines, 4 examples)
 - `selective-testing.md` - Changed test detection strategies: tag-based, spec filters, diff-based selection, promotion rules (727 lines, 4 examples)

package/src/modules/bmm/workflows/testarch/ci/workflow.yaml

@@ -4,7 +4,7 @@ description: "Scaffold CI/CD quality pipeline with test execution, burn-in loops
 author: "BMad"
 
 # Critical variables from config
-config_source: "{project-root}/bmad/bmm/config.yaml"
+config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
 communication_language: "{config_source}:communication_language"
@@ -12,7 +12,7 @@ document_output_language: "{config_source}:document_output_language"
 date: system-generated
 
 # Workflow components
-installed_path: "{project-root}/bmad/bmm/workflows/testarch/ci"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/testarch/ci"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 
@@ -32,14 +32,6 @@ required_tools:
   - list_files # Detect existing CI configuration
   - search_repo # Find test files for selective testing
 
-# Recommended inputs
-recommended_inputs:
-  - framework_config: "Framework configuration (playwright.config.ts, cypress.config.ts)"
-  - package_json: "Project dependencies and scripts"
-  - nvmrc: ".nvmrc for Node version (optional, defaults to LTS)"
-  - existing_ci: "Existing CI configuration to update (optional)"
-  - git_info: "Git repository information for platform detection"
-
 tags:
   - qa
   - ci-cd

package/src/modules/bmm/workflows/testarch/framework/checklist.md

@@ -315,7 +315,7 @@ If workflow fails and needs to be rolled back:
 
 **Checklist Complete**: Sign off when all items checked and validated.
 
-**Completed by:** **\*\***\_\_\_**\*\***
-**Date:** **\*\***\_\_\_**\*\***
-**Framework:** **\*\***\_\_\_**\*\*** (Playwright / Cypress)
-**Notes:** \***\*\*\*\*\***\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\***\*\*\*\*\***
+**Completed by:** {name}
+**Date:** {date}
+**Framework:** { Playwright / Cypress or something else}
+**Notes:** {notes}

package/src/modules/bmm/workflows/testarch/framework/instructions.md

@@ -2,7 +2,7 @@
 
 # Test Framework Setup
 
-**Workflow ID**: `bmad/bmm/testarch/framework`
+**Workflow ID**: `{bmad_folder}/bmm/testarch/framework`
 **Version**: 4.0 (BMad v6)
 
 ---
@@ -349,7 +349,7 @@ The generated `tests/README.md` should include:
 
 ### Knowledge Base Integration
 
-**Critical:** Consult `{project-root}/bmad/bmm/testarch/tea-index.csv` to identify and load relevant knowledge fragments:
+**Critical:** Consult `{project-root}/{bmad_folder}/bmm/testarch/tea-index.csv` to identify and load relevant knowledge fragments:
 
 - `fixture-architecture.md` - Pure function → fixture → `mergeTests` composition with auto-cleanup (406 lines, 5 examples)
 - `data-factories.md` - Faker-based factories with overrides, nested factories, API seeding, auto-cleanup (498 lines, 5 examples)

package/src/modules/bmm/workflows/testarch/framework/workflow.yaml

@@ -4,7 +4,7 @@ description: "Initialize production-ready test framework architecture (Playwrigh
 author: "BMad"
 
 # Critical variables from config
-config_source: "{project-root}/bmad/bmm/config.yaml"
+config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
 communication_language: "{config_source}:communication_language"
@@ -12,7 +12,7 @@ document_output_language: "{config_source}:document_output_language"
 date: system-generated
 
 # Workflow components
-installed_path: "{project-root}/bmad/bmm/workflows/testarch/framework"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/testarch/framework"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 
@@ -34,12 +34,6 @@ required_tools:
   - list_files # Check for existing framework
   - search_repo # Find architecture docs
 
-# Recommended inputs
-recommended_inputs:
-  - package_json: "package.json with project dependencies and scripts"
-  - architecture_docs: "Architecture or tech stack documentation (optional)"
-  - existing_tests: "Existing test files to detect current framework (optional)"
-
 tags:
   - qa
   - setup

package/src/modules/bmm/workflows/testarch/nfr-assess/instructions.md

@@ -50,7 +50,7 @@ This workflow performs a comprehensive assessment of non-functional requirements
 
 **Actions:**
 
-1. Load relevant knowledge fragments from `{project-root}/bmad/bmm/testarch/tea-index.csv`:
+1. Load relevant knowledge fragments from `{project-root}/{bmad_folder}/bmm/testarch/tea-index.csv`:
    - `nfr-criteria.md` - Non-functional requirements criteria and thresholds (security, performance, reliability, maintainability with code examples, 658 lines, 4 examples)
    - `ci-burn-in.md` - CI/CD burn-in patterns for reliability validation (10-iteration detection, sharding, selective execution, 678 lines, 4 examples)
    - `test-quality.md` - Test quality expectations for maintainability (deterministic, isolated, explicit assertions, length/time limits, 658 lines, 5 examples)

package/src/modules/bmm/workflows/testarch/nfr-assess/workflow.yaml

@@ -4,7 +4,7 @@ description: "Assess non-functional requirements (performance, security, reliabi
 author: "BMad"
 
 # Critical variables from config
-config_source: "{project-root}/bmad/bmm/config.yaml"
+config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
 communication_language: "{config_source}:communication_language"
@@ -12,7 +12,7 @@ document_output_language: "{config_source}:document_output_language"
 date: system-generated
 
 # Workflow components
-installed_path: "{project-root}/bmad/bmm/workflows/testarch/nfr-assess"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/testarch/nfr-assess"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 template: "{installed_path}/nfr-report-template.md"
@@ -33,15 +33,6 @@ required_tools:
   - search_repo # Find NFR-related tests and evidence
   - glob # Find result files matching patterns
 
-# Recommended inputs
-recommended_inputs:
-  - story: "Story markdown with NFR requirements (optional)"
-  - tech_spec: "Technical specification with NFR targets (recommended)"
-  - test_results: "Test execution results (performance, security, etc.)"
-  - metrics: "Application metrics (response times, error rates, etc.)"
-  - logs: "Application logs for reliability analysis"
-  - ci_results: "CI/CD pipeline results for burn-in validation"
-
 tags:
   - qa
   - nfr

package/src/modules/bmm/workflows/testarch/test-design/checklist.md

@@ -228,7 +228,7 @@ If workflow fails:
 
 **Checklist Complete**: Sign off when all items validated.
 
-**Completed by:** **\*\***\_\_\_**\*\***
-**Date:** **\*\***\_\_\_**\*\***
-**Epic:** **\*\***\_\_\_**\*\***
-**Notes:** \***\*\*\*\*\***\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\***\*\*\*\*\***
+**Completed by:** {name}
+**Date:** {date}
+**Epic:** {epic title}
+**Notes:** {additional notes}