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

package/bmad/bmb/workflows/redoc/instructions.md

@@ -1,265 +0,0 @@
-# ReDoc Workflow Instructions
-
-<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
-<critical>You MUST have already loaded and processed: {project-root}/src/modules/bmb/workflows/redoc/workflow.yaml</critical>
-<critical>Communicate in {communication_language} throughout the documentation process</critical>
-<critical>This is an AUTONOMOUS workflow - minimize user interaction unless clarification is absolutely required</critical>
-<critical>IMPORTANT: Process ONE document at a time to avoid token limits. Each README should be created individually, not batched.</critical>
-<critical>When using Task tool with sub-agents: Only request ONE workflow or agent documentation per invocation to prevent token overflow.</critical>
-
-<workflow>
-
-<step n="1" goal="Load BMAD conventions and initialize">
-<action>Load ALL BMAD convention documents from {bmad_conventions}:
-- agent_architecture.md - Understand agent XML structure and patterns
-- agent_command_patterns.md - Command syntax and activation patterns
-- agent_types.md - Standard agent categories and purposes
-- module_structure.md - Module organization and folder conventions
-- workflow_guide.md - Workflow structure and best practices
-</action>
-
-<action>Internalize these conventions so you can:
-
-- Recognize standard patterns vs unique implementations
-- Describe only what's distinctive about each component
-- Use proper terminology consistently
-- Write with technical precision
-  </action>
-
-<action>Get target path from user:
-
-- Ask: "What do you want to document? (module path, workflow path, agent path, or folder path)"
-- Store as {{target_path}}
-  </action>
-
-<action>Validate target path exists and determine target type:
-
-- Module root (contains config.yaml, /workflows, /agents folders)
-- Workflows folder (contains multiple workflow folders)
-- Agents folder (contains multiple agent .md files)
-- Single workflow folder (contains workflow.yaml)
-- Single agent file (.md)
-  </action>
-
-<action>Store target type as {{target_type}} for conditional processing</action>
-</step>
-
-<step n="2" goal="Analyze directory structure and existing documentation">
-<action>Build complete tree structure of {{target_path}} using Glob and file system tools</action>
-
-<action>Identify all documentation points:
-
-- List all folders requiring README.md files
-- Detect existing README.md files
-- Parse frontmatter from existing READMEs to extract last-redoc-date
-- Calculate documentation depth (how many levels deep)
-  </action>
-
-<action>Create documentation map with execution order (deepest → shallowest):
-
-- Level 0 (deepest): Individual workflow folders, individual agent files
-- Level 1: /workflows folder, /agents folder
-- Level 2 (root): Module root README.md
-  </action>
-
-<action>Detect "massive folders" requiring child catalog documents:
-
-- Threshold: >10 items or complex categorization needed
-- Mark folders for catalog document creation (e.g., WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md)
-  </action>
-
-<critical>Store execution order as {{doc_execution_plan}} - this ensures reverse-tree processing</critical>
-</step>
-
-<step n="3" goal="Process leaf-level documentation" repeat="for-each-leaf-item">
-<critical>TOKEN LIMIT WARNING: Process ONE item at a time to prevent token overflow issues.</critical>
-<critical>If using Task tool with sub-agents: NEVER batch multiple workflows/agents in a single invocation.</critical>
-<critical>Each README creation should be a separate operation with its own file save.</critical>
-<critical>Sequential processing is MANDATORY - do not attempt parallel documentation generation.</critical>
-<action>For each individual workflow folder in execution plan (PROCESS ONE AT A TIME):
-1. Read ALL files completely:
-   - workflow.yaml (metadata, purpose, configuration)
-   - instructions.md (step structure, goals)
-   - template.md (output structure) if exists
-   - checklist.md (validation criteria) if exists
-   - Any supporting data files
-
-2. Synthesize understanding:
-   - Core purpose and use case
-   - Input requirements
-   - Output produced
-   - Unique characteristics (vs standard BMAD workflow patterns)
-   - Key steps or special features
-
-3. Generate/update README.md:
-   - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
-   - Write 2-4 paragraph technical description
-   - Include "Usage" section with invocation command
-   - Include "Inputs" section if applicable
-   - Include "Outputs" section
-   - Be succinct and precise - technical writer quality
-   - Focus on DISTINCTIVE features, not boilerplate
-
-4. Save README.md to workflow folder
-
-<critical>If multiple workflows need documentation, process them SEQUENTIALLY not in parallel. Each workflow gets its own complete processing cycle.</critical>
-</action>
-
-<action>For each individual agent file in execution plan (PROCESS ONE AT A TIME):
-
-1. Read agent definition file completely:
-   - XML structure and metadata
-   - Commands and their purposes
-   - Activation patterns
-   - Persona and communication style
-   - Critical actions and workflows invoked
-
-2. Synthesize understanding:
-   - Agent purpose and role
-   - Available commands
-   - When to use this agent
-   - Unique capabilities
-
-3. Generate/update README.md (or agent-name-README.md if in shared folder):
-   - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
-   - Write 1-3 paragraph technical description
-   - Include "Commands" section listing available commands
-   - Include "Usage" section
-   - Focus on distinctive features
-
-4. Save README.md
-   </action>
-
-<action if="clarification needed about purpose or unique features">Ask user briefly, then continue</action>
-</step>
-
-<step n="4" goal="Process mid-level folder documentation" if="target_type requires folder docs">
-<action>For /workflows folder:
-1. Read ALL workflow README.md files created in Step 3
-2. Categorize workflows by purpose/type if folder is massive (>10 workflows):
-   - Document generation workflows
-   - Action workflows
-   - Meta-workflows
-   - Interactive workflows
-
-3. If massive folder detected:
-   - Create WORKFLOWS-CATALOG.md with categorized listings
-   - Each entry: workflow name, 1-sentence description, link to folder
-   - Add frontmatter with last-redoc-date
-
-4. Generate/update /workflows/README.md:
-   - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
-   - High-level summary of workflow collection
-   - If catalog exists: reference it
-   - If not massive: list all workflows with brief descriptions and links
-   - Highlight notable or commonly-used workflows
-   - Keep succinct (1-2 paragraphs + list)
-
-5. Save README.md
-   </action>
-
-<action>For /agents folder:
-
-1. Read ALL agent README.md files
-2. Categorize agents by type if massive folder (>10 agents):
-   - Task agents
-   - Meta agents
-   - Specialized agents
-   - Utility agents
-
-3. If massive folder detected:
-   - Create AGENTS-CATALOG.md with categorized listings
-   - Each entry: agent name, 1-sentence description, link
-   - Add frontmatter with last-redoc-date
-
-4. Generate/update /agents/README.md:
-   - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
-   - High-level summary of agent collection
-   - If catalog exists: reference it
-   - If not massive: list all agents with brief descriptions
-   - Highlight key agents and their purposes
-   - Keep succinct
-
-5. Save README.md
-   </action>
-   </step>
-
-<step n="5" goal="Process root module documentation" if="target_type is module root">
-<action>For module root README.md:
-1. Read module config.yaml for metadata and configuration
-2. Read /workflows/README.md and /agents/README.md created in Step 4
-3. Identify module's unique purpose within BMAD ecosystem
-
-4. Generate/update module README.md:
-   - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
-
-   Structure:
-   - # Module Name
-   - **Purpose**: 2-3 sentence high-level module purpose
-   - **Overview**: 1-2 paragraphs describing what this module provides
-
-   - ## Workflows
-     - Link to /workflows/README.md with 1-sentence summary
-     - Mention count and highlight 2-3 key workflows
-
-   - ## Agents
-     - Link to /agents/README.md with 1-sentence summary
-     - Mention count and highlight 2-3 key agents
-
-   - ## Configuration
-     - Notable config.yaml settings if unique/important
-     - Reference paths and conventions
-
-   - ## Usage
-     - How to invoke workflows or agents from this module
-     - Prerequisites if any
-
-   Focus on UNIQUE aspects using BMAD convention knowledge:
-   - Don't explain standard BMAD patterns
-   - Highlight what makes THIS module distinctive
-   - Use proper BMAD terminology
-
-5. Save README.md to module root
-   </action>
-   </step>
-
-<step n="6" goal="Validation and summary report">
-<action>Verify all planned documentation was created/updated:
-- Check each item in {{doc_execution_plan}}
-- Confirm frontmatter dates are current
-- Validate file paths and links
-</action>
-
-<action>Generate summary report showing:
-
-- Target documented: {{target_path}}
-- Target type: {{target_type}}
-- Documentation files created/updated (count and list)
-- Any catalog files created
-- Files skipped or requiring manual review (if any)
-- Coverage: X% of items documented
-- Processing notes: Confirm sequential processing was used to avoid token limits
-  </action>
-
-<action>Display summary to user</action>
-</step>
-
-<step n="7" goal="Optional git diff analysis" optional="true">
-<ask>Would you like to see what changed since the last redoc run? [y/n]</ask>
-
-<action if="user_response == 'y'">
-For each README with last-redoc-date frontmatter:
-1. Extract last-redoc-date timestamp
-2. Use git log to find files modified since that date in the documented folder
-3. Highlight files that changed but may need documentation updates
-4. Report findings to user
-</action>
-</step>
-
-<step n="8" goal="Completion">
-<action>Confirm to {user_name} in {communication_language} that autonomous workflow execution is complete</action>
-<action>Provide path to all updated documentation</action>
-<action>Suggest next steps if needed</action>
-</step>
-
-</workflow>

package/bmad/bmb/workflows/redoc/workflow.yaml

@@ -1,32 +0,0 @@
-# ReDoc - Reverse-Tree Documentation Engine
-name: "redoc"
-description: "Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output."
-author: "BMad"
-
-# Critical variables
-config_source: "{project-root}/bmad/bmb/config.yaml"
-user_name: "{config_source}:user_name"
-communication_language: "{config_source}:communication_language"
-
-# Required knowledge base - BMAD conventions and patterns
-bmad_conventions:
-  agent_architecture: "{project-root}/src/modules/bmb/workflows/create-agent/agent-architecture.md"
-  agent_command_patterns: "{project-root}/src/modules/bmb/workflows/create-agent/agent-command-patterns.md"
-  agent_types: "{project-root}/src/modules/bmb/workflows/create-agent/agent-types.md"
-  module_structure: "{project-root}/src/modules/bmb/workflows/create-module/module-structure.md"
-  workflow_guide: "{project-root}/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md"
-
-# Runtime inputs
-target_path: "" # User specifies: module path, workflow path, agent path, or folder path
-
-# Module path and component files
-installed_path: "{project-root}/src/modules/bmb/workflows/redoc"
-template: false # Action workflow - updates files in place
-instructions: "{installed_path}/instructions.md"
-validation: "{installed_path}/checklist.md"
-
-# Configuration
-autonomous: true # Runs without user checkpoints unless clarification needed
-
-standalone: true
-# Web bundle configuration

package/bmad/bmb/workflows/redoc/workflow.yaml.bak

@@ -1,31 +0,0 @@
-# ReDoc - Reverse-Tree Documentation Engine
-name: "redoc"
-description: "Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output."
-author: "BMad"
-
-# Critical variables
-config_source: "{project-root}/bmad/bmb/config.yaml"
-user_name: "{config_source}:user_name"
-communication_language: "{config_source}:communication_language"
-
-# Required knowledge base - BMAD conventions and patterns
-bmad_conventions:
-  agent_architecture: "{project-root}/src/modules/bmb/workflows/create-agent/agent-architecture.md"
-  agent_command_patterns: "{project-root}/src/modules/bmb/workflows/create-agent/agent-command-patterns.md"
-  agent_types: "{project-root}/src/modules/bmb/workflows/create-agent/agent-types.md"
-  module_structure: "{project-root}/src/modules/bmb/workflows/create-module/module-structure.md"
-  workflow_guide: "{project-root}/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md"
-
-# Runtime inputs
-target_path: "" # User specifies: module path, workflow path, agent path, or folder path
-
-# Module path and component files
-installed_path: "{project-root}/src/modules/bmb/workflows/redoc"
-template: false # Action workflow - updates files in place
-instructions: "{installed_path}/instructions.md"
-validation: "{installed_path}/checklist.md"
-
-# Configuration
-autonomous: true # Runs without user checkpoints unless clarification needed
-
-# Web bundle configuration

package/bmad/bmd/README.md

@@ -1,193 +0,0 @@
-# BMD - BMAD Development Module
-
-**Version:** 1.0.0-alpha.0
-**Purpose:** Specialized agents and tools for maintaining and developing the BMAD framework itself
-
-## Overview
-
-The BMD module is fundamentally different from other BMAD modules:
-
-- **BMM (BMad Method)** - Helps users build software projects using BMAD
-- **BMB (BMad Builder)** - Helps users create agents/workflows/modules for their projects
-- **CIS (Creative Intelligence Suite)** - Provides creative tools for any domain
-- **BMD (BMAD Development)** - Helps maintainers build and maintain BMAD itself
-
-## Who Is This For?
-
-- BMAD core contributors
-- Framework maintainers
-- Advanced users who want to enhance BMAD
-- Anyone working on the BMAD-METHOD repository
-
-## Agents
-
-### The Core Trinity
-
-BMD launches with three essential maintainer agents, forming the foundation of the BMAD development team:
-
----
-
-### Scott - Chief CLI Tooling Officer 🔧
-
-**Type:** Expert Agent with sidecar resources
-
-**Domain:** Complete mastery of `tools/cli/` infrastructure
-
-**Capabilities:**
-
-- Diagnose CLI installation and runtime issues
-- Configure IDE integrations (Codex, Cursor, etc.)
-- Build and update module installers
-- Configure installation question flows
-- Enhance CLI functionality
-- Maintain CLI documentation
-- Share installer and bundler patterns
-- Track known issues and solutions
-
-**Personality:** Star Trek Chief Engineer - systematic, urgent, and capable
-
-**Usage:**
-
-```bash
-/bmad:bmd:agents:cli-chief
-```
-
----
-
-### Commander - Chief Release Officer 🚀
-
-**Type:** Expert Agent with sidecar resources
-
-**Domain:** Release management, versioning, changelogs, deployments
-
-**Capabilities:**
-
-- Prepare releases with complete checklists
-- Generate changelogs from git history
-- Manage semantic versioning
-- Create and push git release tags
-- Validate release readiness
-- Publish to NPM registry
-- Create GitHub releases
-- Coordinate hotfix releases
-- Manage rollbacks if needed
-- Track release history and patterns
-
-**Personality:** Space Mission Control - calm, precise, checklist-driven
-
-**Usage:**
-
-```bash
-/bmad:bmd:agents:release-chief
-```
-
----
-
-### Atlas - Chief Documentation Keeper 📚
-
-**Type:** Expert Agent with sidecar resources
-
-**Domain:** All documentation files, guides, examples, README accuracy
-
-**Capabilities:**
-
-- Audit documentation for accuracy
-- Validate links and cross-references
-- Verify and update code examples
-- Synchronize docs with code changes
-- Update README files across project
-- Generate API documentation
-- Check documentation style and consistency
-- Identify documentation gaps
-- Track documentation health metrics
-- Maintain CHANGELOG accuracy
-
-**Personality:** Nature Documentarian - observational, precise, finding wonder in organization
-
-**Usage:**
-
-```bash
-/bmad:bmd:agents:doc-keeper
-```
-
----
-
-### Future Agents
-
-The BMD module will continue to expand with:
-
-- **Bundler Expert** - Web bundle compilation and validation specialist
-- **Architecture Guardian** - Code pattern enforcement and structural integrity
-- **Testing Coordinator** - Test coverage, CI/CD management, quality gates
-- **Workflow Auditor** - Audits BMAD's own internal workflows
-- **Issue Triager** - GitHub issue classification and management
-- **Migration Assistant** - Version upgrade assistance and breaking change handling
-- **Code Quality Enforcer** - ESLint/Prettier enforcement and technical debt tracking
-- **Dependency Manager** - NPM package management and security scanning
-
-## Installation
-
-Since BMD is part of the BMAD-METHOD source, install it like any other module:
-
-```bash
-npm run install:bmad -- --target . --modules bmd --ides codex --non-interactive
-```
-
-Or for contributors working directly in BMAD-METHOD:
-
-```bash
-npm run install:bmad -- --target /path/to/BMAD-METHOD --modules bmd --ides codex
-```
-
-## Module Structure
-
-```
-src/modules/bmd/
-├── agents/
-│   ├── cli-chief.agent.yaml           # Scott - CLI expert
-│   ├── cli-chief-sidecar/             # Scott's workspace
-│   │   ├── memories.md
-│   │   ├── instructions.md
-│   │   └── knowledge/
-│   ├── release-chief.agent.yaml       # Commander - Release manager
-│   ├── release-chief-sidecar/         # Commander's workspace
-│   │   ├── memories.md
-│   │   ├── instructions.md
-│   │   └── knowledge/
-│   ├── doc-keeper.agent.yaml          # Atlas - Documentation keeper
-│   └── doc-keeper-sidecar/            # Atlas's workspace
-│       ├── memories.md
-│       ├── instructions.md
-│       └── knowledge/
-├── workflows/                         # Future: release prep, validation
-├── config.yaml                        # Module configuration
-└── README.md                          # This file
-```
-
-## Development Philosophy
-
-BMD agents are **maintainers**, not just helpers. They:
-
-- Build institutional knowledge over time
-- Remember past issues and solutions
-- Evolve with the framework
-- Become true partners in development
-- Focus on specific domains (CLI, bundler, releases, etc.)
-
-## Contributing
-
-When adding new BMD agents:
-
-1. Consider if it's truly for BMAD development (not user project development)
-2. Use Expert agent type for domain-specific maintainers
-3. Include comprehensive sidecar resources
-4. Document the domain boundaries clearly
-5. Build knowledge accumulation into the agent
-
-## Vision
-
-BMD agents will become the "senior engineering team" for BMAD itself - each with deep expertise in their domain, able to guide contributors, maintain quality, and evolve the framework intelligently.
-
-## License
-
-Same as BMAD-METHOD repository