Ignore and untrack BMad directories
This commit is contained in:
Max
@@ -1,96 +0,0 @@
|
||||
---
|
||||
name: 'step-01-load-target'
|
||||
description: 'Load target for validation'
|
||||
|
||||
nextStepFile: './step-02-file-structure.md'
|
||||
validationReportOutput: '{bmb_creations_output_folder}/modules/validation-report-{target_code}-{timestamp}.md'
|
||||
---
|
||||
|
||||
# Step 1: Load Target (Validate Mode)
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Load the target (brief, module, agent specs, or workflow specs) for validation.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
- ✅ You are the **Quality Assurance** — thorough, systematic
|
||||
- ✅ Understand what we're validating
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Determine Validation Target
|
||||
|
||||
"**What would you like to validate?**"
|
||||
|
||||
Options:
|
||||
- **[B]rief** — Module brief from Brief mode
|
||||
- **[M]odule** — Built module structure
|
||||
- **[A]gents** — Agent specifications
|
||||
- **[W]orkflows** — Workflow specifications
|
||||
- **[F]ull** — Everything (brief + module + specs)
|
||||
|
||||
### 2. Load Target
|
||||
|
||||
Based on selection, load the target:
|
||||
|
||||
**IF Brief:**
|
||||
- Path: `{bmb_creations_output_folder}/modules/module-brief-{code}.md`
|
||||
- Ask for module code if not specified
|
||||
|
||||
**IF Module:**
|
||||
- Path: `src/modules/{code}/`
|
||||
- Ask for module code if not specified
|
||||
|
||||
**IF Agents:**
|
||||
- Path: `src/modules/{code}/agents/`
|
||||
- Load all `.spec.md` or `.agent.yaml` files
|
||||
|
||||
**IF Workflows:**
|
||||
- Path: `src/modules/{code}/workflows/`
|
||||
- Load all `.spec.md` files
|
||||
|
||||
**IF Full:**
|
||||
- Load everything above for a module
|
||||
|
||||
### 3. Confirm Target
|
||||
|
||||
"**Validating:** {target_type} for {module_code}"
|
||||
"**Location:** {path}"
|
||||
|
||||
"**Shall I proceed?**"
|
||||
|
||||
### 4. Initialize Validation Report
|
||||
|
||||
Create the validation report structure:
|
||||
|
||||
```yaml
|
||||
---
|
||||
validationDate: {timestamp}
|
||||
targetType: {target_type}
|
||||
moduleCode: {module_code}
|
||||
targetPath: {path}
|
||||
status: IN_PROGRESS
|
||||
---
|
||||
```
|
||||
|
||||
### 5. Proceed to Validation
|
||||
|
||||
"**Starting validation checks...**"
|
||||
|
||||
Load `{nextStepFile}` to begin file structure validation.
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ Target loaded
|
||||
✅ Validation report initialized
|
||||
✅ User confirmed
|
||||
@@ -1,94 +0,0 @@
|
||||
---
|
||||
name: 'step-02-file-structure'
|
||||
description: 'Validate file structure compliance'
|
||||
|
||||
nextStepFile: './step-03-module-yaml.md'
|
||||
moduleStandardsFile: '../../data/module-standards.md'
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
---
|
||||
|
||||
# Step 2: File Structure Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Validate file structure against module standards.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
- ✅ You are the **Quality Assurance** — checking structure
|
||||
- ✅ Reference standards, ensure compliance
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Load Standards
|
||||
|
||||
Load `{moduleStandardsFile}` for reference.
|
||||
|
||||
### 2. Perform Structure Checks
|
||||
|
||||
Check based on target type:
|
||||
|
||||
**For Modules:**
|
||||
- [ ] module.yaml exists
|
||||
- [ ] README.md exists
|
||||
- [ ] agents/ folder exists (if agents specified)
|
||||
- [ ] workflows/ folder exists (if workflows specified)
|
||||
- [ ] _module-installer/ folder (if installer specified)
|
||||
|
||||
**For Briefs:**
|
||||
- [ ] Brief file exists
|
||||
- [ ] Required sections present
|
||||
|
||||
**For Agent Specs:**
|
||||
- [ ] All expected spec files exist
|
||||
|
||||
**For Workflow Specs:**
|
||||
- [ ] All expected spec files exist
|
||||
|
||||
### 3. Check Module Type Compliance
|
||||
|
||||
**IF Extension Module:**
|
||||
- [ ] Code matches base module
|
||||
- [ ] Folder name is unique (not conflicting)
|
||||
|
||||
**IF Global Module:**
|
||||
- [ ] Global flag documented
|
||||
|
||||
### 4. Record Results
|
||||
|
||||
Append to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
## File Structure Validation
|
||||
|
||||
**Status:** {PASS/FAIL/WARNINGS}
|
||||
|
||||
**Checks:**
|
||||
{list each check with result}
|
||||
|
||||
**Issues Found:**
|
||||
{any structural problems}
|
||||
```
|
||||
|
||||
### 5. Auto-Proceed
|
||||
|
||||
"**✓ File structure check complete.**"
|
||||
|
||||
Proceeding to next validation...
|
||||
|
||||
Load `{nextStepFile}`
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ All structure checks performed
|
||||
✅ Results recorded
|
||||
✅ Auto-proceeds to next validation
|
||||
@@ -1,99 +0,0 @@
|
||||
---
|
||||
name: 'step-03-module-yaml'
|
||||
description: 'Validate module.yaml against conventions'
|
||||
|
||||
nextStepFile: './step-04-agent-specs.md'
|
||||
moduleYamlConventionsFile: '../../data/module-yaml-conventions.md'
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
targetPath: '{validation_target_path}'
|
||||
---
|
||||
|
||||
# Step 3: module.yaml Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Validate module.yaml formatting and conventions.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
- ✅ You are the **Quality Assurance** — checking configuration
|
||||
- ✅ Ensure proper YAML syntax
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Load module.yaml
|
||||
|
||||
Read `{targetPath}/module.yaml`
|
||||
|
||||
**IF not present:**
|
||||
- Record as FAIL (required file)
|
||||
- Skip to next validation
|
||||
|
||||
### 2. Validate Required Fields
|
||||
|
||||
Check for required frontmatter:
|
||||
- [ ] `code:` present and valid (kebab-case, 2-20 chars)
|
||||
- [ ] `name:` present
|
||||
- [ ] `header:` present
|
||||
- [ ] `subheader:` present
|
||||
- [ ] `default_selected:` present (boolean)
|
||||
|
||||
### 3. Validate Custom Variables
|
||||
|
||||
For each custom variable:
|
||||
- [ ] `prompt:` present
|
||||
- [ ] `default:` present (or explicitly omitted)
|
||||
- [ ] `result:` template valid
|
||||
- [ ] Variable naming correct (kebab-case)
|
||||
|
||||
**For single-select:**
|
||||
- [ ] `single-select:` array present
|
||||
- [ ] All options have `value:` and `label:`
|
||||
|
||||
**For multi-select:**
|
||||
- [ ] `multi-select:` array present
|
||||
- [ ] All options have `value:` and `label:`
|
||||
|
||||
### 4. Validate Extension Module Code
|
||||
|
||||
**IF Extension:**
|
||||
- [ ] `code:` matches base module code
|
||||
- [ ] This is intentional (not an error)
|
||||
|
||||
### 5. Record Results
|
||||
|
||||
Append to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
## module.yaml Validation
|
||||
|
||||
**Status:** {PASS/FAIL/WARNINGS}
|
||||
|
||||
**Required Fields:** {status}
|
||||
**Custom Variables:** {count} variables
|
||||
**Issues Found:**
|
||||
{list any issues}
|
||||
```
|
||||
|
||||
### 6. Auto-Proceed
|
||||
|
||||
"**✓ module.yaml check complete.**"
|
||||
|
||||
Proceeding to next validation...
|
||||
|
||||
Load `{nextStepFile}`
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ All module.yaml checks performed
|
||||
✅ Results recorded
|
||||
✅ Auto-proceeds to next validation
|
||||
@@ -1,152 +0,0 @@
|
||||
---
|
||||
name: 'step-04-agent-specs'
|
||||
description: 'Validate agent specifications and built agents'
|
||||
|
||||
nextStepFile: './step-05-workflow-specs.md'
|
||||
agentSpecTemplate: '../../templates/agent-spec-template.md'
|
||||
agentArchitectureFile: '../../data/agent-architecture.md'
|
||||
agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md'
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
targetPath: '{validation_target_path}'
|
||||
---
|
||||
|
||||
# Step 4: Agent Specs Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Validate agent specifications and/or built agents, distinguishing between placeholder specs and fully implemented agents.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
- ✅ You are the **Quality Assurance** — dual-mode checking
|
||||
- ✅ Specs are expected, built agents are great
|
||||
- ✅ Track status of each agent
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Load Agent Files
|
||||
|
||||
Find all agent files in `{targetPath}/agents/`:
|
||||
- `.spec.md` files (placeholder specs)
|
||||
- `.agent.yaml` files (built agents)
|
||||
|
||||
### 2. Categorize Agents
|
||||
|
||||
For each agent found, determine status:
|
||||
|
||||
**Built Agents (.agent.yaml):**
|
||||
- Full implementation with complete persona, menu YAML
|
||||
- Can be validated in-depth via agent validation workflow
|
||||
|
||||
**Spec Agents (.spec.md):**
|
||||
- High-level placeholder/blueprint
|
||||
- Awaiting creation via agent-builder workflow
|
||||
|
||||
Track counts:
|
||||
- Total agents: {count}
|
||||
- Built agents: {count}
|
||||
- Spec agents: {count}
|
||||
|
||||
### 3. Validate Spec Agents (.spec.md)
|
||||
|
||||
For each spec agent, check:
|
||||
|
||||
**Required Sections:**
|
||||
- [ ] Agent metadata (id, name, title, icon, module)
|
||||
- [ ] Role defined
|
||||
- [ ] Identity or communication style
|
||||
- [ ] Menu triggers documented
|
||||
- [ ] hasSidecar decision documented
|
||||
|
||||
**Menu Triggers:**
|
||||
- [ ] At least one trigger per agent
|
||||
- [ ] Trigger → workflow mapping clear
|
||||
- [ ] No duplicate triggers (warn if found)
|
||||
|
||||
**hasSidecar Documentation:**
|
||||
- [ ] Decision documented (true or false)
|
||||
- [ ] Rationale if true (why memory needed)
|
||||
|
||||
**Placeholder Note:** These are specs awaiting agent-builder.
|
||||
|
||||
### 4. Validate Built Agents (.agent.yaml)
|
||||
|
||||
For each built agent, check:
|
||||
|
||||
**Frontmatter Completeness:**
|
||||
- [ ] agent.metadata exists
|
||||
- [ ] agent.persona exists
|
||||
- [ ] agent.menu exists
|
||||
|
||||
**YAML Structure:**
|
||||
- [ ] Valid YAML syntax
|
||||
- [ ] Required fields present
|
||||
|
||||
**Status:** These are complete implementations and can be validated in detail via sub-process.
|
||||
|
||||
### 5. Record Results
|
||||
|
||||
Append to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
## Agent Specs Validation
|
||||
|
||||
**Status:** {PASS/FAIL/WARNINGS}
|
||||
|
||||
**Agent Summary:**
|
||||
- Total Agents: {count}
|
||||
- Built Agents: {count} {list}
|
||||
- Spec Agents: {count} {list}
|
||||
|
||||
**Built Agents:**
|
||||
{for each built agent}
|
||||
- **{name}**: {status} - Ready for detailed validation via agent workflow
|
||||
|
||||
**Spec Agents:**
|
||||
{for each spec agent}
|
||||
- **{name}**: {status} - Placeholder awaiting agent-builder
|
||||
|
||||
**Issues Found:**
|
||||
{list any issues}
|
||||
|
||||
**Recommendations:**
|
||||
{if specs exist}
|
||||
- Use `bmad:bmb:agents:agent-builder` to create {spec agent names}
|
||||
- After building agents, re-run validation to verify compliance
|
||||
{endif}
|
||||
```
|
||||
|
||||
### 6. Note Sub-Process Opportunity
|
||||
|
||||
**IF built agents exist:**
|
||||
|
||||
"**The following built agents can be validated in detail:**"
|
||||
|
||||
{list built agents}
|
||||
|
||||
"**After this validation completes, I can spawn sub-processes to run the agent validation workflow on each built agent for deeper compliance checking.**"
|
||||
|
||||
### 7. Auto-Proceed
|
||||
|
||||
"**✓ Agent specs check complete.**"
|
||||
|
||||
Proceeding to next validation...
|
||||
|
||||
Load `{nextStepFile}`
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ All agent files checked
|
||||
✅ Status tracked (spec vs built)
|
||||
✅ hasSidecar decisions validated
|
||||
✅ Recommendations for specs documented
|
||||
✅ Sub-process opportunity noted
|
||||
@@ -1,152 +0,0 @@
|
||||
---
|
||||
name: 'step-05-workflow-specs'
|
||||
description: 'Validate workflow specifications and built workflows'
|
||||
|
||||
nextStepFile: './step-06-documentation.md'
|
||||
workflowSpecTemplate: '../../templates/workflow-spec-template.md'
|
||||
workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md'
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
targetPath: '{validation_target_path}'
|
||||
---
|
||||
|
||||
# Step 5: Workflow Specs Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Validate workflow specifications and/or built workflows, distinguishing between placeholder specs and fully implemented workflows.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are the **Quality Assurance** — dual-mode checking
|
||||
- ✅ Specs are expected, built workflows are great
|
||||
- ✅ Track status of each workflow
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Load Workflow Files
|
||||
|
||||
Find all workflow files in `{targetPath}/workflows/`:
|
||||
- `.spec.md` files (placeholder specs)
|
||||
- `workflow.md` files (built workflows)
|
||||
|
||||
### 2. Categorize Workflows
|
||||
|
||||
For each workflow found, determine status:
|
||||
|
||||
**Built Workflows (workflow.md with steps/ folder):**
|
||||
- Full implementation with step files, data, templates
|
||||
- Can be validated in-depth via workflow validation workflow
|
||||
|
||||
**Spec Workflows (.spec.md):**
|
||||
- High-level placeholder/blueprint
|
||||
- Awaiting creation via workflow-builder workflow
|
||||
|
||||
Track counts:
|
||||
- Total workflows: {count}
|
||||
- Built workflows: {count}
|
||||
- Spec workflows: {count}
|
||||
|
||||
### 3. Validate Spec Workflows (.spec.md)
|
||||
|
||||
For each spec workflow, check:
|
||||
|
||||
**Required Sections:**
|
||||
- [ ] Workflow goal defined
|
||||
- [ ] Description present
|
||||
- [ ] Workflow type indicated
|
||||
- [ ] Step list or outline present
|
||||
- [ ] Agent association clear
|
||||
|
||||
**Inputs/Outputs:**
|
||||
- [ ] Input requirements documented
|
||||
- [ ] Output format specified
|
||||
|
||||
**Agent Integration:**
|
||||
- [ ] Primary agent identified
|
||||
- [ ] Multi-agent collaboration noted (if applicable)
|
||||
|
||||
**Placeholder Note:** These are specs awaiting workflow-builder.
|
||||
|
||||
### 4. Validate Built Workflows (workflow.md)
|
||||
|
||||
For each built workflow, check:
|
||||
|
||||
**Workflow Structure:**
|
||||
- [ ] workflow.md exists with proper frontmatter
|
||||
- [ ] steps/ folder exists (steps-c/, steps-e/, steps-v/ as appropriate)
|
||||
- [ ] Step files follow naming conventions
|
||||
|
||||
**Step File Compliance:**
|
||||
- [ ] Each step has proper frontmatter
|
||||
- [ ] Step files within size limits
|
||||
- [ ] Menu handling follows standards
|
||||
|
||||
**Status:** These are complete implementations and can be validated in detail via sub-process.
|
||||
|
||||
### 5. Record Results
|
||||
|
||||
Append to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
## Workflow Specs Validation
|
||||
|
||||
**Status:** {PASS/FAIL/WARNINGS}
|
||||
|
||||
**Workflow Summary:**
|
||||
- Total Workflows: {count}
|
||||
- Built Workflows: {count} {list}
|
||||
- Spec Workflows: {count} {list}
|
||||
|
||||
**Built Workflows:**
|
||||
{for each built workflow}
|
||||
- **{name}**: {status} - Ready for detailed validation via workflow workflow
|
||||
|
||||
**Spec Workflows:**
|
||||
{for each spec workflow}
|
||||
- **{name}**: {status} - Placeholder awaiting workflow-builder
|
||||
|
||||
**Issues Found:**
|
||||
{list any issues}
|
||||
|
||||
**Recommendations:**
|
||||
{if specs exist}
|
||||
- Use `bmad:bmb:workflows:workflow` or `/workflow` to create {spec workflow names}
|
||||
- After building workflows, re-run validation to verify compliance
|
||||
{endif}
|
||||
```
|
||||
|
||||
### 6. Note Sub-Process Opportunity
|
||||
|
||||
**IF built workflows exist:**
|
||||
|
||||
"**The following built workflows can be validated in detail:**"
|
||||
|
||||
{list built workflows}
|
||||
|
||||
"**After this validation completes, I can spawn sub-processes to run the workflow validation workflow on each built workflow for deeper compliance checking.**"
|
||||
|
||||
### 7. Auto-Proceed
|
||||
|
||||
"**✓ Workflow specs check complete.**"
|
||||
|
||||
Proceeding to next validation...
|
||||
|
||||
Load `{nextStepFile}`
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ All workflow files checked
|
||||
✅ Status tracked (spec vs built)
|
||||
✅ Agent associations validated
|
||||
✅ Recommendations for specs documented
|
||||
✅ Sub-process opportunity noted
|
||||
@@ -1,143 +0,0 @@
|
||||
---
|
||||
name: 'step-06-documentation'
|
||||
description: 'Validate documentation (README.md, TODO.md, docs/)'
|
||||
|
||||
nextStepFile: './step-07-installation.md'
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
targetPath: '{validation_target_path}'
|
||||
moduleBriefPath: '{module_brief_path}'
|
||||
---
|
||||
|
||||
# Step 6: Documentation Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Validate module documentation completeness, including user-facing docs in docs/ folder.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are the **Quality Assurance** — checking docs
|
||||
- ✅ Documentation matters for usability
|
||||
- ✅ User docs can be generated from placeholder plans
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Load Documentation Files
|
||||
|
||||
Check for:
|
||||
- `{targetPath}/README.md` (module overview)
|
||||
- `{targetPath}/TODO.md` (development roadmap)
|
||||
- `{targetPath}/docs/` (user documentation folder)
|
||||
|
||||
### 2. Validate README.md
|
||||
|
||||
**Required Sections:**
|
||||
- [ ] Module name and description
|
||||
- [ ] Installation instructions
|
||||
- [ ] Components section (agents, workflows)
|
||||
- [ ] Usage examples or quick start
|
||||
- [ ] Module structure
|
||||
- [ ] Link to docs/ folder
|
||||
|
||||
**Quality Checks:**
|
||||
- [ ] Clear description of what module does
|
||||
- [ ] Installation command shown
|
||||
- [ ] Agent/workflow lists complete
|
||||
- [ ] References user documentation
|
||||
|
||||
### 3. Validate TODO.md
|
||||
|
||||
**Required Content:**
|
||||
- [ ] Agent build checklist
|
||||
- [ ] Workflow build checklist
|
||||
- [ ] Testing section
|
||||
- [ ] Next steps
|
||||
|
||||
### 4. Validate docs/ Folder
|
||||
|
||||
**For Custom Modules:**
|
||||
- [ ] docs/ folder exists
|
||||
- [ ] Contains user-facing documentation
|
||||
- [ ] Documentation is clear and helpful
|
||||
|
||||
**Valid docs/ Contents (may include):**
|
||||
- `getting-started.md` — Quick start guide
|
||||
- `agents.md` — Agent documentation
|
||||
- `workflows.md` — Workflow documentation
|
||||
- `examples.md` — Usage examples
|
||||
- `configuration.md` — Setup/configuration guide
|
||||
- `troubleshooting.md` — Common issues and solutions
|
||||
|
||||
**Quality Check:**
|
||||
- [ ] Even with placeholder agent/workflow specs, user docs should provide useful information
|
||||
- [ ] Documentation references agents/workflows by name
|
||||
- [ ] Clear what functionality exists vs what is planned
|
||||
|
||||
### 5. Generate User Docs Recommendation
|
||||
|
||||
**IF docs/ missing or incomplete:**
|
||||
|
||||
"**User documentation can be generated from module brief and agent/workflow specs.**"
|
||||
|
||||
"**Even with placeholder plans, you can create helpful user documentation that describes:**
|
||||
- What each agent does and when to use it
|
||||
- What workflows are available and their purpose
|
||||
- How to get started with the module
|
||||
- Configuration options (from module.yaml)"
|
||||
|
||||
### 6. Record Results
|
||||
|
||||
Append to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
## Documentation Validation
|
||||
|
||||
**Status:** {PASS/FAIL/WARNINGS}
|
||||
|
||||
**Root Documentation:**
|
||||
- **README.md:** {present/missing} - {status}
|
||||
- **TODO.md:** {present/missing} - {status}
|
||||
|
||||
**User Documentation (docs/):**
|
||||
- **docs/ folder:** {present/missing} - {status}
|
||||
- **Documentation files:** {count} files found
|
||||
|
||||
**Docs Contents:**
|
||||
{list files in docs/ folder}
|
||||
|
||||
**Issues Found:**
|
||||
{list any issues}
|
||||
|
||||
**Recommendations:**
|
||||
{if docs/ missing or incomplete}
|
||||
- Generate user documentation from module brief and specs
|
||||
- Create getting-started.md, agents.md, workflows.md
|
||||
- User docs are valuable even with placeholder plans
|
||||
{endif}
|
||||
```
|
||||
|
||||
### 7. Auto-Proceed
|
||||
|
||||
"**✓ Documentation check complete.**"
|
||||
|
||||
Proceeding to installation validation...
|
||||
|
||||
Load `{nextStepFile}`
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ All documentation checked
|
||||
✅ Required sections validated
|
||||
✅ docs/ folder presence verified
|
||||
✅ User documentation quality assessed
|
||||
✅ Recommendations documented
|
||||
@@ -1,113 +0,0 @@
|
||||
---
|
||||
name: 'step-07-installation'
|
||||
description: 'Installation readiness check'
|
||||
|
||||
nextStepFile: './step-08-report.md'
|
||||
moduleInstallerStandardsFile: '../../data/module-installer-standards.md'
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
targetPath: '{validation_target_path}'
|
||||
---
|
||||
|
||||
# Step 7: Installation Readiness
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Check if the module is ready for installation.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are the **Quality Assurance** — checking readiness
|
||||
- ✅ Installation should work
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Check Installer
|
||||
|
||||
**IF `_module-installer/` exists:**
|
||||
- [ ] `installer.js` present
|
||||
- [ ] Has valid `install()` function
|
||||
- [ ] Platform-specific handlers (if any IDEs supported)
|
||||
|
||||
**IF `_module-installer/` doesn't exist:**
|
||||
- Note: Module may not need installer
|
||||
- Check if this is intentional
|
||||
|
||||
### 2. Validate installer.js (if present)
|
||||
|
||||
Load `{moduleInstallerStandardsFile}` and check:
|
||||
|
||||
**Function Signature:**
|
||||
- [ ] `async function install(options)`
|
||||
- [ ] Accepts: projectRoot, config, installedIDEs, logger
|
||||
- [ ] Returns: Promise<boolean>
|
||||
|
||||
**Error Handling:**
|
||||
- [ ] Try/catch block present
|
||||
- [ ] Error logging present
|
||||
|
||||
**Platform Validation:**
|
||||
- [ ] Uses platformCodes for IDE validation
|
||||
- [ ] Graceful handling of unknown platforms
|
||||
|
||||
### 3. Check module.yaml Install Variables
|
||||
|
||||
**IF custom variables exist:**
|
||||
- [ ] All variables have prompts
|
||||
- [ ] Defaults are reasonable
|
||||
- [ ] Result templates are valid
|
||||
|
||||
**Path Variables:**
|
||||
- [ ] Paths use `{project-root}/` prefix
|
||||
- [ ] Output paths are user-configurable
|
||||
|
||||
### 4. Module Type Installation
|
||||
|
||||
**IF Extension:**
|
||||
- [ ] `code:` matches base (for proper merge)
|
||||
- [ ] Folder name is unique
|
||||
|
||||
**IF Global:**
|
||||
- [ ] `global: true` or documented
|
||||
- [ ] Global impact is minimal/intentional
|
||||
|
||||
### 5. Record Results
|
||||
|
||||
Append to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
## Installation Readiness
|
||||
|
||||
**Status:** {PASS/FAIL/WARNINGS}
|
||||
|
||||
**Installer:** {present/missing} - {status}
|
||||
**Install Variables:** {count} variables
|
||||
**Ready to Install:** {yes/no}
|
||||
|
||||
**Issues Found:**
|
||||
{list any issues}
|
||||
```
|
||||
|
||||
### 6. Auto-Proceed
|
||||
|
||||
"**✓ Installation readiness check complete.**"
|
||||
|
||||
Proceeding to final report...
|
||||
|
||||
Load `{nextStepFile}`
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ Installation readiness assessed
|
||||
✅ Installer validated (if present)
|
||||
✅ Module type compatibility checked
|
||||
✅ Results recorded
|
||||
@@ -1,197 +0,0 @@
|
||||
---
|
||||
name: 'step-08-report'
|
||||
description: 'Generate final validation report'
|
||||
|
||||
validationReportOutput: '{validation_report_output}'
|
||||
agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md'
|
||||
workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md'
|
||||
---
|
||||
|
||||
# Step 8: Validation Report
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Compile all validation results into a final report with actionable recommendations, including sub-process validation opportunities for built agents and workflows.
|
||||
|
||||
## MANDATORY EXECUTION RULES:
|
||||
|
||||
### Universal Rules:
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- ✅ Speak in `{communication_language}`
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are the **Quality Assurance** — reporting results
|
||||
- ✅ Clear, actionable feedback
|
||||
- ✅ Sub-process validation for built components
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY SEQUENCE
|
||||
|
||||
### 1. Compile Overall Status
|
||||
|
||||
Review all validation sections and determine overall status:
|
||||
|
||||
**PASS:** All checks passed, ready to proceed
|
||||
**WARNINGS:** Minor issues found, can proceed with fixes
|
||||
**FAIL:** Critical issues found, must fix before proceeding
|
||||
|
||||
### 2. Generate Summary
|
||||
|
||||
Add to `{validationReportOutput}`:
|
||||
|
||||
```markdown
|
||||
---
|
||||
|
||||
## Overall Summary
|
||||
|
||||
**Status:** {PASS/WARNINGS/FAIL}
|
||||
|
||||
**Breakdown:**
|
||||
- File Structure: {status}
|
||||
- module.yaml: {status}
|
||||
- Agent Specs: {status} ({built_count} built, {spec_count} specs)
|
||||
- Workflow Specs: {status} ({built_count} built, {spec_count} specs)
|
||||
- Documentation: {status}
|
||||
- Installation Readiness: {status}
|
||||
|
||||
---
|
||||
|
||||
## Component Status
|
||||
|
||||
### Agents
|
||||
- **Built Agents:** {count} — {list}
|
||||
- **Spec Agents:** {count} — {list}
|
||||
|
||||
### Workflows
|
||||
- **Built Workflows:** {count} — {list}
|
||||
- **Spec Workflows:** {count} — {list}
|
||||
|
||||
---
|
||||
|
||||
## Recommendations
|
||||
|
||||
{priority-listed-recommendations}
|
||||
|
||||
### Priority 1 - Critical (must fix)
|
||||
|
||||
{critical_issues}
|
||||
|
||||
### Priority 2 - High (should fix)
|
||||
|
||||
{high_priority_issues}
|
||||
|
||||
### Priority 3 - Medium (nice to have)
|
||||
|
||||
{medium_priority_issues}
|
||||
|
||||
---
|
||||
|
||||
## Sub-Process Validation
|
||||
|
||||
{if built_agents_exist}
|
||||
### Built Agent Deep Validation
|
||||
|
||||
The following built agents can be validated in detail using the agent validation workflow:
|
||||
|
||||
{for each built_agent}
|
||||
- **{agent_name}** — Use `{agentValidationWorkflow}`
|
||||
|
||||
**Recommendation:** Run agent validation workflow on each built agent to verify:
|
||||
- Frontmatter completeness
|
||||
- Persona quality
|
||||
- Menu structure compliance
|
||||
- Sidecar validation
|
||||
|
||||
**After fixing any module-level issues, I can spawn sub-processes to validate each built agent in parallel.**
|
||||
{endif}
|
||||
|
||||
{if built_workflows_exist}
|
||||
### Built Workflow Deep Validation
|
||||
|
||||
The following built workflows can be validated in detail using the workflow validation workflow:
|
||||
|
||||
{for each built_workflow}
|
||||
- **{workflow_name}** — Use `{workflowValidationWorkflow}`
|
||||
|
||||
**Recommendation:** Run workflow validation workflow on each built workflow to verify:
|
||||
- Step file compliance
|
||||
- Tri-modal structure (steps-c/steps-e/steps-v/)
|
||||
- Frontmatter completeness
|
||||
- Size limits compliance
|
||||
|
||||
**After fixing any module-level issues, I can spawn sub-processes to validate each built workflow in parallel.**
|
||||
{endif}
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
{based_on_status}
|
||||
|
||||
{if specs_exist}
|
||||
### Build Spec Components
|
||||
|
||||
**Spec Agents:** {spec_count}
|
||||
- Use `bmad:bmb:agents:agent-builder` to create: {spec_agent_names}
|
||||
|
||||
**Spec Workflows:** {spec_count}
|
||||
- Use `bmad:bmb:workflows:workflow` to create: {spec_workflow_names}
|
||||
|
||||
**After building specs, re-run validation to verify compliance.**
|
||||
{endif}
|
||||
|
||||
---
|
||||
|
||||
**Validation Completed:** {timestamp}
|
||||
```
|
||||
|
||||
### 3. Present Report
|
||||
|
||||
"**✓ Validation complete!**"
|
||||
|
||||
**Overall Status:** {overall_status}
|
||||
|
||||
**Report saved to:** `{validationReportOutput}`
|
||||
|
||||
{if built_components_exist}
|
||||
"**Built components found:**"
|
||||
- Built Agents: {count}
|
||||
- Built Workflows: {count}
|
||||
|
||||
"**These can be validated in depth via sub-process.**"
|
||||
{endif}
|
||||
|
||||
### 4. Offer Next Actions
|
||||
|
||||
"**What would you like to do?**"
|
||||
|
||||
- **[R]ead report** — Show the full validation report
|
||||
- **[S]ub-process validation** — Run deep validation on built agents/workflows
|
||||
- **[F]ix issues** — Edit mode to fix identified problems
|
||||
- **[D]one** — Complete validation
|
||||
|
||||
### 5. Menu Handling
|
||||
|
||||
- IF R: Display the full report
|
||||
- IF S:
|
||||
- {if built_components_exist}
|
||||
- Offer to run agent validation on built agents
|
||||
- Offer to run workflow validation on built workflows
|
||||
- Can run in parallel for efficiency
|
||||
- {else}
|
||||
- "No built components found for sub-process validation."
|
||||
- {endif}
|
||||
- IF F: Offer to load Edit mode
|
||||
- IF D: Complete validation session
|
||||
|
||||
---
|
||||
|
||||
## Success Metrics
|
||||
|
||||
✅ Overall status determined
|
||||
✅ Complete report generated
|
||||
✅ Actionable recommendations provided
|
||||
✅ Sub-process validation opportunities identified
|
||||
✅ Next steps offered
|
||||
Reference in New Issue
Block a user