49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# module-brief Workflow Rule
|
|
|
|
This rule defines the module-brief workflow.
|
|
|
|
## Workflow Description
|
|
|
|
Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision
|
|
|
|
## Workflow Definition
|
|
|
|
# Module Brief Workflow Configuration
|
|
name: module-brief
|
|
description: "Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision"
|
|
author: "BMad Builder"
|
|
|
|
# Critical variables
|
|
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
|
output_folder: "{config_source}:output_folder"
|
|
user_name: "{config_source}:user_name"
|
|
communication_language: "{config_source}:communication_language"
|
|
date: system-generated
|
|
|
|
# Optional input docs that enhance module planning
|
|
recommended_inputs:
|
|
- brainstorming_results: "{output_folder}/brainstorming-*.md"
|
|
- existing_modules: "{project-root}/.bmad/"
|
|
- module_examples: "{project-root}/.bmad/bmb/workflows/create-module/module-structure.md"
|
|
|
|
# Module path and component files
|
|
installed_path: "{project-root}/.bmad/bmb/workflows/module-brief"
|
|
template: "{installed_path}/template.md"
|
|
instructions: "{installed_path}/instructions.md"
|
|
validation: "{installed_path}/checklist.md"
|
|
|
|
# Output configuration
|
|
default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md"
|
|
|
|
standalone: true
|
|
|
|
# Web bundle configuration
|
|
|
|
## Usage
|
|
|
|
Reference this workflow with `@workflow-module-brief` to execute the guided workflow.
|
|
|
|
## Module
|
|
|
|
Part of the BMAD BMB module.
|