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

package/src/modules/xmc/workflows/3-solutioning/architecture/steps/step-07-validation.md

@@ -0,0 +1,358 @@
+# Step 7: Architecture Validation & Completion
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without user input
+
+- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
+- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
+- ✅ ALWAYS treat this as collaborative discovery between architectural peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on validating architectural coherence and completeness
+- ✅ VALIDATE all requirements are covered by architectural decisions
+- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- ✅ Run comprehensive validation checks on the complete architecture
+- ⚠️ Present A/P/C menu after generating validation results
+- 💾 ONLY save when user chooses C (Continue)
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step
+- 🚫 FORBIDDEN to load next step until C is selected
+
+## COLLABORATION MENUS (A/P/C):
+
+This step will generate content and present choices:
+
+- **A (Advanced Elicitation)**: Use discovery protocols to address complex architectural issues found during validation
+- **P (Party Mode)**: Bring multiple perspectives to resolve validation concerns
+- **C (Continue)**: Save the validation results and complete the architecture
+
+## PROTOCOL INTEGRATION:
+
+- When 'A' selected: Execute {project-root}/{xiaoma_folder}/core/tasks/advanced-elicitation.xml
+- When 'P' selected: Execute {project-root}/{xiaoma_folder}/core/workflows/party-mode/workflow.md
+- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
+- User accepts/rejects protocol changes before proceeding
+
+## CONTEXT BOUNDARIES:
+
+- Complete architecture document with all sections is available
+- All architectural decisions, patterns, and structure are defined
+- Focus on validation, gap analysis, and coherence checking
+- Prepare for handoff to implementation phase
+
+## YOUR TASK:
+
+Validate the complete architecture for coherence, completeness, and readiness to guide AI agents through consistent implementation.
+
+## VALIDATION SEQUENCE:
+
+### 1. Coherence Validation
+
+Check that all architectural decisions work together:
+
+**Decision Compatibility:**
+
+- Do all technology choices work together without conflicts?
+- Are all versions compatible with each other?
+- Do patterns align with technology choices?
+- Are there any contradictory decisions?
+
+**Pattern Consistency:**
+
+- Do implementation patterns support the architectural decisions?
+- Are naming conventions consistent across all areas?
+- Do structure patterns align with technology stack?
+- Are communication patterns coherent?
+
+**Structure Alignment:**
+
+- Does the project structure support all architectural decisions?
+- Are boundaries properly defined and respected?
+- Does the structure enable the chosen patterns?
+- Are integration points properly structured?
+
+### 2. Requirements Coverage Validation
+
+Verify all project requirements are architecturally supported:
+
+**From Epics (if available):**
+
+- Does every epic have architectural support?
+- Are all user stories implementable with these decisions?
+- Are cross-epic dependencies handled architecturally?
+- Are there any gaps in epic coverage?
+
+**From FR Categories (if no epics):**
+
+- Does every functional requirement have architectural support?
+- Are all FR categories fully covered by architectural decisions?
+- Are cross-cutting FRs properly addressed?
+- Are there any missing architectural capabilities?
+
+**Non-Functional Requirements:**
+
+- Are performance requirements addressed architecturally?
+- Are security requirements fully covered?
+- Are scalability considerations properly handled?
+- Are compliance requirements architecturally supported?
+
+### 3. Implementation Readiness Validation
+
+Assess if AI agents can implement consistently:
+
+**Decision Completeness:**
+
+- Are all critical decisions documented with versions?
+- Are implementation patterns comprehensive enough?
+- Are consistency rules clear and enforceable?
+- Are examples provided for all major patterns?
+
+**Structure Completeness:**
+
+- Is the project structure complete and specific?
+- Are all files and directories defined?
+- Are integration points clearly specified?
+- Are component boundaries well-defined?
+
+**Pattern Completeness:**
+
+- Are all potential conflict points addressed?
+- Are naming conventions comprehensive?
+- Are communication patterns fully specified?
+- Are process patterns (error handling, etc.) complete?
+
+### 4. Gap Analysis
+
+Identify and document any missing elements:
+
+**Critical Gaps:**
+
+- Missing architectural decisions that block implementation
+- Incomplete patterns that could cause conflicts
+- Missing structural elements needed for development
+- Undefined integration points
+
+**Important Gaps:**
+
+- Areas that need more detailed specification
+- Patterns that could be more comprehensive
+- Documentation that would help implementation
+- Examples that would clarify complex decisions
+
+**Nice-to-Have Gaps:**
+
+- Additional patterns that would be helpful
+- Supplementary documentation
+- Tooling recommendations
+- Development workflow optimizations
+
+### 5. Address Validation Issues
+
+For any issues found, facilitate resolution:
+
+**Critical Issues:**
+"I found some issues that need to be addressed before implementation:
+
+{{critical_issue_description}}
+
+These could cause implementation problems. How would you like to resolve this?"
+
+**Important Issues:**
+"I noticed a few areas that could be improved:
+
+{{important_issue_description}}
+
+These aren't blocking, but addressing them would make implementation smoother. Should we work on these?"
+
+**Minor Issues:**
+"Here are some minor suggestions for improvement:
+
+{{minor_issue_description}}
+
+These are optional refinements. Would you like to address any of these?"
+
+### 6. Generate Validation Content
+
+Prepare the content to append to the document:
+
+#### Content Structure:
+
+```markdown
+## Architecture Validation Results
+
+### Coherence Validation ✅
+
+**Decision Compatibility:**
+{{assessment_of_how_all_decisions_work_together}}
+
+**Pattern Consistency:**
+{{verification_that_patterns_support_decisions}}
+
+**Structure Alignment:**
+{{confirmation_that_structure_supports_architecture}}
+
+### Requirements Coverage Validation ✅
+
+**Epic/Feature Coverage:**
+{{verification_that_all_epics_or_features_are_supported}}
+
+**Functional Requirements Coverage:**
+{{confirmation_that_all_FRs_are_architecturally_supported}}
+
+**Non-Functional Requirements Coverage:**
+{{verification_that_NFRs_are_addressed}}
+
+### Implementation Readiness Validation ✅
+
+**Decision Completeness:**
+{{assessment_of_decision_documentation_completeness}}
+
+**Structure Completeness:**
+{{evaluation_of_project_structure_completeness}}
+
+**Pattern Completeness:**
+{{verification_of_implementation_patterns_completeness}}
+
+### Gap Analysis Results
+
+{{gap_analysis_findings_with_priority_levels}}
+
+### Validation Issues Addressed
+
+{{description_of_any_issues_found_and_resolutions}}
+
+### Architecture Completeness Checklist
+
+**✅ Requirements Analysis**
+
+- [x] Project context thoroughly analyzed
+- [x] Scale and complexity assessed
+- [x] Technical constraints identified
+- [x] Cross-cutting concerns mapped
+
+**✅ Architectural Decisions**
+
+- [x] Critical decisions documented with versions
+- [x] Technology stack fully specified
+- [x] Integration patterns defined
+- [x] Performance considerations addressed
+
+**✅ Implementation Patterns**
+
+- [x] Naming conventions established
+- [x] Structure patterns defined
+- [x] Communication patterns specified
+- [x] Process patterns documented
+
+**✅ Project Structure**
+
+- [x] Complete directory structure defined
+- [x] Component boundaries established
+- [x] Integration points mapped
+- [x] Requirements to structure mapping complete
+
+### Architecture Readiness Assessment
+
+**Overall Status:** READY FOR IMPLEMENTATION
+
+**Confidence Level:** {{high/medium/low}} based on validation results
+
+**Key Strengths:**
+{{list_of_architecture_strengths}}
+
+**Areas for Future Enhancement:**
+{{areas_that_could_be_improved_later}}
+
+### Implementation Handoff
+
+**AI Agent Guidelines:**
+
+- Follow all architectural decisions exactly as documented
+- Use implementation patterns consistently across all components
+- Respect project structure and boundaries
+- Refer to this document for all architectural questions
+
+**First Implementation Priority:**
+{{starter_template_command_or_first_architectural_step}}
+```
+
+### 7. Present Content and Menu
+
+Show the validation results and present choices:
+
+"I've completed a comprehensive validation of your architecture.
+
+**Validation Summary:**
+
+- ✅ Coherence: All decisions work together
+- ✅ Coverage: All requirements are supported
+- ✅ Readiness: AI agents can implement consistently
+
+**Here's what I'll add to complete the architecture document:**
+
+[Show the complete markdown content from step 6]
+
+**What would you like to do?**
+[A] Advanced Elicitation - Address any complex architectural concerns
+[P] Party Mode - Review validation from different implementation perspectives
+[C] Continue - Complete the architecture and finish workflow"
+
+### 8. Handle Menu Selection
+
+#### If 'A' (Advanced Elicitation):
+
+- Execute {project-root}/{xiaoma_folder}/core/tasks/advanced-elicitation.xml with validation issues
+- Process enhanced solutions for complex concerns
+- Ask user: "Accept these architectural improvements? (y/n)"
+- If yes: Update content, then return to A/P/C menu
+- If no: Keep original content, then return to A/P/C menu
+
+#### If 'P' (Party Mode):
+
+- Execute {project-root}/{xiaoma_folder}/core/workflows/party-mode/workflow.md with validation context
+- Process collaborative insights on implementation readiness
+- Ask user: "Accept these changes to the validation results? (y/n)"
+- If yes: Update content, then return to A/P/C menu
+- If no: Keep original content, then return to A/P/C menu
+
+#### If 'C' (Continue):
+
+- Append the final content to `{output_folder}/architecture.md`
+- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]`
+- Load `./step-08-complete.md`
+
+## APPEND TO DOCUMENT:
+
+When user selects 'C', append the content directly to the document using the structure from step 6.
+
+## SUCCESS METRICS:
+
+✅ All architectural decisions validated for coherence
+✅ Complete requirements coverage verified
+✅ Implementation readiness confirmed
+✅ All gaps identified and addressed
+✅ Comprehensive validation checklist completed
+✅ A/P/C menu presented and handled correctly
+✅ Content properly appended to document when C selected
+
+## FAILURE MODES:
+
+❌ Skipping validation of decision compatibility
+❌ Not verifying all requirements are architecturally supported
+❌ Missing potential implementation conflicts
+❌ Not addressing gaps found during validation
+❌ Providing incomplete validation checklist
+❌ Not presenting A/P/C menu after content generation
+
+❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
+❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
+❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
+
+## NEXT STEP:
+
+After user selects 'C' and content is saved to document, load `./step-08-complete.md` to complete the workflow and provide implementation guidance.
+
+Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved!

package/src/modules/xmc/workflows/3-solutioning/architecture/steps/step-08-complete.md

@@ -0,0 +1,351 @@
+# Step 8: Architecture Completion & Handoff
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without user input
+
+- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
+- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
+- ✅ ALWAYS treat this as collaborative completion between architectural peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on successful workflow completion and implementation handoff
+- 🎯 PROVIDE clear next steps for implementation phase
+- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 🎯 Present completion summary and implementation guidance
+- 📖 Update frontmatter with final workflow state
+- 🚫 NO MORE STEPS - this is the final step
+
+## CONTEXT BOUNDARIES:
+
+- Complete architecture document is finished and validated
+- All architectural decisions, patterns, and structure are documented
+- Focus on successful completion and implementation preparation
+- Provide clear guidance for next steps in the development process
+
+## YOUR TASK:
+
+Complete the architecture workflow, provide a comprehensive completion summary, and guide the user to the next phase of their project development.
+
+## COMPLETION SEQUENCE:
+
+### 1. Present Architecture Completion Summary
+
+Based on user skill level, present the completion:
+
+**For Expert Users:**
+"Architecture workflow complete. {{decision_count}} architectural decisions documented across {{step_count}} steps.
+
+Your architecture is ready for AI agent implementation. All decisions are documented with specific versions and implementation patterns.
+
+Key deliverables:
+
+- Complete architecture decision document
+- Implementation patterns for agent consistency
+- Project structure with all files and directories
+- Validation confirming coherence and completeness
+
+Ready for implementation phase."
+
+**For Intermediate Users:**
+"Excellent! Your architecture for {{project_name}} is now complete and ready for implementation.
+
+**What we accomplished:**
+
+- Made {{decision_count}} key architectural decisions together
+- Established implementation patterns to ensure consistency
+- Created a complete project structure with {{component_count}} main areas
+- Validated that all your requirements are fully supported
+
+**Your architecture document includes:**
+
+- Technology choices with specific versions
+- Clear implementation patterns for AI agents to follow
+- Complete project directory structure
+- Mapping of your requirements to specific files and folders
+
+The architecture is comprehensive and ready to guide consistent implementation."
+
+**For Beginner Users:**
+"Congratulations! Your architecture for {{project_name}} is complete! 🎉
+
+**What this means:**
+Think of this as creating the complete blueprint for your house. We've made all the important decisions about how it will be built, what materials to use, and how everything fits together.
+
+**What we created together:**
+
+- {{decision_count}} architectural decisions (like choosing the foundation, framing, and systems)
+- Clear rules so that multiple builders (AI agents) all work the same way
+- A complete folder structure showing exactly where every file goes
+- Confirmation that everything you want to build is supported by these decisions
+
+**What happens next:**
+AI agents will read this architecture document before building anything. They'll follow all your decisions exactly, which means your app will be built with consistent patterns throughout.
+
+You're ready for the implementation phase!"
+
+### 2. Review Final Document State
+
+Confirm the architecture document is complete:
+
+**Document Structure Verification:**
+
+- Project Context Analysis ✅
+- Starter Template Evaluation ✅
+- Core Architectural Decisions ✅
+- Implementation Patterns & Consistency Rules ✅
+- Project Structure & Boundaries ✅
+- Architecture Validation Results ✅
+
+**Frontmatter Update:**
+
+```yaml
+stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]
+workflowType: 'architecture'
+lastStep: 8
+status: 'complete'
+completedAt: '{{current_date}}'
+```
+
+### 3. Implementation Guidance
+
+Provide specific next steps for implementation:
+
+**Immediate Next Steps:**
+
+1. **Review the complete architecture document** at `{output_folder}/architecture.md`
+2. **Begin with project initialization** using the starter template command documented
+3. **Create first implementation story** for project setup
+4. **Start implementing user stories** following the architectural decisions
+
+**Development Workflow:**
+"AI agents will:
+
+1. Read the architecture document before implementing each story
+2. Follow your technology choices and patterns exactly
+3. Use the project structure we defined
+4. Maintain consistency across all components"
+
+**Quality Assurance:**
+"Your architecture includes:
+
+- Specific technology versions to use
+- Implementation patterns that prevent conflicts
+- Clear project structure and boundaries
+- Validation that all requirements are supported"
+
+### 4. Generate Completion Content
+
+Prepare the final content to append to the document:
+
+#### Content Structure:
+
+```markdown
+## Architecture Completion Summary
+
+### Workflow Completion
+
+**Architecture Decision Workflow:** COMPLETED ✅
+**Total Steps Completed:** 8
+**Date Completed:** {{current_date}}
+**Document Location:** {output_folder}/architecture.md
+
+### Final Architecture Deliverables
+
+**📋 Complete Architecture Document**
+
+- All architectural decisions documented with specific versions
+- Implementation patterns ensuring AI agent consistency
+- Complete project structure with all files and directories
+- Requirements to architecture mapping
+- Validation confirming coherence and completeness
+
+**🏗️ Implementation Ready Foundation**
+
+- {{decision_count}} architectural decisions made
+- {{pattern_count}} implementation patterns defined
+- {{component_count}} architectural components specified
+- {{requirement_count}} requirements fully supported
+
+**📚 AI Agent Implementation Guide**
+
+- Technology stack with verified versions
+- Consistency rules that prevent implementation conflicts
+- Project structure with clear boundaries
+- Integration patterns and communication standards
+
+### Implementation Handoff
+
+**For AI Agents:**
+This architecture document is your complete guide for implementing {{project_name}}. Follow all decisions, patterns, and structures exactly as documented.
+
+**First Implementation Priority:**
+{{starter_template_command_or_initialization_step}}
+
+**Development Sequence:**
+
+1. Initialize project using documented starter template
+2. Set up development environment per architecture
+3. Implement core architectural foundations
+4. Build features following established patterns
+5. Maintain consistency with documented rules
+
+### Quality Assurance Checklist
+
+**✅ Architecture Coherence**
+
+- [x] All decisions work together without conflicts
+- [x] Technology choices are compatible
+- [x] Patterns support the architectural decisions
+- [x] Structure aligns with all choices
+
+**✅ Requirements Coverage**
+
+- [x] All functional requirements are supported
+- [x] All non-functional requirements are addressed
+- [x] Cross-cutting concerns are handled
+- [x] Integration points are defined
+
+**✅ Implementation Readiness**
+
+- [x] Decisions are specific and actionable
+- [x] Patterns prevent agent conflicts
+- [x] Structure is complete and unambiguous
+- [x] Examples are provided for clarity
+
+### Project Success Factors
+
+**🎯 Clear Decision Framework**
+Every technology choice was made collaboratively with clear rationale, ensuring all stakeholders understand the architectural direction.
+
+**🔧 Consistency Guarantee**
+Implementation patterns and rules ensure that multiple AI agents will produce compatible, consistent code that works together seamlessly.
+
+**📋 Complete Coverage**
+All project requirements are architecturally supported, with clear mapping from business needs to technical implementation.
+
+**🏗️ Solid Foundation**
+The chosen starter template and architectural patterns provide a production-ready foundation following current best practices.
+
+---
+
+**Architecture Status:** READY FOR IMPLEMENTATION ✅
+
+**Next Phase:** Begin implementation using the architectural decisions and patterns documented herein.
+
+**Document Maintenance:** Update this architecture when major technical decisions are made during implementation.
+```
+
+### 5. Complete Workflow Finalization
+
+**Save Final Document:**
+
+- Ensure all content is properly appended to `{output_folder}/architecture.md`
+- Update frontmatter with completion status
+- Verify document is complete and coherent
+
+**Workflow Status Update:**
+If not in standalone mode, update workflow status:
+
+- Load `{output_folder}/xmc-workflow-status.yaml`
+- Update workflow_status["create-architecture"] = "{output_folder}/architecture.md"
+- Save file with all structure and comments preserved
+
+### 6. Present Completion to User
+
+"🎉 **Architecture Workflow Complete!**
+
+Your architecture for {{project_name}} is comprehensive, validated, and ready for implementation.
+
+**✅ What's been delivered:**
+
+- Complete architecture document with all decisions and patterns
+- Project structure ready for AI agent implementation
+- Validation confirming everything works together coherently
+- Implementation guidance for the development phase
+
+**📍 Where to find it:**
+`{output_folder}/architecture.md`
+
+**🚀 What's next:**
+
+1. Review your complete architecture document
+2. Begin implementation using the starter template command
+3. Create stories for AI agents to implement following your architectural decisions
+
+Your architecture will ensure consistent, high-quality implementation across all development work. Great job collaborating through these important architectural decisions!
+
+**💡 Optional Enhancement: Project Context File**
+
+Would you like to create a `project_context.md` file? This is a concise, optimized guide for AI agents that captures:
+
+- Critical language and framework rules they might miss
+- Specific patterns and conventions for your project
+- Testing and code quality requirements
+- Anti-patterns and edge cases to avoid
+
+{if_existing_project_context}
+I noticed you already have a project context file. Would you like to update it with your new architectural decisions?
+{else}
+This file helps ensure AI agents implement code consistently with your project's unique requirements and patterns.
+{/if_existing_project_context}
+
+**Create/Update project context?** [Y/N]
+
+**Ready to move to the next phase of your project development?**"
+
+### 7. Handle Project Context Creation Choice
+
+If user responds 'Y' or 'yes' to creating/updating project context:
+
+"Excellent choice! Let me launch the Generate Project Context workflow to create a comprehensive guide for AI agents.
+
+This will help ensure consistent implementation by capturing:
+
+- Language-specific patterns and rules
+- Framework conventions from your architecture
+- Testing and quality standards
+- Anti-patterns to avoid
+
+The workflow will collaborate with you to create an optimized `project_context.md` file that AI agents will read before implementing any code."
+
+**Execute the Generate Project Context workflow:**
+
+- Load and execute: `{project-root}/{xiaoma_folder}/xmc/workflows/generate-project-context/workflow.md`
+- The workflow will handle discovery, generation, and completion of the project context file
+- After completion, return here for final handoff
+
+If user responds 'N' or 'no':
+"Understood! Your architecture is complete and ready for implementation. You can always create a project context file later using the Generate Project Context workflow if needed."
+
+## SUCCESS METRICS:
+
+✅ Complete architecture document delivered with all sections
+✅ All architectural decisions documented and validated
+✅ Implementation patterns and consistency rules finalized
+✅ Project structure complete with all files and directories
+✅ User provided with clear next steps and implementation guidance
+✅ Workflow status properly updated
+✅ User collaboration maintained throughout completion process
+
+## FAILURE MODES:
+
+❌ Not providing clear implementation guidance
+❌ Missing final validation of document completeness
+❌ Not updating workflow status appropriately
+❌ Failing to celebrate the successful completion
+❌ Not providing specific next steps for the user
+❌ Rushing completion without proper summary
+
+❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
+❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
+❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
+
+## WORKFLOW COMPLETE:
+
+This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation.
+
+The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle.