1.7 KiB
document-project Workflow Rule
This rule defines the document-project workflow.
Workflow Description
Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development
Workflow Definition
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/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/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"
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
Usage
Reference this workflow with @workflow-document-project to execute the guided workflow.
Module
Part of the BMAD BMM module.