BMAD-METHOD/common/tasks/create-doc.md

80 lines
2.6 KiB
Markdown
Raw Normal View History

2025-07-06 18:26:09 -05:00
# Create Document from Template (YAML Driven)
2025-07-06 18:26:09 -05:00
## CRITICAL: Mandatory Elicitation Format
2025-07-06 18:26:09 -05:00
**When `elicit: true`, ALWAYS use this exact format:**
2025-07-06 18:26:09 -05:00
1. Present section content
2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
3. Present numbered options 1-9:
- **Option 1:** Always "Proceed to next section"
- **Options 2-9:** Select 8 methods from data/elicitation-methods
- End with: "Select 1-9 or just type your question/feedback:"
2025-07-06 18:26:09 -05:00
**NEVER ask yes/no questions or use any other format.**
2025-07-06 18:26:09 -05:00
## Processing Flow
2025-07-06 18:26:09 -05:00
1. **Parse YAML template** - Load template metadata and sections
2. **Set preferences** - Show current mode (Interactive), confirm output file
3. **Process each section:**
- Skip if condition unmet
- Check agent permissions (owner/editors) - note if section is restricted to specific agents
- Draft content using section instruction
- Present content + detailed rationale
- **IF elicit: true** → MANDATORY 1-9 options format
- Save to file if possible
4. **Continue until complete**
2025-07-06 18:26:09 -05:00
## Detailed Rationale Requirements
2025-07-06 18:26:09 -05:00
When presenting section content, ALWAYS include rationale that explains:
2025-07-06 18:26:09 -05:00
- Trade-offs and choices made (what was chosen over alternatives and why)
- Key assumptions made during drafting
- Interesting or questionable decisions that need user attention
- Areas that might need validation
2025-07-06 18:26:09 -05:00
## Elicitation Results Flow
2025-07-06 18:26:09 -05:00
After user selects elicitation method (2-9):
2025-07-06 18:26:09 -05:00
1. Execute method from data/elicitation-methods
2. Present results with insights
3. Offer options:
- **1. Apply changes and update section**
- **2. Return to elicitation menu**
- **3. Ask any questions or engage further with this elicitation**
2025-07-06 18:26:09 -05:00
## Agent Permissions
2025-07-06 18:26:09 -05:00
When processing sections with agent permission fields:
2025-07-06 18:26:09 -05:00
- **owner**: Note which agent role initially creates/populates the section
- **editors**: List agent roles allowed to modify the section
- **readonly**: Mark sections that cannot be modified after creation
2025-07-06 18:26:09 -05:00
**For sections with restricted access:**
2025-07-06 18:26:09 -05:00
- Include a note in the generated document indicating the responsible agent
- Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
2025-07-06 18:26:09 -05:00
## YOLO Mode
2025-07-06 18:26:09 -05:00
User can type `#yolo` to toggle to YOLO mode (process all sections at once).
2025-07-06 18:26:09 -05:00
## CRITICAL REMINDERS
2025-07-06 18:26:09 -05:00
**❌ NEVER:**
2025-07-06 18:26:09 -05:00
- Ask yes/no questions for elicitation
- Use any format other than 1-9 numbered options
- Create new elicitation methods
2025-07-06 18:26:09 -05:00
**✅ ALWAYS:**
2025-07-06 18:26:09 -05:00
- Use exact 1-9 format when elicit: true
- Select options 2-9 from data/elicitation-methods only
- Provide detailed rationale explaining decisions
- End with "Select 1-9 or just type your question/feedback:"