create-byan-agent 2.1.0 → 2.2.1

package/install/templates/_byan/bmb/workflows/workflow/steps-c/step-02-classification.md

@@ -0,0 +1,269 @@
+---
+name: 'step-02-classification'
+description: 'Classify the workflow by answering the 4 key structural decisions'
+
+nextStepFile: './step-03-requirements.md'
+workflowTypeCriteria: '../data/workflow-type-criteria.md'
+workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md'
+bmbCreationsOutputFolder: '{bmb_creations_output_folder}'
+customWorkflowLocation: '{custom_workflow_location}'
+---
+
+# Step 2: Workflow Classification
+
+## STEP GOAL:
+
+To determine the 4 key structural decisions that define how the workflow will be built: module affiliation, continuable vs single-session, tri-modal vs create-only, and document output.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a workflow architect helping classify their workflow
+- ✅ Explain the trade-offs of each decision clearly
+- ✅ Help them make informed choices
+- ✅ These 4 decisions affect the entire workflow structure
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on the 4 key structural decisions
+- 🚫 FORBIDDEN to skip any of the 4 decisions
+- 💬 Explain each decision in plain language before asking
+- 🚪 These decisions determine file structure, naming, and location
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load workflowTypeCriteria for the decision framework
+- 💾 Document each decision in the plan
+- 📖 Update frontmatter stepsCompleted when complete
+- 🚫 FORBIDDEN to load next step until all 4 decisions are made
+
+## CONTEXT BOUNDARIES:
+
+- Discovery from Step 1 informs these decisions
+- These are STRUCTURAL decisions that affect everything else
+- Once made, changing them is difficult
+- Take time to explain trade-offs
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 0. Load Decision Framework
+
+Load `{workflowTypeCriteria}` to understand the 4 key decisions and their implications.
+
+### 1. Decision 1: Document Output (FIRST - It's Fundamental)
+
+"**Let's classify your workflow. I'll walk you through 4 key decisions that determine how it's built.**
+
+**Decision 1: What does your workflow produce?**
+
+Based on your idea from discovery, let me clarify:"
+
+- [If unclear from discovery] "Does this workflow produce a document or file at the end? A report, a plan, a story, a checklist?"
+
+Present the two options:
+
+**A. Document-Producing**
+- Creates a persistent output file
+- Examples: reports, plans, stories, checklists, forms
+- Uses templates for structure
+
+**B. Non-Document**
+- Performs actions without creating a document
+- Examples: refactoring code, running tests, orchestrating tools
+- May produce temporary files but no persistent output
+
+"Which describes your workflow?"
+
+**Think about their response before continuing...**
+
+Once decided:
+- Document: `workflowProducesDocuments: true`
+- Non-document: `workflowProducesDocuments: false`
+
+### 2. Decision 2: Module Affiliation
+
+"**Decision 2: Where will this workflow live?**
+
+Workflows can be standalone or part of a module:"
+
+**Standalone:**
+- NOT part of any module
+- Stored in your custom location
+- Only standard variables available
+
+**Module-Based (BMB, BMM, CIS, BMGD, etc.):**
+- Part of a specific module
+- Has access to module-specific variables
+- Stored in that module's workflows directory
+
+"Is this workflow:
+- **A)** Standalone - just for you/custom use
+- **B)** Part of a module - which one?"
+
+**If they don't know modules:**
+"Modules are specialized areas:
+- **BMB** - Module building workflows
+- **BMM** - Software development workflows (PRDs, architecture, etc.)
+- **CIS** - Innovation and creative workflows
+- **BMGD** - Game development workflows
+- **Custom** - Your own workflows
+
+Does your workflow fit into one of these areas, or is it standalone?"
+
+Document the result.
+
+### 3. Decision 3: Continuable or Single-Session
+
+"**Decision 3: Could this workflow take multiple sessions to complete?**
+
+Think about: Will this workflow consume many tokens or take a long time? Might users need to pause and come back later?"
+
+**Single-Session:**
+- Quick, focused workflows (15-30 minutes)
+- Simpler structure
+- No continuation logic needed
+
+**Continuable:**
+- Can span multiple sessions
+- Complex, many steps
+- Saves progress, can resume later
+- Needs `step-01b-continue.md`
+
+"Is your workflow:
+- **A)** Single-session - quick and focused
+- **B)** Continuable - could take multiple sessions"
+
+**Help them think:**
+- "Walk me through how long you think this would take..."
+- "What happens if someone gets halfway through and has to stop?"
+
+Document the result.
+
+### 4. Decision 4: Create-Only or Tri-Modal
+
+"**Decision 4: Will this workflow need Edit and Validate capabilities?**
+
+Some workflows are simple - you create them once and use them. Others need full lifecycle support:**
+
+**Create-Only:**
+- Just `steps-c/` (create steps)
+- Simpler, faster to build
+- Good for: experimental workflows, one-off use, simple tools
+
+**Tri-Modal (Create + Edit + Validate):**
+- Has `steps-c/`, `steps-e/` (edit), and `steps-v/` (validate)
+- Full lifecycle support
+- Can be modified and validated after creation
+- Good for: complex workflows, maintained workflows, team use
+
+"Do you envision:
+- **A)** Create-only - build it and use it
+- **B)** Tri-modal - create, edit, AND validate capabilities"
+
+**If they're unsure:**
+"Think: Will you or others want to modify this workflow later? Does it need quality checking/validation?"
+
+Document the result.
+
+### 5. Name the Workflow
+
+"Now that we understand what this workflow IS, let's name it properly.
+
+Based on everything we've discovered, what would you call this?
+
+Some guidance:
+- Use kebab-case: `my-workflow-name`
+- Be descriptive but concise
+- Think: What would someone search for to find this?
+
+[Offer suggestions based on their vision]"
+
+**Check for uniqueness:**
+- Look for folder at `{bmb_creationsOutputFolder}/workflows/{proposed-name}/`
+- If exists: "That name is taken. Want to try a variant like...?"
+- Loop until unique name confirmed
+
+Document the final name.
+
+### 6. Confirm Target Location
+
+Based on module decision, confirm and document the target path:
+
+**For standalone/custom:**
+- Target: `{customWorkflowLocation}/{workflow-name}/`
+- Typically: `_byan/custom/src/workflows/{workflow-name}/`
+
+**For modules:**
+- Check module's workflow location from module.yaml
+- Confirm path with user
+
+Document: `targetWorkflowPath: [confirmed path]`
+
+### 7. Update Plan with Classification
+
+Update `{workflowPlanFile}`:
+
+```markdown
+## Classification Decisions
+
+**Workflow Name:** {name}
+**Target Path:** {targetWorkflowPath}
+
+**4 Key Decisions:**
+1. **Document Output:** {true/false}
+2. **Module Affiliation:** {standalone/module-name}
+3. **Session Type:** {single-session/continuable}
+4. **Lifecycle Support:** {create-only/tri-modal}
+
+**Structure Implications:**
+- [Document what this means: e.g., "Needs steps-c/, steps-e/, steps-v/", "Needs step-01b-continue.md", etc.]
+```
+
+### 8. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- ONLY proceed to next step when user selects 'C'
+- User can chat or ask questions - always respond and redisplay menu
+
+#### Menu Handling Logic:
+
+- IF A: Execute {project-root}/_byan/core/workflows/advanced-elicitation/workflow.xml
+- IF P: Execute {project-root}/_byan/core/workflows/party-mode/workflow.md
+- IF C: Update plan frontmatter with stepsCompleted and classification, then load `{nextStepFile}`
+- IF Any other: Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All 4 key decisions made and documented
+- Workflow named appropriately
+- Target location confirmed
+- Structural implications understood
+- Plan updated with classification
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping any of the 4 key decisions
+- Naming before understanding (old pattern)
+- Not explaining trade-offs
+- Not checking for name conflicts
+
+**Master Rule:** The 4 key decisions determine everything else. Get them right before proceeding.

package/install/templates/_byan/bmb/workflows/workflow/steps-c/step-03-requirements.md

@@ -0,0 +1,282 @@
+---
+name: 'step-03-requirements'
+description: 'Gather detailed requirements through collaborative conversation'
+
+nextStepFile: './step-04-tools.md'
+workflowExamples: '../data/workflow-examples.md'
+outputFormatStandards: '../data/output-format-standards.md'
+workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md'
+advancedElicitationTask: '{project-root}/_byan/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_byan/core/workflows/party-mode/workflow.md'
+---
+
+# Step 3: Requirements Gathering
+
+## STEP GOAL:
+
+To gather comprehensive requirements through conversation, building on the classification decisions, and document them in a standardized format for the design phase.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a workflow architect gathering requirements
+- ✅ Build on what we discovered and classified
+- ✅ Ask 1-2 questions at a time, think about responses
+- ✅ We already know the 4 key decisions - now we get details
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on requirements gathering
+- 🚫 FORBIDDEN to propose workflow designs yet
+- 💬 Ask conversationally, not like a form
+- 📋 Use the standardized template (below) for consistent storage
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load references as needed
+- 💾 Store to standardized template in plan document
+- 📖 Update frontmatter stepsCompleted when complete
+- 🚫 FORBIDDEN to load next step until requirements are complete
+
+## CONTEXT BOUNDARIES:
+
+- Discovery (Step 1) gave us the vision
+- Classification (Step 2) gave us the 4 key decisions
+- Now we gather detailed requirements
+- Don't design workflow steps yet - that's Step 6
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Initialize Requirements
+
+"**Let's gather the requirements for your workflow.**
+
+We already know:
+- [Summarize vision from discovery]
+- [Summarize 4 key decisions from classification]
+
+Now I need to understand the details of how this workflow should work."
+
+### 2. Workflow Flow and Structure
+
+Load `{workflowExamples}` to reference diverse patterns.
+
+"**How should this workflow flow?**
+
+From our examples, workflows can be structured differently:"
+
+**Flow Patterns:**
+- **Linear:** Step 1 → Step 2 → Step 3 → Finish
+- **Looping:** Generate → Review → Generate more... until done
+- **Branching:** Different paths based on user choices
+- **Repeating:** Same steps, new content each session
+
+"Think about your workflow:
+- Should it go straight through, or loop/branch?
+- How many logical phases does it need?
+- What are the major milestones?"
+
+**Think about their response...**
+
+### 3. User Interaction Style
+
+"**How collaborative should this be?**
+
+Think about the person running this workflow:"
+
+- **Highly Collaborative:** AI asks questions, guides, facilitates at each step
+- **Mostly Autonomous:** AI does the work with occasional checkpoints
+- **Guided Session:** AI leads through a structured experience
+- **Mixed:** Some steps collaborative, some autonomous
+
+"Where does your workflow fit on this spectrum?
+
+And are there specific decision points where the user MUST choose something?"
+
+### 4. Input Requirements
+
+"**What does this workflow need to start?**"
+
+- What documents or data must be provided?
+- Are there prerequisites or dependencies?
+- Will users need to provide specific information?
+- Any optional inputs that enhance the workflow?
+
+"**Think about their response before continuing...**"
+
+### 5. Output Specifications (IF document-producing)
+
+**ONLY if `workflowProducesDocuments: true` from classification:**
+
+Load `{outputFormatStandards}` and discuss:
+
+"**What should the output look like?**
+
+Since your workflow produces a document, let's decide the format:"
+
+**Four Template Types:**
+
+1. **Free-form (Recommended)** - Minimal structure, content-driven
+   - Use for: Most collaborative workflows
+   - Has: Basic frontmatter, progressive content, final polish step
+
+2. **Structured** - Required sections, flexible within each
+   - Use for: Reports, proposals, documentation
+   - Has: Clear section headers, consistent structure
+
+3. **Semi-structured** - Core sections + optional additions
+   - Use for: Forms, checklists, meeting minutes
+   - Has: Required fields, optional extras
+
+4. **Strict** - Exact format, specific fields
+   - Use for: Compliance, legal, regulated (rare)
+   - Has: Precise requirements, validation
+
+"Which format fits your workflow best?"
+
+**If Free-form (most common):**
+- "We'll use a minimal template with basic frontmatter. The workflow will build the document section by section, with a final polish step to optimize flow."
+
+**If Structured/Semi-structured:**
+- "What sections are required? Any optional sections?"
+
+**If Strict:**
+- "Do you have an existing template to follow, or should we design one?"
+
+Document the output format decision.
+
+### 6. Output Specifications (IF non-document)
+
+**ONLY if `workflowProducesDocuments: false` from classification:**
+
+"**What does this workflow produce if not a document?**
+
+- Actions performed?
+- Changes made to code/files?
+- A decision or recommendation?
+- A temporary artifact?"
+
+Document what the workflow produces.
+
+### 7. Success Criteria
+
+"**How will we know this workflow succeeded?**
+
+Think about the end result:
+- What does 'done' look like?
+- What would make a user satisfied?
+- Are there quality criteria?
+- Can we measure success?"
+
+"**Think about their response...**"
+
+### 8. Instruction Style (NOW, Not Earlier)
+
+**We ask this NOW because we understand the workflow:**
+
+"**How should the AI executing this workflow behave?**"
+
+**Intent-Based (Recommended for most):**
+- Steps describe goals and principles
+- AI adapts conversation naturally
+- More flexible and responsive
+- Example: "Guide user to define requirements through open-ended discussion"
+
+**Prescriptive:**
+- Steps provide exact instructions
+- More controlled and predictable
+- Example: "Ask: 'What is your primary goal? A) Growth B) Efficiency C) Quality'"
+
+**Mixed:**
+- Some steps prescriptive, others intent-based
+- Use prescriptive for critical/required steps
+- Use intent-based for creative/facilitative steps
+
+"Which style fits your workflow, or should it be mixed?"
+
+### 9. Store to Standardized Template
+
+Update `{workflowPlanFile}` with the requirements section:
+
+```markdown
+## Requirements
+
+**Flow Structure:**
+- Pattern: [linear/looping/branching/repeating]
+- Phases: [list major phases]
+- Estimated steps: [rough count]
+
+**User Interaction:**
+- Style: [highly collaborative/mostly autonomous/guided/mixed]
+- Decision points: [where user must choose]
+- Checkpoint frequency: [how often to pause]
+
+**Inputs Required:**
+- Required: [list]
+- Optional: [list]
+- Prerequisites: [list]
+
+**Output Specifications:**
+- Type: [document/action/decision/temporary]
+- Format: [free-form/structured/semi-structured/strict OR describe non-document output]
+- Sections: [if structured]
+- Frequency: [single/batch/continuous]
+
+**Success Criteria:**
+- [list what success looks like]
+
+**Instruction Style:**
+- Overall: [intent-based/prescriptive/mixed]
+- Notes: [any specific style requirements]
+```
+
+### 10. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- ONLY proceed when user selects 'C'
+- User can chat or ask questions - always respond and redisplay menu
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask}
+- IF P: Execute {partyModeWorkflow}
+- IF C: Save requirements to plan, update frontmatter, then load `{nextStepFile}`
+- IF Any other: Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Requirements gathered through conversation (not interrogation)
+- Flow structure clearly understood
+- Input/output specifications defined
+- Output format decided (if document-producing)
+- Success criteria established
+- Instruction style determined
+- All stored in standardized template
+
+### ❌ SYSTEM FAILURE:
+
+- Asking for instruction style before understanding the workflow
+- Skipping output format discussion
+- Not storing to standardized template
+- Proceeding without understanding the flow
+
+**Master Rule:** Requirements build on classification. Use the standardized template so the next steps can read consistent data.