create workflow validation check fixes
This commit is contained in:
parent
4539ca7436
commit
ad053a6508
|
|
@ -59,6 +59,11 @@ Load and read full config from {project-root}/{bmad_folder}/[module such as core
|
||||||
|
|
||||||
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [any additional variables]
|
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [any additional variables]
|
||||||
|
|
||||||
|
**Note:** Use variable substitution patterns for flexible installation paths:
|
||||||
|
- `{project-root}` - Root directory of the project
|
||||||
|
- `{bmad_folder}` - Name of the BMAD folder (usually `.bmad`)
|
||||||
|
- `[module]` - Module name (core, bmm, bmb, or custom)
|
||||||
|
|
||||||
### 2. First Step EXECUTION
|
### 2. First Step EXECUTION
|
||||||
|
|
||||||
Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
|
Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
|
||||||
|
|
|
||||||
|
|
@ -19,6 +19,7 @@ partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workf
|
||||||
|
|
||||||
# Template References
|
# Template References
|
||||||
projectInfoTemplate: '{workflow_path}/templates/project-info.md'
|
projectInfoTemplate: '{workflow_path}/templates/project-info.md'
|
||||||
|
workflowPlanTemplate: '{workflow_path}/templates/workflow-plan.md'
|
||||||
---
|
---
|
||||||
|
|
||||||
# Step 1: Workflow Creation Initialization
|
# Step 1: Workflow Creation Initialization
|
||||||
|
|
@ -110,7 +111,7 @@ Ask conversationally:
|
||||||
|
|
||||||
#### B. Create Workflow Plan Document
|
#### B. Create Workflow Plan Document
|
||||||
|
|
||||||
Create the workflow plan document at `{workflowPlanFile}` using the workflow plan template.
|
Create the workflow plan document at `{workflowPlanFile}` using the workflow plan template `{workflowPlanTemplate}`.
|
||||||
Initialize frontmatter with:
|
Initialize frontmatter with:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
|
||||||
|
|
@ -205,7 +205,7 @@ Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Conti
|
||||||
|
|
||||||
- IF A: Execute {advancedElicitationTask}
|
- IF A: Execute {advancedElicitationTask}
|
||||||
- IF P: Execute {partyModeWorkflow}
|
- IF P: Execute {partyModeWorkflow}
|
||||||
- IF C: Store requirements, then only then load, read entire file, then execute {nextStepFile}
|
- IF C: Append requirements to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
|
||||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options)
|
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options)
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
|
||||||
|
|
@ -98,13 +98,12 @@ Append to {workflowPlanFile}:
|
||||||
|
|
||||||
### 5. Menu Options
|
### 5. Menu Options
|
||||||
|
|
||||||
Display: **Select an Option:** [C] Continue to Core Tools [M] Modify Requirements [X] Exit
|
Display: **Select an Option:** [C] Continue to Core Tools [M] Modify Requirements
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF C: Save requirements and load {nextStepFile}
|
- IF C: Append tools overview to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
|
||||||
- IF M: Refine requirements discussion
|
- IF M: Refine requirements discussion
|
||||||
- IF X: Save current state and end session
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -116,13 +116,12 @@ Append to {workflowPlanFile}:
|
||||||
|
|
||||||
### 5. Menu Options
|
### 5. Menu Options
|
||||||
|
|
||||||
Display: **Select an Option:** [C] Continue to Memory Configuration [M] Modify Core Tools [X] Exit
|
Display: **Select an Option:** [C] Continue to Memory Configuration [M] Modify Core Tools
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF C: Save configuration and load {nextStepFile}
|
- IF C: Append core tools configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
|
||||||
- IF M: Return to tool configuration
|
- IF M: Return to tool configuration
|
||||||
- IF X: Save current state and end session
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -107,13 +107,12 @@ Append to {workflowPlanFile}:
|
||||||
|
|
||||||
### 6. Menu Options
|
### 6. Menu Options
|
||||||
|
|
||||||
Display: **Select an Option:** [C] Continue to External Tools [M] Modify Memory [X] Exit
|
Display: **Select an Option:** [C] Continue to External Tools [M] Modify Memory
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF C: Save memory configuration and load {nextStepFile}
|
- IF C: Append memory configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
|
||||||
- IF M: Refine memory requirements
|
- IF M: Refine memory requirements
|
||||||
- IF X: Save current state and end session
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -125,13 +125,12 @@ Append to {workflowPlanFile}:
|
||||||
|
|
||||||
### 6. Menu Options
|
### 6. Menu Options
|
||||||
|
|
||||||
Display: **Select an Option:** [C] Continue to Installation Guidance [M] Modify External Tools [X] Exit
|
Display: **Select an Option:** [C] Continue to Installation Guidance [M] Modify External Tools
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF C: Save selections and load {nextStepFile}
|
- IF C: Append external tools configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
|
||||||
- IF M: Refine external tool requirements
|
- IF M: Refine external tool requirements
|
||||||
- IF X: Save current state and end session
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -130,13 +130,12 @@ Append to {workflowPlanFile}:
|
||||||
|
|
||||||
### 6. Menu Options
|
### 6. Menu Options
|
||||||
|
|
||||||
Display: **Select an Option:** [C] Continue to Tools Summary [M] Modify Installation Approach [X] Exit
|
Display: **Select an Option:** [C] Continue to Tools Summary [M] Modify Installation Approach
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF C: Save installation configuration and load {nextStepFile}
|
- IF C: Append installation configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
|
||||||
- IF M: Refine installation approach
|
- IF M: Refine installation approach
|
||||||
- IF X: Save current state and end session
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||||
|
|
||||||
# File References
|
# File References
|
||||||
thisStepFile: '{workflow_path}/steps/step-08-tools-summary.md'
|
thisStepFile: '{workflow_path}/steps/step-08-tools-summary.md'
|
||||||
nextStepFile: '{workflow_path}/steps/step-04-design.md'
|
nextStepFile: '{workflow_path}/steps/step-09-design.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
workflowFile: '{workflow_path}/workflow.md'
|
||||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||||
|
|
||||||
|
|
@ -136,13 +136,12 @@ All tools configured and ready for workflow design phase.
|
||||||
|
|
||||||
### 5. Menu Options
|
### 5. Menu Options
|
||||||
|
|
||||||
Display: **Select an Option:** [C] Continue to Workflow Design [M] Modify Configuration [X] Exit
|
Display: **Select an Option:** [C] Continue to Workflow Design [M] Modify Configuration
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF C: Save final summary, update frontmatter stepsCompleted: [3, 4, 5, 6, 7, 8], then load {nextStepFile}
|
- IF C: Save final summary, update frontmatter stepsCompleted: [3, 4, 5, 6, 7, 8], then load {nextStepFile}
|
||||||
- IF M: Return to specific configuration step
|
- IF M: Return to specific configuration step
|
||||||
- IF X: Save current state and end session
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,13 @@
|
||||||
---
|
---
|
||||||
name: 'step-04-design'
|
name: 'step-09-design'
|
||||||
description: 'Design the workflow structure and step sequence based on gathered requirements and tools configuration'
|
description: 'Design the workflow structure and step sequence based on gathered requirements and tools configuration'
|
||||||
|
|
||||||
# Path Definitions
|
# Path Definitions
|
||||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||||
|
|
||||||
# File References
|
# File References
|
||||||
thisStepFile: '{workflow_path}/steps/step-04-design.md'
|
thisStepFile: '{workflow_path}/steps/step-09-design.md'
|
||||||
nextStepFile: '{workflow_path}/steps/step-05-review-plan.md'
|
nextStepFile: '{workflow_path}/steps/step-10-plan-review.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
workflowFile: '{workflow_path}/workflow.md'
|
||||||
# Output files for workflow creation process
|
# Output files for workflow creation process
|
||||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,13 @@
|
||||||
---
|
---
|
||||||
name: 'step-05-review-plan'
|
name: 'step-10-plan-review'
|
||||||
description: 'Review the complete workflow plan before generating files'
|
description: 'Review the complete workflow plan before generating files'
|
||||||
|
|
||||||
# Path Definitions
|
# Path Definitions
|
||||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||||
|
|
||||||
# File References
|
# File References
|
||||||
thisStepFile: '{workflow_path}/steps/step-05-review-plan.md'
|
thisStepFile: '{workflow_path}/steps/step-10-plan-review.md'
|
||||||
nextStepFile: '{workflow_path}/steps/step-06-build.md'
|
nextStepFile: '{workflow_path}/steps/step-11-build.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
workflowFile: '{workflow_path}/workflow.md'
|
||||||
# Output files for workflow creation process
|
# Output files for workflow creation process
|
||||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||||
|
|
@ -82,26 +82,43 @@ Read the entire {workflowPlanFile} and present it to the user:
|
||||||
- Implementation Plan
|
- Implementation Plan
|
||||||
- Target Location and file structure
|
- Target Location and file structure
|
||||||
|
|
||||||
### 2. Walk Through Key Aspects
|
### 2. Analyze Plan for Gaps and Issues
|
||||||
|
|
||||||
Explain the plan's key components:
|
Perform systematic analysis of the loaded plan:
|
||||||
|
|
||||||
- **Workflow Flow**: Linear, looping, branching, or iterative
|
**Logical Flow Check:**
|
||||||
- **Step Structure**: Number of steps and their purposes
|
|
||||||
- **Instruction Style**: Intent-based vs prescriptive approach
|
|
||||||
- **User Interaction**: How users will interact with the workflow
|
|
||||||
- **Files to Generate**: Complete list of files that will be created
|
|
||||||
|
|
||||||
### 3. Address Questions and Concerns
|
- Do requirements align with proposed solution?
|
||||||
|
- Are tools appropriate for the workflow type?
|
||||||
|
- Is step sequence logical and complete?
|
||||||
|
- Are there missing transitions between steps?
|
||||||
|
|
||||||
Answer any questions about:
|
**Completeness Review:**
|
||||||
|
|
||||||
- Why certain design decisions were made
|
- All requirements captured and addressed?
|
||||||
- How specific requirements will be met
|
- Design covers all user scenarios?
|
||||||
- Whether the workflow will handle edge cases
|
- Implementation plan includes all necessary files?
|
||||||
- Any concerns about the implementation approach
|
- Are there unclear or ambiguous specifications?
|
||||||
|
|
||||||
### 4. Gather Feedback
|
**Architecture Validation:**
|
||||||
|
|
||||||
|
- Follows BMAD step-file architecture?
|
||||||
|
- Proper use of template patterns?
|
||||||
|
- Menu flow is logical and complete?
|
||||||
|
- Variable naming is consistent?
|
||||||
|
|
||||||
|
**Issue Identification:**
|
||||||
|
If gaps or issues found:
|
||||||
|
|
||||||
|
- Clearly identify each issue
|
||||||
|
- Propose specific solutions
|
||||||
|
- Ask for user input on resolution approach
|
||||||
|
|
||||||
|
### 3. Present Menu for Plan Approval
|
||||||
|
|
||||||
|
Display: **Plan Review Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Build
|
||||||
|
|
||||||
|
### 4. Address Questions and Concerns
|
||||||
|
|
||||||
Ask for specific feedback:
|
Ask for specific feedback:
|
||||||
|
|
||||||
|
|
@ -149,20 +166,9 @@ Before proceeding to build, get explicit confirmation:
|
||||||
"Based on this plan, I will generate:
|
"Based on this plan, I will generate:
|
||||||
|
|
||||||
- [List of files]
|
- [List of files]
|
||||||
in [target location]
|
in [target location]"
|
||||||
|
|
||||||
Do you approve this plan and want me to proceed with building the workflow? [Y/N]"
|
Ready to proceed when you are! Select your option below to build or modify the plan.
|
||||||
|
|
||||||
### If Approved
|
|
||||||
|
|
||||||
- Update {workflowPlanFile} frontmatter: `stepsCompleted: [1, 2, 3, 4]`, `lastStep: "review"`
|
|
||||||
- Proceed to step 5 (Build)
|
|
||||||
|
|
||||||
### If Not Approved
|
|
||||||
|
|
||||||
- Note specific concerns
|
|
||||||
- Either revise the plan here or return to appropriate earlier step
|
|
||||||
- Continue until user is satisfied
|
|
||||||
|
|
||||||
### 6. Present MENU OPTIONS
|
### 6. Present MENU OPTIONS
|
||||||
|
|
||||||
|
|
@ -1,13 +1,13 @@
|
||||||
---
|
---
|
||||||
name: 'step-06-build'
|
name: 'step-11-build'
|
||||||
description: 'Generate all workflow files based on the approved plan'
|
description: 'Generate all workflow files based on the approved plan'
|
||||||
|
|
||||||
# Path Definitions
|
# Path Definitions
|
||||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||||
|
|
||||||
# File References
|
# File References
|
||||||
thisStepFile: '{workflow_path}/steps/step-06-build.md'
|
thisStepFile: '{workflow_path}/steps/step-11-build.md'
|
||||||
nextStepFile: '{workflow_path}/steps/step-07-review.md'
|
nextStepFile: '{workflow_path}/steps/step-12-review.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
workflowFile: '{workflow_path}/workflow.md'
|
||||||
# Output files for workflow creation process
|
# Output files for workflow creation process
|
||||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||||
|
|
@ -18,8 +18,8 @@ advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elici
|
||||||
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
|
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
|
||||||
|
|
||||||
# Template References
|
# Template References
|
||||||
workflowYamlTemplate: '{workflow_path}/templates/workflow-yaml.md'
|
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
|
||||||
stepFileTemplate: '{workflow_path}/templates/step-file.md'
|
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
|
||||||
contentTemplate: '{workflow_path}/templates/content-template.md'
|
contentTemplate: '{workflow_path}/templates/content-template.md'
|
||||||
buildSummaryTemplate: '{workflow_path}/templates/build-summary.md'
|
buildSummaryTemplate: '{workflow_path}/templates/build-summary.md'
|
||||||
---
|
---
|
||||||
|
|
@ -63,19 +63,16 @@ To generate all the workflow files (workflow.md, step files, templates, and supp
|
||||||
|
|
||||||
## CONTEXT BOUNDARIES:
|
## CONTEXT BOUNDARIES:
|
||||||
|
|
||||||
- Approved plan from step 4 guides implementation
|
- Approved plan from step 10 guides implementation
|
||||||
- Generate files in target workflow location
|
- Generate files in target workflow location
|
||||||
- Load templates and documentation as needed during build
|
- Load templates and documentation as needed during build
|
||||||
- Follow step-file architecture principles
|
- Follow step-file architecture principles
|
||||||
|
|
||||||
## BUILD REFERENCE MATERIALS:
|
## BUILD REFERENCE MATERIALS:
|
||||||
|
|
||||||
When building, you will need to load:
|
- When building each step file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md`
|
||||||
|
- When building the main workflow.md file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md`
|
||||||
- Template files from `{workflow_path}/templates/`
|
- Example step files from {project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns
|
||||||
- Step file structure from `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md`
|
|
||||||
- Workflow configuration from `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md`
|
|
||||||
- Example step files from the Meal Prep workflow as patterns
|
|
||||||
|
|
||||||
## FILE GENERATION SEQUENCE:
|
## FILE GENERATION SEQUENCE:
|
||||||
|
|
||||||
|
|
@ -115,10 +112,11 @@ For other modules, check their install-config.yaml for custom_workflow_location
|
||||||
|
|
||||||
### 3. Generate workflow.md
|
### 3. Generate workflow.md
|
||||||
|
|
||||||
Load and customize {workflowYamlTemplate}:
|
Load and follow {workflowTemplate}:
|
||||||
|
|
||||||
|
- Create workflow.md using template structure
|
||||||
- Insert workflow name and description
|
- Insert workflow name and description
|
||||||
- Configure all path variables
|
- Configure all path variables ({project-root}, {bmad_folder}, {workflow_path})
|
||||||
- Set web_bundle flag to true unless user has indicated otherwise
|
- Set web_bundle flag to true unless user has indicated otherwise
|
||||||
- Define role and goal
|
- Define role and goal
|
||||||
- Include initialization path to step-01
|
- Include initialization path to step-01
|
||||||
|
|
@ -127,11 +125,12 @@ Load and customize {workflowYamlTemplate}:
|
||||||
|
|
||||||
For each step in the design:
|
For each step in the design:
|
||||||
|
|
||||||
- Load {stepFileTemplate}
|
- Load and follow {stepTemplate}
|
||||||
|
- Create step file using template structure
|
||||||
- Customize with step-specific content
|
- Customize with step-specific content
|
||||||
- Ensure proper frontmatter with path references
|
- Ensure proper frontmatter with path references
|
||||||
- Include appropriate menu handling
|
- Include appropriate menu handling and universal rules
|
||||||
- Follow all mandatory rules and protocols
|
- Follow all mandatory rules and protocols from template
|
||||||
|
|
||||||
### 5. Generate Templates (If Needed)
|
### 5. Generate Templates (If Needed)
|
||||||
|
|
||||||
|
|
@ -146,7 +145,7 @@ For document workflows:
|
||||||
|
|
||||||
Based on design requirements:
|
Based on design requirements:
|
||||||
|
|
||||||
- Create data files with example content
|
- Create data files (csv)
|
||||||
- Generate README.md with usage instructions
|
- Generate README.md with usage instructions
|
||||||
- Create any configuration files
|
- Create any configuration files
|
||||||
- Add validation checklists if designed
|
- Add validation checklists if designed
|
||||||
|
|
@ -224,22 +223,18 @@ Load and append the content from {buildSummaryTemplate}
|
||||||
|
|
||||||
### 9. Present MENU OPTIONS
|
### 9. Present MENU OPTIONS
|
||||||
|
|
||||||
Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
|
Display: **Build Complete - Select an Option:** [C] Continue to Review
|
||||||
|
|
||||||
#### EXECUTION RULES:
|
#### EXECUTION RULES:
|
||||||
|
|
||||||
- ALWAYS halt and wait for user input after presenting menu
|
- Build complete - all files generated
|
||||||
- ONLY proceed to next step when user selects 'C'
|
- Present simple completion status
|
||||||
- After other menu items execution, return to this menu
|
- User selects [C] to continue to review step
|
||||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
|
||||||
- Use menu handling logic section below
|
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF A: Execute {advancedElicitationTask}
|
- IF C: Save build summary to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
|
||||||
- IF P: Execute {partyModeWorkflow}
|
- IF Any other comments or queries: respond and redisplay menu
|
||||||
- IF C: Save content to {workflowPlanFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
|
|
||||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options)
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## CRITICAL STEP COMPLETION NOTE
|
||||||
|
|
||||||
|
|
@ -1,17 +1,16 @@
|
||||||
---
|
---
|
||||||
name: 'step-07-review'
|
name: 'step-12-review'
|
||||||
description: 'Review the generated workflow and provide final validation and next steps'
|
description: 'Review the generated workflow and provide final validation and next steps'
|
||||||
|
|
||||||
# Path Definitions
|
# Path Definitions
|
||||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||||
|
|
||||||
# File References
|
# File References
|
||||||
thisStepFile: '{workflow_path}/steps/step-07-review.md'
|
thisStepFile: '{workflow_path}/steps/step-12-review.md'
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
workflowFile: '{workflow_path}/workflow.md'
|
||||||
# Output files for workflow creation process
|
# Output files for workflow creation process
|
||||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||||
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
|
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
|
||||||
nextStepFile: '{workflow_path}/steps/step-08-compliance-check.md'
|
|
||||||
|
|
||||||
# Task References
|
# Task References
|
||||||
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
|
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
|
||||||
|
|
@ -204,26 +203,50 @@ Then load and append the content from {completionTemplate}
|
||||||
|
|
||||||
## FINAL MENU OPTIONS
|
## FINAL MENU OPTIONS
|
||||||
|
|
||||||
Display: **Workflow Review Complete!** [A] Advanced Elicitation [P] Party Mode [C] Continue to Compliance Check
|
Display: **All Files Created Successfully!** [C] Complete & Get Validation Instructions
|
||||||
|
|
||||||
#### EXECUTION RULES:
|
#### EXECUTION RULES:
|
||||||
|
|
||||||
- ALWAYS halt and wait for user input after presenting menu
|
- ALWAYS halt and wait for user input after presenting menu
|
||||||
- Compliance check is required before workflow completion
|
- Provide compliance check guidance for new context execution
|
||||||
- After other menu items execution, return to this menu
|
- After other menu items execution, return to this menu
|
||||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||||
- Use menu handling logic section below
|
- Use menu handling logic section below
|
||||||
|
|
||||||
#### Menu Handling Logic:
|
#### Menu Handling Logic:
|
||||||
|
|
||||||
- IF A: Execute {advancedElicitationTask}
|
- IF C: Save content to {workflowPlanFile}, update frontmatter, then provide validation instructions for running in new context
|
||||||
- IF P: Execute {partyModeWorkflow}
|
- IF Any other comments or queries: respond and redisplay menu
|
||||||
- IF C: Save content to {workflowPlanFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
|
|
||||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#final-menu-options)
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
## COMPLIANCE CHECK INSTRUCTIONS
|
||||||
|
|
||||||
ONLY WHEN C is selected and content is saved to {workflowPlanFile} with frontmatter updated, will you then load and read fully {nextStepFile} to execute and begin compliance validation phase.
|
When user selects [C], provide these instructions:
|
||||||
|
|
||||||
|
**🎯 Workflow Creation Complete! Your new workflow is ready at:**
|
||||||
|
`{target_workflow_path}`
|
||||||
|
|
||||||
|
**⚠️ IMPORTANT - Run Compliance Check in New Context:**
|
||||||
|
To validate your workflow meets BMAD standards:
|
||||||
|
|
||||||
|
1. **Start a new Claude conversation** (fresh context)
|
||||||
|
2. **Use this command:** `/bmad:bmm:workflows:workflow-compliance-check`
|
||||||
|
3. **Provide the path:** `{target_workflow_path}/workflow.md`
|
||||||
|
4. **Follow the validation process** to identify and fix any violations
|
||||||
|
|
||||||
|
**Why New Context?**
|
||||||
|
|
||||||
|
- Compliance checking requires fresh analysis without workflow creation context
|
||||||
|
- Ensures objective validation against template standards
|
||||||
|
- Provides detailed violation reporting with specific fix recommendations
|
||||||
|
|
||||||
|
**Your workflow will be checked for:**
|
||||||
|
|
||||||
|
- Template compliance and structure
|
||||||
|
- Step-by-step validation standards
|
||||||
|
- File optimization and formatting
|
||||||
|
- Meta-workflow best practices
|
||||||
|
|
||||||
|
Ready to validate when you are! [Start new context and run compliance check]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -1,268 +0,0 @@
|
||||||
---
|
|
||||||
name: 'step-08-compliance-check'
|
|
||||||
description: 'Run comprehensive compliance validation on the created workflow'
|
|
||||||
|
|
||||||
# Path Definitions
|
|
||||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
|
||||||
|
|
||||||
# File References
|
|
||||||
thisStepFile: '{workflow_path}/steps/step-08-compliance-check.md'
|
|
||||||
workflowFile: '{workflow_path}/workflow.md'
|
|
||||||
generatedWorkflowPath: '{target_workflow_path}'
|
|
||||||
complianceCheckWorkflow: '{project-root}/{bmad_folder}/bmb/workflows/workflow-compliance-check/workflow.md'
|
|
||||||
|
|
||||||
# Task References
|
|
||||||
complianceCheckTask: '{project-root}/{bmad_folder}/bmb/workflows/workflow-compliance-check/workflow.md'
|
|
||||||
---
|
|
||||||
|
|
||||||
# Step 8: Compliance Validation
|
|
||||||
|
|
||||||
## STEP GOAL:
|
|
||||||
|
|
||||||
Run comprehensive compliance validation on the newly created workflow using the workflow-compliance-check workflow to ensure it meets all BMAD standards before completion.
|
|
||||||
|
|
||||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
||||||
|
|
||||||
### Universal Rules:
|
|
||||||
|
|
||||||
- 🛑 NEVER generate content without user input
|
|
||||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
|
||||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
|
||||||
|
|
||||||
### Role Reinforcement:
|
|
||||||
|
|
||||||
- ✅ You are a workflow architect and quality assurance specialist
|
|
||||||
- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role
|
|
||||||
- ✅ We engage in collaborative dialogue, not command-response
|
|
||||||
- ✅ You bring expertise in BMAD standards and workflow validation
|
|
||||||
- ✅ User brings their newly created workflow and needs quality assurance
|
|
||||||
|
|
||||||
### Step-Specific Rules:
|
|
||||||
|
|
||||||
- 🎯 Focus only on running compliance validation on the created workflow
|
|
||||||
- 🚫 FORBIDDEN to skip compliance validation or declare workflow complete without it
|
|
||||||
- 💬 Approach: Quality-focused, thorough, and collaborative
|
|
||||||
- 📋 Ensure user understands compliance results and next steps
|
|
||||||
|
|
||||||
## EXECUTION PROTOCOLS:
|
|
||||||
|
|
||||||
- 🎯 Launch workflow-compliance-check on the generated workflow
|
|
||||||
- 💾 Review compliance report and present findings to user
|
|
||||||
- 📖 Explain any issues found and provide fix recommendations
|
|
||||||
- 🚫 FORBIDDEN to proceed without compliance validation completion
|
|
||||||
|
|
||||||
## CONTEXT BOUNDARIES:
|
|
||||||
|
|
||||||
- Available context: Newly created workflow files from previous build step
|
|
||||||
- Focus: Compliance validation using workflow-compliance-check workflow
|
|
||||||
- Limits: Validation and reporting only, no further workflow modifications
|
|
||||||
- Dependencies: Successful workflow creation in previous step
|
|
||||||
|
|
||||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
|
||||||
|
|
||||||
### 1. Initialize Compliance Validation
|
|
||||||
|
|
||||||
"**Final Step: Workflow Compliance Validation**
|
|
||||||
|
|
||||||
Your workflow has been created! Now let's run a comprehensive compliance check to ensure it meets all BMAD standards and follows best practices.
|
|
||||||
|
|
||||||
This validation will check:
|
|
||||||
|
|
||||||
- Template compliance (workflow-template.md and step-template.md)
|
|
||||||
- File size optimization and markdown formatting
|
|
||||||
- CSV data file standards (if applicable)
|
|
||||||
- Intent vs Prescriptive spectrum alignment
|
|
||||||
- Web search and subprocess optimization
|
|
||||||
- Overall workflow flow and goal alignment"
|
|
||||||
|
|
||||||
### 2. Launch Compliance Check Workflow
|
|
||||||
|
|
||||||
**A. Execute Compliance Validation:**
|
|
||||||
|
|
||||||
"Running comprehensive compliance validation on your workflow...
|
|
||||||
Target: `{generated_workflow_path}`
|
|
||||||
|
|
||||||
**Executing:** {complianceCheckTask}
|
|
||||||
**Validation Scope:** Full 8-phase compliance analysis
|
|
||||||
**Expected Duration:** Thorough validation may take several minutes"
|
|
||||||
|
|
||||||
**B. Monitor Validation Progress:**
|
|
||||||
|
|
||||||
Provide updates as the validation progresses:
|
|
||||||
|
|
||||||
- "✅ Workflow.md validation in progress..."
|
|
||||||
- "✅ Step-by-step compliance checking..."
|
|
||||||
- "✅ File size and formatting analysis..."
|
|
||||||
- "✅ Intent spectrum assessment..."
|
|
||||||
- "✅ Web search optimization analysis..."
|
|
||||||
- "✅ Holistic workflow analysis..."
|
|
||||||
- "✅ Generating comprehensive compliance report..."
|
|
||||||
|
|
||||||
### 3. Compliance Report Analysis
|
|
||||||
|
|
||||||
**A. Review Validation Results:**
|
|
||||||
|
|
||||||
"**Compliance Validation Complete!**
|
|
||||||
|
|
||||||
**Overall Assessment:** [PASS/PARTIAL/FAIL - based on compliance report]
|
|
||||||
|
|
||||||
- **Critical Issues:** [number found]
|
|
||||||
- **Major Issues:** [number found]
|
|
||||||
- **Minor Issues:** [number found]
|
|
||||||
- **Compliance Score:** [percentage]%"
|
|
||||||
|
|
||||||
**B. Present Key Findings:**
|
|
||||||
|
|
||||||
"**Key Compliance Results:**
|
|
||||||
|
|
||||||
- **Template Adherence:** [summary of template compliance]
|
|
||||||
- **File Optimization:** [file size and formatting issues]
|
|
||||||
- **Intent Spectrum:** [spectrum positioning validation]
|
|
||||||
- **Performance Optimization:** [web search and subprocess findings]
|
|
||||||
- **Overall Flow:** [workflow structure and completion validation]"
|
|
||||||
|
|
||||||
### 4. Issue Resolution Options
|
|
||||||
|
|
||||||
**A. Review Compliance Issues:**
|
|
||||||
|
|
||||||
If issues are found:
|
|
||||||
"**Issues Requiring Attention:**
|
|
||||||
|
|
||||||
**Critical Issues (Must Fix):**
|
|
||||||
[List any critical violations that prevent workflow functionality]
|
|
||||||
|
|
||||||
**Major Issues (Should Fix):**
|
|
||||||
[List major issues that impact quality or maintainability]
|
|
||||||
|
|
||||||
**Minor Issues (Nice to Fix):**
|
|
||||||
[List minor standards compliance issues]"
|
|
||||||
|
|
||||||
**B. Resolution Options:**
|
|
||||||
|
|
||||||
"**Resolution Options:**
|
|
||||||
|
|
||||||
1. **Automatic Fixes** - I can apply automated fixes where possible
|
|
||||||
2. **Manual Guidance** - I'll guide you through manual fixes step by step
|
|
||||||
3. **Edit Workflow Launch** - Launch edit-agent with this compliance report
|
|
||||||
4. **Accept as Is** - Proceed with current state (if no critical issues)
|
|
||||||
5. **Detailed Review** - Review full compliance report in detail"
|
|
||||||
|
|
||||||
### 5. Final Validation Confirmation
|
|
||||||
|
|
||||||
**A. User Choice Handling:**
|
|
||||||
|
|
||||||
Based on user selection:
|
|
||||||
|
|
||||||
- **If Automatic Fixes**: Apply fixes and re-run validation
|
|
||||||
- **If Manual Guidance**: Provide step-by-step fix instructions
|
|
||||||
- **If Edit Workflow**: Launch edit-agent with compliance report context
|
|
||||||
- **If Accept as Is**: Confirm understanding of any remaining issues
|
|
||||||
- **If Detailed Review**: Present full compliance report
|
|
||||||
|
|
||||||
**B. Final Status Confirmation:**
|
|
||||||
|
|
||||||
"**Workflow Compliance Status:** [FINAL/PROVISIONAL]
|
|
||||||
|
|
||||||
**Completion Criteria:**
|
|
||||||
|
|
||||||
- ✅ All critical issues resolved
|
|
||||||
- ✅ Major issues addressed or accepted
|
|
||||||
- ✅ Compliance documentation complete
|
|
||||||
- ✅ User understands any remaining minor issues
|
|
||||||
|
|
||||||
**Your workflow is ready for production use!**"
|
|
||||||
|
|
||||||
### 6. Completion Documentation
|
|
||||||
|
|
||||||
**A. Update Workflow Completion:**
|
|
||||||
|
|
||||||
Document final compliance status:
|
|
||||||
|
|
||||||
- **Validation Date:** [current date]
|
|
||||||
- **Compliance Score:** [final percentage]
|
|
||||||
- **Issues Resolved:** [summary of fixes applied]
|
|
||||||
- **Remaining Issues:** [any accepted minor issues]
|
|
||||||
|
|
||||||
**B. Final User Guidance:**
|
|
||||||
|
|
||||||
"**Next Steps for Your Workflow:**
|
|
||||||
|
|
||||||
1. **Test the workflow** with real users to validate functionality
|
|
||||||
2. **Monitor performance** and consider optimization opportunities
|
|
||||||
3. **Gather feedback** for potential future improvements
|
|
||||||
4. **Consider compliance check** periodically for maintenance
|
|
||||||
|
|
||||||
**Support Resources:**
|
|
||||||
|
|
||||||
- Use workflow-compliance-check for future validations
|
|
||||||
- Refer to BMAD documentation for best practices
|
|
||||||
- Consider edit-agent for future modifications"
|
|
||||||
|
|
||||||
### 7. Workflow Completion
|
|
||||||
|
|
||||||
**A. Final Celebration:**
|
|
||||||
|
|
||||||
"🎉 **Congratulations! Your BMAD workflow is complete and compliant!**
|
|
||||||
|
|
||||||
**Workflow Summary:**
|
|
||||||
|
|
||||||
- **Name:** {new_workflow_name}
|
|
||||||
- **Location:** {target_workflow_path}
|
|
||||||
- **Compliance Status:** Fully validated
|
|
||||||
- **Ready for:** Production use
|
|
||||||
|
|
||||||
**You've successfully created a professional BMAD workflow that:**
|
|
||||||
|
|
||||||
- ✅ Follows all BMAD standards and templates
|
|
||||||
- ✅ Optimizes file sizes and performance
|
|
||||||
- ✅ Implements appropriate Intent vs Prescriptive positioning
|
|
||||||
- ✅ Includes efficient tool integrations
|
|
||||||
- ✅ Provides excellent user experience
|
|
||||||
|
|
||||||
**Great work!**"
|
|
||||||
|
|
||||||
**B. Completion Options:**
|
|
||||||
|
|
||||||
"**Workflow Creation Complete!**
|
|
||||||
|
|
||||||
**Select an Option:**
|
|
||||||
|
|
||||||
- [C] Complete - Finish workflow creation
|
|
||||||
- [T] Test Workflow - Try a test run (if workflow supports testing)
|
|
||||||
- [D] Documentation - View full compliance report
|
|
||||||
- [M] More Modifications - Make additional changes"
|
|
||||||
|
|
||||||
## Menu Handling Logic:
|
|
||||||
|
|
||||||
- IF C: End workflow creation successfully with completion summary
|
|
||||||
- IF T: If workflow supports testing, suggest test execution method
|
|
||||||
- IF D: Present detailed compliance report findings
|
|
||||||
- IF M: Return to edit-agent for additional modifications
|
|
||||||
- IF Any other comments or queries: respond and redisplay completion options
|
|
||||||
|
|
||||||
## CRITICAL STEP COMPLETION NOTE
|
|
||||||
|
|
||||||
ONLY WHEN compliance validation is complete and user confirms final workflow status, will the workflow creation process be considered successfully finished.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
|
||||||
|
|
||||||
### ✅ SUCCESS:
|
|
||||||
|
|
||||||
- Comprehensive compliance validation executed on created workflow
|
|
||||||
- All compliance issues identified and documented with severity rankings
|
|
||||||
- User provided with clear understanding of validation results
|
|
||||||
- Appropriate resolution options offered and implemented
|
|
||||||
- Final workflow meets BMAD standards and is ready for production
|
|
||||||
- User satisfaction with workflow quality and compliance
|
|
||||||
|
|
||||||
### ❌ SYSTEM FAILURE:
|
|
||||||
|
|
||||||
- Skipping compliance validation before workflow completion
|
|
||||||
- Not addressing critical compliance issues found during validation
|
|
||||||
- Failing to provide clear guidance on issue resolution
|
|
||||||
- Declaring workflow complete without ensuring standards compliance
|
|
||||||
- Not documenting final compliance status for future reference
|
|
||||||
|
|
||||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
|
||||||
|
|
@ -132,15 +132,16 @@ For each deviation:
|
||||||
|
|
||||||
"**Initialization Validation:**"
|
"**Initialization Validation:**"
|
||||||
|
|
||||||
- Configuration Loading uses correct path format: `{project-root}/{bmad_folder}/[module]/config.yaml`
|
- Configuration Loading uses correct path format: `{project-root}/{bmad_folder}/[module]/config.yaml` (variable substitution pattern)
|
||||||
- First step follows pattern: `step-01-init.md` OR documented deviation
|
- First step follows pattern: `step-01-init.md` OR documented deviation
|
||||||
- Required config variables properly listed
|
- Required config variables properly listed
|
||||||
|
- Variables use proper substitution pattern: {project-root}, {bmad_folder}, {workflow_path}, etc.
|
||||||
|
|
||||||
For violations:
|
For violations:
|
||||||
|
|
||||||
- **Template Reference:** "INITIALIZATION SEQUENCE" section in workflow-template.md
|
- **Template Reference:** "INITIALIZATION SEQUENCE" section in workflow-template.md
|
||||||
- **Severity:** Major (incorrect paths) or Minor (missing variables)
|
- **Severity:** Major (incorrect paths or missing variables) or Minor (format issues)
|
||||||
- **Specific Fix:** Correct path format and step reference
|
- **Specific Fix:** Use proper variable substitution patterns for flexible installation
|
||||||
|
|
||||||
### 6. Document Workflow.md Findings
|
### 6. Document Workflow.md Findings
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue