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

package/bmad/bmm/workflows/document-project/instructions.md

@@ -0,0 +1,222 @@
+# Document Project Workflow Router
+
+<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}/bmad/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/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/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/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/bmad/bmm/workflows/document-project/templates/deep-dive-template.md

@@ -0,0 +1,345 @@
+# {{target_name}} - Deep Dive Documentation
+
+**Generated:** {{date}}
+**Scope:** {{target_path}}
+**Files Analyzed:** {{file_count}}
+**Lines of Code:** {{total_loc}}
+**Workflow Mode:** Exhaustive Deep-Dive
+
+## Overview
+
+{{target_description}}
+
+**Purpose:** {{target_purpose}}
+**Key Responsibilities:** {{responsibilities}}
+**Integration Points:** {{integration_summary}}
+
+## Complete File Inventory
+
+{{#each files_in_inventory}}
+
+### {{file_path}}
+
+**Purpose:** {{purpose}}
+**Lines of Code:** {{loc}}
+**File Type:** {{file_type}}
+
+**What Future Contributors Must Know:** {{contributor_note}}
+
+**Exports:**
+{{#each exports}}
+
+- `{{signature}}` - {{description}}
+  {{/each}}
+
+**Dependencies:**
+{{#each imports}}
+
+- `{{import_path}}` - {{reason}}
+  {{/each}}
+
+**Used By:**
+{{#each dependents}}
+
+- `{{dependent_path}}`
+  {{/each}}
+
+**Key Implementation Details:**
+
+```{{language}}
+{{key_code_snippet}}
+```
+
+{{implementation_notes}}
+
+**Patterns Used:**
+{{#each patterns}}
+
+- {{pattern_name}}: {{pattern_description}}
+  {{/each}}
+
+**State Management:** {{state_approach}}
+
+**Side Effects:**
+{{#each side_effects}}
+
+- {{effect_type}}: {{effect_description}}
+  {{/each}}
+
+**Error Handling:** {{error_handling_approach}}
+
+**Testing:**
+
+- Test File: {{test_file_path}}
+- Coverage: {{coverage_percentage}}%
+- Test Approach: {{test_approach}}
+
+**Comments/TODOs:**
+{{#each todos}}
+
+- Line {{line_number}}: {{todo_text}}
+  {{/each}}
+
+---
+
+{{/each}}
+
+## Contributor Checklist
+
+- **Risks & Gotchas:** {{risks_notes}}
+- **Pre-change Verification Steps:** {{verification_steps}}
+- **Suggested Tests Before PR:** {{suggested_tests}}
+
+## Architecture & Design Patterns
+
+### Code Organization
+
+{{organization_approach}}
+
+### Design Patterns
+
+{{#each design_patterns}}
+
+- **{{pattern_name}}**: {{usage_description}}
+  {{/each}}
+
+### State Management Strategy
+
+{{state_management_details}}
+
+### Error Handling Philosophy
+
+{{error_handling_philosophy}}
+
+### Testing Strategy
+
+{{testing_strategy}}
+
+## Data Flow
+
+{{data_flow_diagram}}
+
+### Data Entry Points
+
+{{#each entry_points}}
+
+- **{{entry_name}}**: {{entry_description}}
+  {{/each}}
+
+### Data Transformations
+
+{{#each transformations}}
+
+- **{{transformation_name}}**: {{transformation_description}}
+  {{/each}}
+
+### Data Exit Points
+
+{{#each exit_points}}
+
+- **{{exit_name}}**: {{exit_description}}
+  {{/each}}
+
+## Integration Points
+
+### APIs Consumed
+
+{{#each apis_consumed}}
+
+- **{{api_endpoint}}**: {{api_description}}
+  - Method: {{method}}
+  - Authentication: {{auth_requirement}}
+  - Response: {{response_schema}}
+    {{/each}}
+
+### APIs Exposed
+
+{{#each apis_exposed}}
+
+- **{{api_endpoint}}**: {{api_description}}
+  - Method: {{method}}
+  - Request: {{request_schema}}
+  - Response: {{response_schema}}
+    {{/each}}
+
+### Shared State
+
+{{#each shared_state}}
+
+- **{{state_name}}**: {{state_description}}
+  - Type: {{state_type}}
+  - Accessed By: {{accessors}}
+    {{/each}}
+
+### Events
+
+{{#each events}}
+
+- **{{event_name}}**: {{event_description}}
+  - Type: {{publish_or_subscribe}}
+  - Payload: {{payload_schema}}
+    {{/each}}
+
+### Database Access
+
+{{#each database_operations}}
+
+- **{{table_name}}**: {{operation_type}}
+  - Queries: {{query_patterns}}
+  - Indexes Used: {{indexes}}
+    {{/each}}
+
+## Dependency Graph
+
+{{dependency_graph_visualization}}
+
+### Entry Points (Not Imported by Others in Scope)
+
+{{#each entry_point_files}}
+
+- {{file_path}}
+  {{/each}}
+
+### Leaf Nodes (Don't Import Others in Scope)
+
+{{#each leaf_files}}
+
+- {{file_path}}
+  {{/each}}
+
+### Circular Dependencies
+
+{{#if has_circular_dependencies}}
+⚠️ Circular dependencies detected:
+{{#each circular_deps}}
+
+- {{cycle_description}}
+  {{/each}}
+  {{else}}
+  ✓ No circular dependencies detected
+  {{/if}}
+
+## Testing Analysis
+
+### Test Coverage Summary
+
+- **Statements:** {{statements_coverage}}%
+- **Branches:** {{branches_coverage}}%
+- **Functions:** {{functions_coverage}}%
+- **Lines:** {{lines_coverage}}%
+
+### Test Files
+
+{{#each test_files}}
+
+- **{{test_file_path}}**
+  - Tests: {{test_count}}
+  - Approach: {{test_approach}}
+  - Mocking Strategy: {{mocking_strategy}}
+    {{/each}}
+
+### Test Utilities Available
+
+{{#each test_utilities}}
+
+- `{{utility_name}}`: {{utility_description}}
+  {{/each}}
+
+### Testing Gaps
+
+{{#each testing_gaps}}
+
+- {{gap_description}}
+  {{/each}}
+
+## Related Code & Reuse Opportunities
+
+### Similar Features Elsewhere
+
+{{#each similar_features}}
+
+- **{{feature_name}}** (`{{feature_path}}`)
+  - Similarity: {{similarity_description}}
+  - Can Reference For: {{reference_use_case}}
+    {{/each}}
+
+### Reusable Utilities Available
+
+{{#each reusable_utilities}}
+
+- **{{utility_name}}** (`{{utility_path}}`)
+  - Purpose: {{utility_purpose}}
+  - How to Use: {{usage_example}}
+    {{/each}}
+
+### Patterns to Follow
+
+{{#each patterns_to_follow}}
+
+- **{{pattern_name}}**: Reference `{{reference_file}}` for implementation
+  {{/each}}
+
+## Implementation Notes
+
+### Code Quality Observations
+
+{{#each quality_observations}}
+
+- {{observation}}
+  {{/each}}
+
+### TODOs and Future Work
+
+{{#each all_todos}}
+
+- **{{file_path}}:{{line_number}}**: {{todo_text}}
+  {{/each}}
+
+### Known Issues
+
+{{#each known_issues}}
+
+- {{issue_description}}
+  {{/each}}
+
+### Optimization Opportunities
+
+{{#each optimizations}}
+
+- {{optimization_suggestion}}
+  {{/each}}
+
+### Technical Debt
+
+{{#each tech_debt_items}}
+
+- {{debt_description}}
+  {{/each}}
+
+## Modification Guidance
+
+### To Add New Functionality
+
+{{modification_guidance_add}}
+
+### To Modify Existing Functionality
+
+{{modification_guidance_modify}}
+
+### To Remove/Deprecate
+
+{{modification_guidance_remove}}
+
+### Testing Checklist for Changes
+
+{{#each testing_checklist_items}}
+
+- [ ] {{checklist_item}}
+      {{/each}}
+
+---
+
+_Generated by `document-project` workflow (deep-dive mode)_
+_Base Documentation: docs/index.md_
+_Scan Date: {{date}}_
+_Analysis Mode: Exhaustive_