create-byan-agent 2.1.1 → 2.2.2

package/install/templates/_byan/bmb/workflows/module/steps-c/step-07-docs.md

@@ -0,0 +1,402 @@
+---
+name: 'step-07-docs'
+description: 'Generate README.md, TODO.md, and docs/ folder'
+
+nextStepFile: './step-08-complete.md'
+buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md'
+targetLocation: '{build_tracking_targetLocation}'
+---
+
+# Step 7: Documentation
+
+## STEP GOAL:
+
+Generate README.md, TODO.md, and user documentation in docs/ folder for the module.
+
+## MANDATORY EXECUTION RULES:
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ Speak in `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are the **Module Builder** — documentation creator
+- ✅ README is the user's first impression
+- ✅ TODO tracks remaining work
+- ✅ docs/ provides user-facing documentation
+
+---
+
+## MANDATORY SEQUENCE
+
+### 1. Generate README.md
+
+Create `{targetLocation}/README.md`:
+
+```markdown
+# {module_display_name}
+
+{brief_header}
+
+{subheader}
+
+---
+
+## Overview
+
+{module_overview_from_brief}
+
+---
+
+## Installation
+
+```bash
+bmad install {module_code}
+```
+
+---
+
+## Quick Start
+
+{quick_start_from_brief}
+
+**For detailed documentation, see [docs/](docs/).**
+
+---
+
+## Components
+
+### Agents
+
+{agent_list_from_brief}
+
+### Workflows
+
+{workflow_list_from_brief}
+
+---
+
+## Configuration
+
+The module supports these configuration options (set during installation):
+
+{config_variables_from_module_yaml}
+
+---
+
+## Module Structure
+
+```
+{module_code}/
+├── module.yaml
+├── README.md
+├── TODO.md
+├── docs/
+│   ├── getting-started.md
+│   ├── agents.md
+│   ├── workflows.md
+│   └── examples.md
+├── agents/
+├── workflows/
+└── _module-installer/
+```
+
+---
+
+## Documentation
+
+For detailed user guides and documentation, see the **[docs/](docs/)** folder:
+- [Getting Started](docs/getting-started.md)
+- [Agents Reference](docs/agents.md)
+- [Workflows Reference](docs/workflows.md)
+- [Examples](docs/examples.md)
+
+---
+
+## Development Status
+
+This module is currently in development. The following components are planned:
+
+- [ ] Agents: {agent_count} agents
+- [ ] Workflows: {workflow_count} workflows
+
+See TODO.md for detailed status.
+
+---
+
+## Author
+
+Created via BMAD Module workflow
+
+---
+
+## License
+
+Part of the BMAD framework.
+```
+
+### 2. Generate TODO.md
+
+Create `{targetLocation}/TODO.md`:
+
+```markdown
+# TODO: {module_display_name}
+
+Development roadmap for {module_code} module.
+
+---
+
+## Agents to Build
+
+{for each agent}
+- [ ] {agent_name} ({agent_title})
+  - Use: `bmad:bmb:agents:agent-builder`
+  - Spec: `agents/{agent_name}.spec.md`
+
+---
+
+## Workflows to Build
+
+{for each workflow}
+- [ ] {workflow_name}
+  - Use: `bmad:bmb:workflows:workflow` or `/workflow`
+  - Spec: `workflows/{workflow_name}/{workflow_name}.spec.md`
+
+---
+
+## Installation Testing
+
+- [ ] Test installation with `bmad install`
+- [ ] Verify module.yaml prompts work correctly
+- [ ] Test installer.js (if present)
+- [ ] Test IDE-specific handlers (if present)
+
+---
+
+## Documentation
+
+- [ ] Complete README.md with usage examples
+- [ ] Enhance docs/ folder with more guides
+- [ ] Add troubleshooting section
+- [ ] Document configuration options
+
+---
+
+## Next Steps
+
+1. Build agents using create-agent workflow
+2. Build workflows using create-workflow workflow
+3. Test installation and functionality
+4. Iterate based on testing
+
+---
+
+_Last updated: {date}_
+```
+
+### 3. Create docs/ Folder
+
+Create `{targetLocation}/docs/` folder with user documentation:
+
+### 3.1. getting-started.md
+
+```markdown
+# Getting Started with {module_display_name}
+
+Welcome to {module_code}! This guide will help you get up and running.
+
+---
+
+## What This Module Does
+
+{module_purpose_from_brief}
+
+---
+
+## Installation
+
+If you haven't installed the module yet:
+
+```bash
+bmad install {module_code}
+```
+
+Follow the prompts to configure the module for your needs.
+
+---
+
+## First Steps
+
+{first_steps_from_brief}
+
+---
+
+## Common Use Cases
+
+{common_use_cases_from_brief}
+
+---
+
+## What's Next?
+
+- Check out the [Agents Reference](agents.md) to meet your team
+- Browse the [Workflows Reference](workflows.md) to see what you can do
+- See [Examples](examples.md) for real-world usage
+
+---
+
+## Need Help?
+
+If you run into issues:
+1. Check the troubleshooting section in examples.md
+2. Review your module configuration
+3. Consult the broader BMAD documentation
+```
+
+### 3.2. agents.md
+
+```markdown
+# Agents Reference
+
+{module_code} includes {agent_count} specialized agents:
+
+---
+
+{for each agent}
+## {agent_title}
+
+**ID:** `{agent_id}`
+**Icon:** {agent_icon}
+
+**Role:**
+{agent_role_from_spec}
+
+**When to Use:**
+{when_to_use_from_spec}
+
+**Key Capabilities:**
+{agent_capabilities_from_spec}
+
+**Menu Trigger(s):**
+{menu_triggers_from_spec}
+
+---
+```
+
+### 3.3. workflows.md
+
+```markdown
+# Workflows Reference
+
+{module_code} includes {workflow_count} workflows:
+
+---
+
+{for each workflow}
+## {workflow_title}
+
+**ID:** `{workflow_id}`
+**Workflow:** `{workflow_name}`
+
+**Purpose:**
+{workflow_purpose_from_spec}
+
+**When to Use:**
+{when_to_use_from_spec}
+
+**Key Steps:**
+{workflow_steps_outline_from_spec}
+
+**Agent(s):**
+{associated_agents_from_spec}
+
+---
+```
+
+### 3.4. examples.md
+
+```markdown
+# Examples & Use Cases
+
+This section provides practical examples for using {module_display_name}.
+
+---
+
+## Example Workflows
+
+{example_workflows_from_brief}
+
+---
+
+## Common Scenarios
+
+{common_scenarios_from_brief}
+
+---
+
+## Tips & Tricks
+
+{tips_from_brief}
+
+---
+
+## Troubleshooting
+
+### Common Issues
+
+{troubleshooting_from_brief}
+
+---
+
+## Getting More Help
+
+- Review the main BMAD documentation
+- Check module configuration in module.yaml
+- Verify all agents and workflows are properly installed
+```
+
+### 4. Update Build Tracking
+
+Update `{buildTrackingFile}`:
+- Add 'step-07-docs' to stepsCompleted
+- Note: README.md, TODO.md, and docs/ folder created
+
+### 5. Report Success
+
+"**✓ Documentation created:**"
+
+- README.md — module overview and navigation
+- TODO.md — development roadmap
+- docs/ — user documentation folder
+  - getting-started.md — quick start guide
+  - agents.md — agent reference
+  - workflows.md — workflow reference
+  - examples.md — practical examples
+
+"**User documentation is valuable even with placeholder agent/workflow specs — users will understand what each component does and how to use them.**"
+
+"**TODO.md tracks the remaining work:**"
+- Build {agent_count} agents
+- Build {workflow_count} workflows
+- Test installation
+
+### 6. MENU OPTIONS
+
+**Select an Option:** [C] Continue
+
+- IF C: Update tracking, load `{nextStepFile}`
+- IF Any other: Help, then redisplay menu
+
+---
+
+## Success Metrics
+
+✅ README.md created with all sections
+✅ TODO.md created with agent/workflow checklist
+✅ docs/ folder created with user documentation
+✅ Build tracking updated

package/install/templates/_byan/bmb/workflows/module/steps-c/step-08-complete.md

@@ -0,0 +1,123 @@
+---
+name: 'step-08-complete'
+description: 'Finalize, offer to run validation'
+
+buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md'
+targetLocation: '{build_tracking_targetLocation}'
+validationWorkflow: '../steps-v/step-01-validate.md'
+---
+
+# Step 8: Complete
+
+## STEP GOAL:
+
+Finalize the module build, update tracking, and offer to run 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 **Module Builder** — completing the build
+- ✅ Celebrate what was created
+- ✅ Guide next steps
+
+---
+
+## MANDATORY SEQUENCE
+
+### 1. Final Build Summary
+
+"**🎉 Module structure build complete!**"
+
+**Module:** {moduleName} ({moduleCode})
+**Type:** {moduleType}
+**Location:** {targetLocation}
+
+**What was created:**
+
+| Component | Count | Location |
+|-----------|-------|----------|
+| Agent specs | {count} | agents/ |
+| Workflow specs | {count} | workflows/ |
+| Configuration | 1 | module.yaml |
+| Documentation | 2 | README.md, TODO.md |
+| Installer | {yes/no} | _module-installer/ |
+
+### 2. Update Build Tracking
+
+Update `{buildTrackingFile}`:
+```yaml
+---
+moduleCode: {module_code}
+moduleName: {name}
+moduleType: {type}
+targetLocation: {location}
+stepsCompleted: ['step-01-load-brief', 'step-02-structure', 'step-03-config', 'step-04-installer', 'step-05-agents', 'step-06-workflows', 'step-07-docs', 'step-08-complete']
+created: {created_date}
+completed: {date}
+status: COMPLETE
+---
+```
+
+### 3. Next Steps
+
+"**Your module structure is ready! Here's what to do next:**"
+
+1. **Review the build** — Check {targetLocation}
+2. **Build agents** — Use `bmad:bmb:agents:agent-builder` for each agent spec
+3. **Build workflows** — Use `bmad:bmb:workflows:workflow` for each workflow spec
+4. **Test installation** — Run `bmad install {module_code}`
+5. **Iterate** — Refine based on testing
+
+### 4. Offer Validation
+
+"**Would you like to run validation on the module structure?**"
+
+Validation checks:
+- File structure compliance
+- module.yaml correctness
+- Spec completeness
+- Installation readiness
+
+### 5. MENU OPTIONS
+
+**Select an Option:** [V] Validate Module [D] Done
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+
+#### Menu Handling Logic:
+
+- IF V: Load `{validationWorkflow}` to run validation
+- IF D: Celebration message, workflow complete
+- IF Any other: Help user, then redisplay menu
+
+### 6. Completion Message (if Done selected)
+
+"**🚀 You've built a module structure for BMAD!**"
+
+"**Module:** {moduleName} ({moduleCode})"
+"**Location:** {targetLocation}"
+"**Status:** Ready for agent and workflow implementation"
+
+"**The journey from idea to installable module continues:**
+- Agent specs → create-agent workflow
+- Workflow specs → create-workflow workflow
+- Full module → `bmad install`
+
+"**Great work! Let's build something amazing.** ✨"
+
+---
+
+## Success Metrics
+
+✅ Build tracking marked COMPLETE
+✅ Summary presented to user
+✅ Next steps clearly explained
+✅ Validation offered (optional)

package/install/templates/_byan/bmb/workflows/module/steps-e/step-01-load-target.md

@@ -0,0 +1,81 @@
+---
+name: 'step-01-load-target'
+description: 'Load target for editing'
+
+nextStepFile: './step-02-select-edit.md'
+moduleStandardsFile: '../../data/module-standards.md'
+---
+
+# Step 1: Load Target (Edit Mode)
+
+## STEP GOAL:
+
+Load the target (brief, module.yaml, agent specs, or workflow specs) for editing.
+
+## MANDATORY EXECUTION RULES:
+
+### Universal Rules:
+- 📖 CRITICAL: Read the complete step file before taking any action
+- ✅ Speak in `{communication_language}`
+
+### Role Reinforcement:
+- ✅ You are the **Module Editor** — helpful, ready to assist
+- ✅ Understand what we're editing
+
+---
+
+## MANDATORY SEQUENCE
+
+### 1. Determine Edit Target
+
+"**What would you like to edit?**"
+
+Options:
+- **[B]rief** — Module brief from Brief mode
+- **[Y]aml** — module.yaml configuration
+- **[A]gents** — Agent specifications
+- **[W]orkflows** — Workflow specifications
+- **[D]ocs** — README.md or TODO.md
+
+### 2. Load Target
+
+Based on selection, load the target file(s).
+
+**IF Brief:**
+- Path: `{bmb_creations_output_folder}/modules/module-brief-{code}.md`
+
+**IF Yaml:**
+- Path: `src/modules/{code}/module.yaml`
+
+**IF Agents:**
+- Path: `src/modules/{code}/agents/`
+- List available agent specs
+
+**IF Workflows:**
+- Path: `src/modules/{code}/workflows/`
+- List available workflow specs
+
+**IF Docs:**
+- Path: `src/modules/{code}/README.md` or `TODO.md`
+
+### 3. Display Current Content
+
+Show the current content of the target file.
+
+"**Here's the current content:**"
+
+{display relevant sections or summary}
+
+### 4. Proceed to Selection
+
+"**What would you like to change?**"
+
+Load `{nextStepFile}` to select the edit type.
+
+---
+
+## Success Metrics
+
+✅ Target loaded
+✅ Current content displayed
+✅ Ready to select edit type

package/install/templates/_byan/bmb/workflows/module/steps-e/step-02-select-edit.md

@@ -0,0 +1,77 @@
+---
+name: 'step-02-select-edit'
+description: 'Select edit type and gather changes'
+
+nextStepFile: './step-03-apply-edit.md'
+---
+
+# Step 2: Select Edit Type
+
+## STEP GOAL:
+
+Select the type of edit and gather the changes to make.
+
+## MANDATORY EXECUTION RULES:
+
+### Universal Rules:
+- 📖 CRITICAL: Read the complete step file before taking any action
+- ✅ Speak in `{communication_language}`
+
+### Role Reinforcement:
+- ✅ You are the **Module Editor** — precise, collaborative
+- ✅ Understand the change before making it
+
+---
+
+## MANDATORY SEQUENCE
+
+### 1. Select Edit Type
+
+"**What type of edit would you like to make?**"
+
+- **[M]odify** — Change existing content
+- **[A]dd** — Add new content
+- **[D]elete** — Remove content
+- **[R]eplace** — Replace section entirely
+
+### 2. Gather Edit Details
+
+**IF Modify:**
+"**Which section do you want to modify?**"
+"What should it change to?"
+
+**IF Add:**
+"**What do you want to add?**"
+"**Where should it go?**"
+
+**IF Delete:**
+"**What do you want to remove?**"
+
+**IF Replace:**
+"**What section should be replaced?**"
+"**What's the new content?**"
+
+### 3. Confirm Change
+
+"**Please confirm the edit:**"
+
+**Type:** {edit_type}
+**Target:** {section or content}
+**Change:** {description of change}
+
+"**Is this correct?**"
+
+### 4. Store Edit Plan
+
+Store the edit plan for the next step.
+
+Load `{nextStepFile}` to apply the edit.
+
+---
+
+## Success Metrics
+
+✅ Edit type selected
+✅ Change details gathered
+✅ User confirmed
+✅ Edit plan stored