@zeyue0329/xiaoma-cli 1.0.49 → 6.0.0-alpha.14

package/src/modules/xmb/workflows-legacy/module-brief/README.md

@@ -0,0 +1,264 @@
+# Module Brief Workflow
+
+## Overview
+
+The Module Brief workflow creates comprehensive blueprints for building new XIAOMA modules using strategic analysis and creative vision. It serves as the essential planning phase that transforms initial ideas into detailed, actionable specifications ready for implementation with the create-module workflow.
+
+## Key Features
+
+- **Strategic Module Planning** - Comprehensive analysis from concept to implementation roadmap
+- **Multi-Mode Operation** - Interactive, Express, and YOLO modes for different planning needs
+- **Creative Vision Development** - Guided process for innovative module concepts and unique value propositions
+- **Architecture Design** - Detailed agent and workflow ecosystem planning with interaction models
+- **User Journey Mapping** - Scenario-based validation ensuring practical usability
+- **Technical Planning** - Infrastructure requirements, dependencies, and complexity assessment
+- **Risk Assessment** - Proactive identification of challenges with mitigation strategies
+- **Implementation Roadmap** - Phased development plan with clear deliverables and timelines
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow module-brief
+```
+
+### With Brainstorming Input
+
+```bash
+# If you have brainstorming results from previous sessions
+workflow module-brief --input brainstorming-session-2024-09-26.md
+```
+
+### Express Mode
+
+```bash
+# For quick essential planning only
+workflow module-brief --mode express
+```
+
+### Configuration
+
+The workflow uses standard XMB configuration:
+
+- **output_folder**: Where the module brief will be saved
+- **user_name**: Brief author information
+- **communication_language**: Language for brief generation
+- **date**: Automatic timestamp for versioning
+
+## Workflow Structure
+
+### Files Included
+
+```
+module-brief/
+├── workflow.yaml           # Configuration and metadata
+├── instructions.md         # Step-by-step execution guide
+├── template.md            # Module brief document structure
+├── checklist.md           # Validation criteria
+└── README.md              # This file
+```
+
+## Workflow Process
+
+### Phase 1: Foundation and Context (Steps 1-3)
+
+**Mode Selection and Input Gathering**
+
+- Choose operational mode (Interactive, Express, YOLO)
+- Check for and optionally load existing brainstorming results
+- Gather background context and inspiration sources
+
+**Module Vision Development**
+
+- Define core problem the module solves
+- Identify target user audience and use cases
+- Establish unique value proposition and differentiators
+- Explore creative themes and personality concepts
+
+**Module Identity Establishment**
+
+- Generate module code (kebab-case) with multiple options
+- Create compelling, memorable module name
+- Select appropriate category (Domain-Specific, Creative, Technical, Business, Personal)
+- Define optional personality theme for consistent agent character
+
+### Phase 2: Architecture Planning (Steps 4-5)
+
+**Agent Architecture Design**
+
+- Plan agent team composition and roles
+- Define agent archetypes (Orchestrator, Specialist, Helper, Creator, Analyzer)
+- Specify personality traits and communication styles
+- Map key capabilities and signature commands
+
+**Workflow Ecosystem Design**
+
+- Categorize workflows by purpose and complexity:
+  - **Core Workflows**: Essential value-delivery functions (2-3)
+  - **Feature Workflows**: Specialized capabilities (3-5)
+  - **Utility Workflows**: Supporting operations (1-3)
+- Define input-process-output flows for each workflow
+- Assess complexity levels and implementation priorities
+
+### Phase 3: Validation and User Experience (Steps 6-7)
+
+**User Journey Mapping**
+
+- Create detailed user scenarios and stories
+- Map step-by-step usage flows through the module
+- Validate end-to-end functionality and value delivery
+- Identify potential friction points and optimization opportunities
+
+**Technical Planning and Requirements**
+
+- Assess data requirements and storage needs
+- Map integration points with other modules and external systems
+- Evaluate technical complexity and resource requirements
+- Document dependencies and infrastructure needs
+
+### Phase 4: Success Planning (Steps 8-9)
+
+**Success Metrics Definition**
+
+- Establish module success criteria and performance indicators
+- Define quality standards and reliability requirements
+- Create user experience goals and feedback mechanisms
+- Set measurable outcomes for module effectiveness
+
+**Development Roadmap Creation**
+
+- Design phased approach with MVP, Enhancement, and Polish phases
+- Define deliverables and timelines for each phase
+- Prioritize features and capabilities by value and complexity
+- Create clear milestones and success checkpoints
+
+### Phase 5: Enhancement and Risk Management (Steps 10-12)
+
+**Creative Features and Special Touches** (Optional)
+
+- Design easter eggs and delightful user interactions
+- Plan module lore and thematic consistency
+- Add personality quirks and creative responses
+- Develop backstories and universe building
+
+**Risk Assessment and Mitigation**
+
+- Identify technical, usability, and scope risks
+- Develop mitigation strategies for each risk category
+- Plan contingency approaches for potential challenges
+- Document decision points and alternative paths
+
+**Final Review and Export Preparation**
+
+- Comprehensive review of all brief sections
+- Validation against quality and completeness criteria
+- Preparation for seamless handoff to create-module workflow
+- Export readiness confirmation with actionable specifications
+
+## Output
+
+### Generated Files
+
+- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md`
+- **Strategic Specifications**: Ready-to-implement blueprint for create-module workflow
+
+### Output Structure
+
+The module brief contains detailed specifications across multiple sections:
+
+1. **Executive Summary** - Vision, category, complexity, target users
+2. **Module Identity** - Core concept, value proposition, personality theme
+3. **Agent Architecture** - Agent roster, roles, interaction models
+4. **Workflow Ecosystem** - Core, feature, and utility workflow specifications
+5. **User Scenarios** - Primary use cases, secondary scenarios, user journey
+6. **Technical Planning** - Data requirements, integrations, dependencies
+7. **Success Metrics** - Success criteria, quality standards, performance targets
+8. **Development Roadmap** - Phased implementation plan with deliverables
+9. **Creative Features** - Special touches, easter eggs, module lore
+10. **Risk Assessment** - Technical, usability, scope risks with mitigation
+11. **Implementation Notes** - Priority order, design decisions, open questions
+12. **Resources and References** - Inspiration sources, similar modules, technical references
+
+## Requirements
+
+- **Creative Vision** - Initial module concept or problem domain
+- **Strategic Thinking** - Ability to plan architecture and user experience
+- **Brainstorming Results** (optional) - Previous ideation sessions enhance planning quality
+
+## Best Practices
+
+### Before Starting
+
+1. **Gather Inspiration** - Research similar tools, modules, and solutions in your domain
+2. **Run Brainstorming Session** - Use ideation techniques to generate initial concepts
+3. **Define Success Criteria** - Know what "successful module" means for your context
+
+### During Execution
+
+1. **Think User-First** - Always consider the end user experience and value delivery
+2. **Be Specific** - Provide concrete examples and detailed specifications rather than abstractions
+3. **Validate Early** - Use user scenarios to test if the module concept actually works
+4. **Plan Iteratively** - Start with MVP and build complexity through phases
+
+### After Completion
+
+1. **Use as Blueprint** - Feed the brief directly into create-module workflow for implementation
+2. **Review with Stakeholders** - Validate assumptions and gather feedback before building
+3. **Update as Needed** - Treat as living document that evolves with implementation learnings
+4. **Reference During Development** - Use as north star for design decisions and scope management
+
+## Troubleshooting
+
+### Common Issues
+
+**Issue**: Stuck on module concept or vision
+
+- **Solution**: Use creative prompts provided in the workflow
+- **Check**: Review existing modules for inspiration and patterns
+
+**Issue**: Agent or workflow architecture too complex
+
+- **Solution**: Focus on MVP first, plan enhancement phases for additional complexity
+- **Check**: Validate each component against user scenarios
+
+**Issue**: Technical requirements unclear
+
+- **Solution**: Research similar modules and their implementation approaches
+- **Check**: Consult with technical stakeholders early in planning
+
+**Issue**: Scope creep during planning
+
+- **Solution**: Use phased roadmap to defer non-essential features
+- **Check**: Regularly validate against core user scenarios and success criteria
+
+## Customization
+
+To customize this workflow:
+
+1. **Modify Template Structure** - Update template.md to add new sections or reorganize content
+2. **Extend Creative Prompts** - Add domain-specific ideation techniques in instructions.md
+3. **Add Planning Tools** - Integrate additional analysis frameworks or planning methodologies
+4. **Customize Validation** - Enhance checklist.md with specific quality criteria for your context
+
+## Version History
+
+- **v1.0.0** - Initial release
+  - Comprehensive strategic module planning
+  - Multi-mode operation (Interactive, Express, YOLO)
+  - Creative vision and architecture design tools
+  - User journey mapping and validation
+  - Risk assessment and mitigation planning
+
+## Support
+
+For issues or questions:
+
+- Review the workflow creation guide at `/{xiaoma_folder}/xmb/workflows/create-workflow/workflow-creation-guide.md`
+- Study existing module examples in `/{xiaoma_folder}/` for patterns and inspiration
+- Validate output using `checklist.md`
+- Consult module structure guide at `create-module/module-structure.md`
+
+---
+
+_Part of the XiaoMa Method v6 - XMB (Builder) Module_

package/src/modules/xmb/workflows-legacy/module-brief/checklist.md

@@ -0,0 +1,116 @@
+# Module Brief Validation Checklist
+
+## Core Identity
+
+- [ ] Module code follows kebab-case convention
+- [ ] Module name is clear and memorable
+- [ ] Module category is identified
+- [ ] Target users are clearly defined
+- [ ] Unique value proposition is articulated
+
+## Vision and Concept
+
+- [ ] Problem being solved is clearly stated
+- [ ] Solution approach is explained
+- [ ] Module scope is well-defined
+- [ ] Success criteria are measurable
+
+## Agent Architecture
+
+- [ ] At least one agent is defined
+- [ ] Each agent has a clear role and purpose
+- [ ] Agent personalities are defined (if using personality themes)
+- [ ] Agent interactions are mapped (for multi-agent modules)
+- [ ] Key commands for each agent are listed
+
+## Workflow Ecosystem
+
+- [ ] Core workflows (2-3) are identified
+- [ ] Each workflow has clear purpose
+- [ ] Workflow complexity is assessed
+- [ ] Input/output for workflows is defined
+- [ ] Workflow categories are logical
+
+## User Experience
+
+- [ ] Primary use case is documented
+- [ ] User scenarios demonstrate value
+- [ ] User journey is realistic
+- [ ] Learning curve is considered
+- [ ] User feedback mechanism planned
+
+## Technical Planning
+
+- [ ] Data requirements are identified
+- [ ] Integration points are mapped
+- [ ] Dependencies are listed
+- [ ] Technical complexity is assessed
+- [ ] Performance requirements stated
+
+## Development Roadmap
+
+- [ ] Phase 1 MVP is clearly scoped
+- [ ] Phase 2 enhancements are outlined
+- [ ] Phase 3 polish items listed
+- [ ] Timeline estimates provided
+- [ ] Deliverables are specific
+
+## Risk Management
+
+- [ ] Technical risks identified
+- [ ] Usability risks considered
+- [ ] Scope risks acknowledged
+- [ ] Mitigation strategies provided
+- [ ] Open questions documented
+
+## Creative Elements (Optional)
+
+- [ ] Personality theme is consistent (if used)
+- [ ] Special features add value
+- [ ] Module feels cohesive
+- [ ] Fun elements don't compromise functionality
+
+## Documentation Quality
+
+- [ ] All sections have content (no empty placeholders)
+- [ ] Writing is clear and concise
+- [ ] Technical terms are explained
+- [ ] Examples are provided where helpful
+- [ ] Next steps are actionable
+
+## Implementation Readiness
+
+- [ ] Brief provides enough detail for create-module workflow
+- [ ] Agent specifications sufficient for create-agent workflow
+- [ ] Workflow descriptions ready for create-workflow
+- [ ] Resource requirements are clear
+- [ ] Success metrics are measurable
+
+## Final Validation
+
+- [ ] Module concept is viable
+- [ ] Scope is achievable
+- [ ] Value is clear
+- [ ] Brief is complete
+- [ ] Ready for development
+
+## Issues Found
+
+### Critical Issues
+
+<!-- Must be fixed before proceeding to build -->
+
+### Recommendations
+
+<!-- Suggested improvements -->
+
+### Nice-to-Haves
+
+<!-- Optional enhancements -->
+
+---
+
+**Validation Complete:** ⬜ Yes / ⬜ With Issues / ⬜ Needs Revision
+
+**Validated By:** {name}
+**Date:** {date}

package/src/modules/xmb/workflows-legacy/module-brief/instructions.md

@@ -0,0 +1,268 @@
+# Module Brief Instructions
+
+<critical>The workflow execution engine is governed by: {project-root}/{xiaoma_folder}/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {project-root}/{xiaoma_folder}/xmb/workflows/module-brief/workflow.yaml</critical>
+<critical>Communicate in {communication_language} throughout the module brief creation process</critical>
+<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
+
+<workflow>
+
+<step n="1" goal="Setup and context gathering">
+<action>Ask the user which mode they prefer:</action>
+1. **Interactive Mode** - Work through each section collaboratively with detailed questions
+2. **Express Mode** - Quick essential questions only
+3. **YOLO Mode** (#yolo) - Generate complete draft based on minimal input
+
+<action>Check for available inputs:</action>
+
+- Brainstorming results from previous sessions
+- Existing module ideas or notes
+- Similar modules for inspiration
+
+<action>If brainstorming results exist, offer to load and incorporate them</action>
+</step>
+
+<step n="2" goal="Module concept and vision">
+Ask the user to describe their module idea. Probe for:
+- What problem does this module solve?
+- Who would use this module?
+- What makes this module exciting or unique?
+- Any inspiring examples or similar tools?
+
+If they're stuck, offer creative prompts:
+
+- "Imagine you're a [role], what tools would make your life easier?"
+- "What repetitive tasks could be automated with agents?"
+- "What domain expertise could be captured in workflows?"
+
+<template-output>module_vision</template-output>
+</step>
+
+<step n="3" goal="Define module identity">
+Based on the vision, work with user to define:
+
+**Module Code** (kebab-case):
+
+- Suggest 2-3 options based on their description
+- Ensure it's memorable and descriptive
+
+**Module Name** (friendly):
+
+- Creative, engaging name that captures the essence
+
+**Module Category:**
+
+- Domain-Specific (legal, medical, finance)
+- Creative (writing, gaming, music)
+- Technical (devops, testing, architecture)
+- Business (project management, marketing)
+- Personal (productivity, learning)
+
+**Personality Theme** (optional but fun!):
+
+- Should the module have a consistent personality across agents?
+- Star Trek crew? Fantasy party? Corporate team? Reality show cast?
+
+<template-output>module_identity</template-output>
+</step>
+
+<step n="4" goal="Agent architecture planning">
+<action>Help user envision their agent team</action>
+
+For each agent, capture:
+
+- **Role**: What's their specialty?
+- **Personality**: How do they communicate? (reference communication styles)
+- **Key Capabilities**: What can they do?
+- **Signature Commands**: 2-3 main commands
+
+Suggest agent archetypes based on module type:
+
+- The Orchestrator (manages other agents)
+- The Specialist (deep expertise)
+- The Helper (utility functions)
+- The Creator (generates content)
+- The Analyzer (processes and evaluates)
+
+<template-output>agent_architecture</template-output>
+</step>
+
+<step n="5" goal="Workflow ecosystem design">
+<action>Map out the workflow landscape</action>
+
+Categorize workflows:
+
+**Core Workflows** (2-3 essential ones):
+
+- The primary value-delivery workflows
+- What users will use most often
+
+**Feature Workflows** (3-5 specialized):
+
+- Specific capabilities
+- Advanced features
+
+**Utility Workflows** (1-3 supporting):
+
+- Setup, configuration
+- Maintenance, cleanup
+
+For each workflow, define:
+
+- Purpose (one sentence)
+- Input → Process → Output
+- Complexity (simple/standard/complex)
+
+<template-output>workflow_ecosystem</template-output>
+</step>
+
+<step n="6" goal="User journey and scenarios">
+<action>Create usage scenarios to validate the design</action>
+
+Write 2-3 user stories:
+"As a [user type], I want to [goal], so that [outcome]"
+
+Then walk through how they'd use the module:
+
+1. They load [agent]
+2. They run [command/workflow]
+3. They get [result]
+4. This helps them [achievement]
+
+This validates the module makes sense end-to-end.
+
+<template-output>user_scenarios</template-output>
+</step>
+
+<step n="7" goal="Technical and resource planning">
+Assess technical requirements:
+
+**Data Requirements:**
+
+- What data/files does the module need?
+- Any external APIs or services?
+- Storage or state management needs?
+
+**Integration Points:**
+
+- Other XIAOMA modules it might use
+- External tools or platforms
+- Import/export formats
+
+**Complexity Assessment:**
+
+- Simple (standalone, no dependencies)
+- Standard (some integrations, moderate complexity)
+- Complex (multiple systems, advanced features)
+
+<template-output>technical_planning</template-output>
+</step>
+
+<step n="8" goal="Success metrics and validation">
+Define what success looks like:
+
+**Module Success Criteria:**
+
+- What indicates the module is working well?
+- How will users measure value?
+- What feedback mechanisms?
+
+**Quality Standards:**
+
+- Performance expectations
+- Reliability requirements
+- User experience goals
+
+<template-output>success_metrics</template-output>
+</step>
+
+<step n="9" goal="Development roadmap">
+Create a phased approach:
+
+**Phase 1 - MVP (Minimum Viable Module):**
+
+- 1 primary agent
+- 2-3 core workflows
+- Basic functionality
+
+**Phase 2 - Enhancement:**
+
+- Additional agents
+- More workflows
+- Refined features
+
+**Phase 3 - Polish:**
+
+- Advanced features
+- Optimizations
+- Nice-to-haves
+
+<template-output>development_roadmap</template-output>
+</step>
+
+<step n="10" goal="Creative flourishes and special features" optional="true">
+<action>If user wants to add special touches:</action>
+
+**Easter Eggs:**
+
+- Hidden commands or responses
+- Fun interactions between agents
+
+**Delighters:**
+
+- Unexpected helpful features
+- Personality quirks
+- Creative responses
+
+**Module Lore:**
+
+- Backstory for agents
+- Thematic elements
+- Consistent universe
+
+<template-output>creative_features</template-output>
+</step>
+
+<step n="11" goal="Risk assessment and mitigation">
+Identify potential challenges:
+
+**Technical Risks:**
+
+- Complex integrations
+- Performance concerns
+- Dependency issues
+
+**Usability Risks:**
+
+- Learning curve
+- Complexity creep
+- User confusion
+
+**Scope Risks:**
+
+- Feature bloat
+- Timeline expansion
+- Resource constraints
+
+For each risk, note mitigation strategy.
+
+<template-output>risk_assessment</template-output>
+</step>
+
+<step n="12" goal="Final review and export readiness">
+<action>Review all sections with {user_name}</action>
+<action>Ensure module brief is ready for create-module workflow</action>
+
+<ask>Would {user_name} like to:
+
+1. Proceed directly to create-module workflow
+2. Save and refine later
+3. Generate additional planning documents
+   </ask>
+
+<action>Inform {user_name} in {communication_language} that this brief can be fed directly into create-module workflow</action>
+
+<template-output>final_brief</template-output>
+</step>
+
+</workflow>