bmad-method 6.0.0-alpha.9 → 6.0.1

package/src/modules/bmm/workflows/document-project/checklist.md

@@ -1,245 +0,0 @@
-# Document Project Workflow - Validation Checklist
-
-## Scan Level and Resumability (v1.2.0)
-
-- [ ] Scan level selection offered (quick/deep/exhaustive) for initial_scan and full_rescan modes
-- [ ] Deep-dive mode automatically uses exhaustive scan (no choice given)
-- [ ] Quick scan does NOT read source files (only patterns, configs, manifests)
-- [ ] Deep scan reads files in critical directories per project type
-- [ ] Exhaustive scan reads ALL source files (excluding node_modules, dist, build)
-- [ ] State file (project-scan-report.json) created at workflow start
-- [ ] State file updated after each step completion
-- [ ] State file contains all required fields per schema
-- [ ] Resumability prompt shown if state file exists and is <24 hours old
-- [ ] Old state files (>24 hours) automatically archived
-- [ ] Resume functionality loads previous state correctly
-- [ ] Workflow can jump to correct step when resuming
-
-## Write-as-you-go Architecture
-
-- [ ] Each document written to disk IMMEDIATELY after generation
-- [ ] Document validation performed right after writing (section-level)
-- [ ] State file updated after each document is written
-- [ ] Detailed findings purged from context after writing (only summaries kept)
-- [ ] Context contains only high-level summaries (1-2 sentences per section)
-- [ ] No accumulation of full project analysis in memory
-
-## Batching Strategy (Deep/Exhaustive Scans)
-
-- [ ] Batching applied for deep and exhaustive scan levels
-- [ ] Batches organized by SUBFOLDER (not arbitrary file count)
-- [ ] Large files (>5000 LOC) handled with appropriate judgment
-- [ ] Each batch: read files, extract info, write output, validate, purge context
-- [ ] Batch completion tracked in state file (batches_completed array)
-- [ ] Batch summaries kept in context (1-2 sentences max)
-
-## Project Detection and Classification
-
-- [ ] Project type correctly identified and matches actual technology stack
-- [ ] Multi-part vs single-part structure accurately detected
-- [ ] All project parts identified if multi-part (no missing client/server/etc.)
-- [ ] Documentation requirements loaded for each part type
-- [ ] Architecture registry match is appropriate for detected stack
-
-## Technology Stack Analysis
-
-- [ ] All major technologies identified (framework, language, database, etc.)
-- [ ] Versions captured where available
-- [ ] Technology decision table is complete and accurate
-- [ ] Dependencies and libraries documented
-- [ ] Build tools and package managers identified
-
-## Codebase Scanning Completeness
-
-- [ ] All critical directories scanned based on project type
-- [ ] API endpoints documented (if requires_api_scan = true)
-- [ ] Data models captured (if requires_data_models = true)
-- [ ] State management patterns identified (if requires_state_management = true)
-- [ ] UI components inventoried (if requires_ui_components = true)
-- [ ] Configuration files located and documented
-- [ ] Authentication/security patterns identified
-- [ ] Entry points correctly identified
-- [ ] Integration points mapped (for multi-part projects)
-- [ ] Test files and patterns documented
-
-## Source Tree Analysis
-
-- [ ] Complete directory tree generated with no major omissions
-- [ ] Critical folders highlighted and described
-- [ ] Entry points clearly marked
-- [ ] Integration paths noted (for multi-part)
-- [ ] Asset locations identified (if applicable)
-- [ ] File organization patterns explained
-
-## Architecture Documentation Quality
-
-- [ ] Architecture document uses appropriate template from registry
-- [ ] All template sections filled with relevant information (no placeholders)
-- [ ] Technology stack section is comprehensive
-- [ ] Architecture pattern clearly explained
-- [ ] Data architecture documented (if applicable)
-- [ ] API design documented (if applicable)
-- [ ] Component structure explained (if applicable)
-- [ ] Source tree included and annotated
-- [ ] Testing strategy documented
-- [ ] Deployment architecture captured (if config found)
-
-## Development and Operations Documentation
-
-- [ ] Prerequisites clearly listed
-- [ ] Installation steps documented
-- [ ] Environment setup instructions provided
-- [ ] Local run commands specified
-- [ ] Build process documented
-- [ ] Test commands and approach explained
-- [ ] Deployment process documented (if applicable)
-- [ ] CI/CD pipeline details captured (if found)
-- [ ] Contribution guidelines extracted (if found)
-
-## Multi-Part Project Specific (if applicable)
-
-- [ ] Each part documented separately
-- [ ] Part-specific architecture files created (architecture-{part_id}.md)
-- [ ] Part-specific component inventories created (if applicable)
-- [ ] Part-specific development guides created
-- [ ] Integration architecture document created
-- [ ] Integration points clearly defined with type and details
-- [ ] Data flow between parts explained
-- [ ] project-parts.json metadata file created
-
-## Index and Navigation
-
-- [ ] index.md created as master entry point
-- [ ] Project structure clearly summarized in index
-- [ ] Quick reference section complete and accurate
-- [ ] All generated docs linked from index
-- [ ] All existing docs linked from index (if found)
-- [ ] Getting started section provides clear next steps
-- [ ] AI-assisted development guidance included
-- [ ] Navigation structure matches project complexity (simple for single-part, detailed for multi-part)
-
-## File Completeness
-
-- [ ] index.md generated
-- [ ] project-overview.md generated
-- [ ] source-tree-analysis.md generated
-- [ ] architecture.md (or per-part) generated
-- [ ] component-inventory.md (or per-part) generated if UI components exist
-- [ ] development-guide.md (or per-part) generated
-- [ ] api-contracts.md (or per-part) generated if APIs documented
-- [ ] data-models.md (or per-part) generated if data models found
-- [ ] deployment-guide.md generated if deployment config found
-- [ ] contribution-guide.md generated if guidelines found
-- [ ] integration-architecture.md generated if multi-part
-- [ ] project-parts.json generated if multi-part
-
-## Content Quality
-
-- [ ] Technical information is accurate and specific
-- [ ] No generic placeholders or "TODO" items remain
-- [ ] Examples and code snippets are relevant to actual project
-- [ ] File paths and directory references are correct
-- [ ] Technology names and versions are accurate
-- [ ] Terminology is consistent across all documents
-- [ ] Descriptions are clear and actionable
-
-## Brownfield PRD Readiness
-
-- [ ] Documentation provides enough context for AI to understand existing system
-- [ ] Integration points are clear for planning new features
-- [ ] Reusable components are identified for leveraging in new work
-- [ ] Data models are documented for schema extension planning
-- [ ] API contracts are documented for endpoint expansion
-- [ ] Code conventions and patterns are captured for consistency
-- [ ] Architecture constraints are clear for informed decision-making
-
-## Output Validation
-
-- [ ] All files saved to correct output folder
-- [ ] File naming follows convention (no part suffix for single-part, with suffix for multi-part)
-- [ ] No broken internal links between documents
-- [ ] Markdown formatting is correct and renders properly
-- [ ] JSON files are valid (project-parts.json if applicable)
-
-## Final Validation
-
-- [ ] User confirmed project classification is accurate
-- [ ] User provided any additional context needed
-- [ ] All requested areas of focus addressed
-- [ ] Documentation is immediately usable for brownfield PRD workflow
-- [ ] No critical information gaps identified
-
-## Issues Found
-
-### Critical Issues (must fix before completion)
-
--
-
-### Minor Issues (can be addressed later)
-
--
-
-### Missing Information (to note for user)
-
--
-
-## Deep-Dive Mode Validation (if deep-dive was performed)
-
-- [ ] Deep-dive target area correctly identified and scoped
-- [ ] All files in target area read completely (no skipped files)
-- [ ] File inventory includes all exports with complete signatures
-- [ ] Dependencies mapped for all files
-- [ ] Dependents identified (who imports each file)
-- [ ] Code snippets included for key implementation details
-- [ ] Patterns and design approaches documented
-- [ ] State management strategy explained
-- [ ] Side effects documented (API calls, DB queries, etc.)
-- [ ] Error handling approaches captured
-- [ ] Testing files and coverage documented
-- [ ] TODOs and comments extracted
-- [ ] Dependency graph created showing relationships
-- [ ] Data flow traced through the scanned area
-- [ ] Integration points with rest of codebase identified
-- [ ] Related code and similar patterns found outside scanned area
-- [ ] Reuse opportunities documented
-- [ ] Implementation guidance provided
-- [ ] Modification instructions clear
-- [ ] Index.md updated with deep-dive link
-- [ ] Deep-dive documentation is immediately useful for implementation
-
----
-
-## State File Quality
-
-- [ ] State file is valid JSON (no syntax errors)
-- [ ] State file is optimized (no pretty-printing, minimal whitespace)
-- [ ] State file contains all completed steps with timestamps
-- [ ] State file outputs_generated list is accurate and complete
-- [ ] State file resume_instructions are clear and actionable
-- [ ] State file findings contain only high-level summaries (not detailed data)
-- [ ] State file can be successfully loaded for resumption
-
-## Completion Criteria
-
-All items in the following sections must be checked:
-
-- ✓ Scan Level and Resumability (v1.2.0)
-- ✓ Write-as-you-go Architecture
-- ✓ Batching Strategy (if deep/exhaustive scan)
-- ✓ Project Detection and Classification
-- ✓ Technology Stack Analysis
-- ✓ Architecture Documentation Quality
-- ✓ Index and Navigation
-- ✓ File Completeness
-- ✓ Brownfield PRD Readiness
-- ✓ State File Quality
-- ✓ Deep-Dive Mode Validation (if applicable)
-
-The workflow is complete when:
-
-1. All critical checklist items are satisfied
-2. No critical issues remain
-3. User has reviewed and approved the documentation
-4. Generated docs are ready for use in brownfield PRD workflow
-5. Deep-dive docs (if any) are comprehensive and implementation-ready
-6. State file is valid and can enable resumption if interrupted

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

@@ -1,222 +0,0 @@
-# Document Project Workflow Router
-
-<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
-<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmm/workflows/document-project/workflow.yaml</critical>
-<critical>Communicate all responses in {communication_language}</critical>
-
-<workflow>
-
-<critical>This router determines workflow mode and delegates to specialized sub-workflows</critical>
-
-<step n="1" goal="Validate workflow and get project info">
-
-<invoke-workflow path="{project-root}/{bmad_folder}/bmm/workflows/workflow-status">
-  <param>mode: data</param>
-  <param>data_request: project_config</param>
-</invoke-workflow>
-
-<check if="status_exists == false">
-  <output>{{suggestion}}</output>
-  <output>Note: Documentation workflow can run standalone. Continuing without progress tracking.</output>
-  <action>Set standalone_mode = true</action>
-  <action>Set status_file_found = false</action>
-</check>
-
-<check if="status_exists == true">
-  <action>Store {{status_file_path}} for later updates</action>
-  <action>Set status_file_found = true</action>
-
-  <!-- Extract brownfield/greenfield from status data -->
-  <check if="field_type == 'greenfield'">
-    <output>Note: This is a greenfield project. Documentation workflow is typically for brownfield projects.</output>
-    <ask>Continue anyway to document planning artifacts? (y/n)</ask>
-    <check if="n">
-      <action>Exit workflow</action>
-    </check>
-  </check>
-
-  <!-- Now validate sequencing -->
-  <invoke-workflow path="{project-root}/{bmad_folder}/bmm/workflows/workflow-status">
-    <param>mode: validate</param>
-    <param>calling_workflow: document-project</param>
-  </invoke-workflow>
-
-  <check if="warning != ''">
-    <output>{{warning}}</output>
-    <output>Note: This may be auto-invoked by prd for brownfield documentation.</output>
-    <ask>Continue with documentation? (y/n)</ask>
-    <check if="n">
-      <output>{{suggestion}}</output>
-      <action>Exit workflow</action>
-    </check>
-  </check>
-</check>
-
-</step>
-
-<step n="2" goal="Check for resumability and determine workflow mode">
-<critical>SMART LOADING STRATEGY: Check state file FIRST before loading any CSV files</critical>
-
-<action>Check for existing state file at: {output_folder}/project-scan-report.json</action>
-
-<check if="project-scan-report.json exists">
-  <action>Read state file and extract: timestamps, mode, scan_level, current_step, completed_steps, project_classification</action>
-  <action>Extract cached project_type_id(s) from state file if present</action>
-  <action>Calculate age of state file (current time - last_updated)</action>
-
-<ask>I found an in-progress workflow state from {{last_updated}}.
-
-**Current Progress:**
-
-- Mode: {{mode}}
-- Scan Level: {{scan_level}}
-- Completed Steps: {{completed_steps_count}}/{{total_steps}}
-- Last Step: {{current_step}}
-- Project Type(s): {{cached_project_types}}
-
-Would you like to:
-
-1. **Resume from where we left off** - Continue from step {{current_step}}
-2. **Start fresh** - Archive old state and begin new scan
-3. **Cancel** - Exit without changes
-
-Your choice [1/2/3]:
-</ask>
-
-    <check if="user selects 1">
-      <action>Set resume_mode = true</action>
-      <action>Set workflow_mode = {{mode}}</action>
-      <action>Load findings summaries from state file</action>
-      <action>Load cached project_type_id(s) from state file</action>
-
-      <critical>CONDITIONAL CSV LOADING FOR RESUME:</critical>
-      <action>For each cached project_type_id, load ONLY the corresponding row from: {documentation_requirements_csv}</action>
-      <action>Skip loading project-types.csv and architecture_registry.csv (not needed on resume)</action>
-      <action>Store loaded doc requirements for use in remaining steps</action>
-
-      <action>Display: "Resuming {{workflow_mode}} from {{current_step}} with cached project type(s): {{cached_project_types}}"</action>
-
-      <check if="workflow_mode == deep_dive">
-        <action>Load and execute: {installed_path}/workflows/deep-dive-instructions.md with resume context</action>
-      </check>
-
-      <check if="workflow_mode == initial_scan OR workflow_mode == full_rescan">
-        <action>Load and execute: {installed_path}/workflows/full-scan-instructions.md with resume context</action>
-      </check>
-    </check>
-
-    <check if="user selects 2">
-      <action>Create archive directory: {output_folder}/.archive/</action>
-      <action>Move old state file to: {output_folder}/.archive/project-scan-report-{{timestamp}}.json</action>
-      <action>Set resume_mode = false</action>
-      <action>Continue to Step 0.5</action>
-    </check>
-
-    <check if="user selects 3">
-      <action>Display: "Exiting workflow without changes."</action>
-      <action>Exit workflow</action>
-    </check>
-
-  </check>
-
-  <check if="state file age >= 24 hours">
-    <action>Display: "Found old state file (>24 hours). Starting fresh scan."</action>
-    <action>Archive old state file to: {output_folder}/.archive/project-scan-report-{{timestamp}}.json</action>
-    <action>Set resume_mode = false</action>
-    <action>Continue to Step 0.5</action>
-  </check>
-
-</step>
-
-<step n="3" goal="Check for existing documentation and determine workflow mode" if="resume_mode == false">
-<action>Check if {output_folder}/index.md exists</action>
-
-<check if="index.md exists">
-  <action>Read existing index.md to extract metadata (date, project structure, parts count)</action>
-  <action>Store as {{existing_doc_date}}, {{existing_structure}}</action>
-
-<ask>I found existing documentation generated on {{existing_doc_date}}.
-
-What would you like to do?
-
-1. **Re-scan entire project** - Update all documentation with latest changes
-2. **Deep-dive into specific area** - Generate detailed documentation for a particular feature/module/folder
-3. **Cancel** - Keep existing documentation as-is
-
-Your choice [1/2/3]:
-</ask>
-
-  <check if="user selects 1">
-    <action>Set workflow_mode = "full_rescan"</action>
-    <action>Display: "Starting full project rescan..."</action>
-    <action>Load and execute: {installed_path}/workflows/full-scan-instructions.md</action>
-    <action>After sub-workflow completes, continue to Step 4</action>
-  </check>
-
-  <check if="user selects 2">
-    <action>Set workflow_mode = "deep_dive"</action>
-    <action>Set scan_level = "exhaustive"</action>
-    <action>Display: "Starting deep-dive documentation mode..."</action>
-    <action>Load and execute: {installed_path}/workflows/deep-dive-instructions.md</action>
-    <action>After sub-workflow completes, continue to Step 4</action>
-  </check>
-
-  <check if="user selects 3">
-    <action>Display message: "Keeping existing documentation. Exiting workflow."</action>
-    <action>Exit workflow</action>
-  </check>
-</check>
-
-<check if="index.md does not exist">
-  <action>Set workflow_mode = "initial_scan"</action>
-  <action>Display: "No existing documentation found. Starting initial project scan..."</action>
-  <action>Load and execute: {installed_path}/workflows/full-scan-instructions.md</action>
-  <action>After sub-workflow completes, continue to Step 4</action>
-</check>
-
-</step>
-
-<step n="4" goal="Update status and complete">
-
-<check if="status_file_found == true">
-  <invoke-workflow path="{project-root}/{bmad_folder}/bmm/workflows/workflow-status">
-    <param>mode: update</param>
-    <param>action: complete_workflow</param>
-    <param>workflow_name: document-project</param>
-  </invoke-workflow>
-
-  <check if="success == true">
-    <output>Status updated!</output>
-  </check>
-</check>
-
-<output>**✅ Document Project Workflow Complete, {user_name}!**
-
-**Documentation Generated:**
-
-- Mode: {{workflow_mode}}
-- Scan Level: {{scan_level}}
-- Output: {output_folder}/bmm-index.md and related files
-
-{{#if status_file_found}}
-**Status Updated:**
-
-- Progress tracking updated
-
-**Next Steps:**
-
-- **Next required:** {{next_workflow}} ({{next_agent}} agent)
-
-Check status anytime with: `workflow-status`
-{{else}}
-**Next Steps:**
-Since no workflow is in progress:
-
-- Refer to the BMM workflow guide if unsure what to do next
-- Or run `workflow-init` to create a workflow path and get guided next steps
-  {{/if}}
-  </output>
-
-</step>
-
-</workflow>

package/src/modules/bmm/workflows/document-project/templates/project-scan-report-schema.json

@@ -1,160 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Project Scan Report Schema",
-  "description": "State tracking file for document-project workflow resumability",
-  "type": "object",
-  "required": ["workflow_version", "timestamps", "mode", "scan_level", "completed_steps", "current_step"],
-  "properties": {
-    "workflow_version": {
-      "type": "string",
-      "description": "Version of document-project workflow",
-      "example": "1.2.0"
-    },
-    "timestamps": {
-      "type": "object",
-      "required": ["started", "last_updated"],
-      "properties": {
-        "started": {
-          "type": "string",
-          "format": "date-time",
-          "description": "ISO 8601 timestamp when workflow started"
-        },
-        "last_updated": {
-          "type": "string",
-          "format": "date-time",
-          "description": "ISO 8601 timestamp of last state update"
-        },
-        "completed": {
-          "type": "string",
-          "format": "date-time",
-          "description": "ISO 8601 timestamp when workflow completed (if finished)"
-        }
-      }
-    },
-    "mode": {
-      "type": "string",
-      "enum": ["initial_scan", "full_rescan", "deep_dive"],
-      "description": "Workflow execution mode"
-    },
-    "scan_level": {
-      "type": "string",
-      "enum": ["quick", "deep", "exhaustive"],
-      "description": "Scan depth level (deep_dive mode always uses exhaustive)"
-    },
-    "project_root": {
-      "type": "string",
-      "description": "Absolute path to project root directory"
-    },
-    "output_folder": {
-      "type": "string",
-      "description": "Absolute path to output folder"
-    },
-    "completed_steps": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "required": ["step", "status"],
-        "properties": {
-          "step": {
-            "type": "string",
-            "description": "Step identifier (e.g., 'step_1', 'step_2')"
-          },
-          "status": {
-            "type": "string",
-            "enum": ["completed", "partial", "failed"]
-          },
-          "timestamp": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "outputs": {
-            "type": "array",
-            "items": { "type": "string" },
-            "description": "Files written during this step"
-          },
-          "summary": {
-            "type": "string",
-            "description": "1-2 sentence summary of step outcome"
-          }
-        }
-      }
-    },
-    "current_step": {
-      "type": "string",
-      "description": "Current step identifier for resumption"
-    },
-    "findings": {
-      "type": "object",
-      "description": "High-level summaries only (detailed findings purged after writing)",
-      "properties": {
-        "project_classification": {
-          "type": "object",
-          "properties": {
-            "repository_type": { "type": "string" },
-            "parts_count": { "type": "integer" },
-            "primary_language": { "type": "string" },
-            "architecture_type": { "type": "string" }
-          }
-        },
-        "technology_stack": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "part_id": { "type": "string" },
-              "tech_summary": { "type": "string" }
-            }
-          }
-        },
-        "batches_completed": {
-          "type": "array",
-          "description": "For deep/exhaustive scans: subfolders processed",
-          "items": {
-            "type": "object",
-            "properties": {
-              "path": { "type": "string" },
-              "files_scanned": { "type": "integer" },
-              "summary": { "type": "string" }
-            }
-          }
-        }
-      }
-    },
-    "outputs_generated": {
-      "type": "array",
-      "items": { "type": "string" },
-      "description": "List of all output files generated"
-    },
-    "resume_instructions": {
-      "type": "string",
-      "description": "Instructions for resuming from current_step"
-    },
-    "validation_status": {
-      "type": "object",
-      "properties": {
-        "last_validated": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "validation_errors": {
-          "type": "array",
-          "items": { "type": "string" }
-        }
-      }
-    },
-    "deep_dive_targets": {
-      "type": "array",
-      "description": "Track deep-dive areas analyzed (for deep_dive mode)",
-      "items": {
-        "type": "object",
-        "properties": {
-          "target_name": { "type": "string" },
-          "target_path": { "type": "string" },
-          "files_analyzed": { "type": "integer" },
-          "output_file": { "type": "string" },
-          "timestamp": { "type": "string", "format": "date-time" }
-        }
-      }
-    }
-  }
-}

package/src/modules/bmm/workflows/document-project/workflow.yaml

@@ -1,36 +0,0 @@
-# Document Project Workflow Configuration
-name: "document-project"
-version: "1.2.0"
-description: "Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development"
-author: "BMad"
-
-# Critical variables
-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"
-document_output_language: "{config_source}:document_output_language"
-user_skill_level: "{config_source}:user_skill_level"
-date: system-generated
-
-# Module path and component files
-installed_path: "{project-root}/{bmad_folder}/bmm/workflows/document-project"
-template: false # This is an action workflow with multiple output files
-instructions: "{installed_path}/instructions.md"
-validation: "{installed_path}/checklist.md"
-
-# Required data files - CRITICAL for project type detection and documentation requirements
-documentation_requirements_csv: "{installed_path}/documentation-requirements.csv"
-
-# Optional input - project root to scan (defaults to current working directory)
-recommended_inputs:
-  - project_root: "User will specify or use current directory"
-  - existing_readme: "README.md at project root (if exists)"
-  - project_config: "package.json, go.mod, requirements.txt, etc. (auto-detected)"
-# Output configuration - Multiple files generated in output folder
-# Primary output: {output_folder}/index.md
-# Additional files generated by sub-workflows based on project structure
-
-standalone: true
-
-web_bundle: false