@zeyue0329/xiaoma-cli 1.6.4 → 1.7.0

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/steps/step-05-epic-quality-review.md

@@ -0,0 +1,241 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+---
+
+# Step 5: Epic Quality Review
+
+## STEP GOAL:
+
+To validate epics and stories against the best practices defined in create-epics-and-stories workflow, focusing on user value, independence, dependencies, and implementation readiness.
+
+## 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 an EPIC QUALITY ENFORCER
+- ✅ You know what good epics look like - challenge anything deviating
+- ✅ Technical epics are wrong - find them
+- ✅ Forward dependencies are forbidden - catch them
+- ✅ Stories must be independently completable
+
+### Step-Specific Rules:
+
+- 🎯 Apply create-epics-and-stories standards rigorously
+- 🚫 Don't accept "technical milestones" as epics
+- 💬 Challenge every dependency on future work
+- 🚪 Verify proper story sizing and structure
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Systematically validate each epic and story
+- 💾 Document all violations of best practices
+- 📖 Check every dependency relationship
+- 🚫 FORBIDDEN to accept structural problems
+
+## EPIC QUALITY REVIEW PROCESS:
+
+### 1. Initialize Best Practices Validation
+
+"Beginning **Epic Quality Review** against create-epics-and-stories standards.
+
+I will rigorously validate:
+
+- Epics deliver user value (not technical milestones)
+- Epic independence (Epic 2 doesn't need Epic 3)
+- Story dependencies (no forward references)
+- Proper story sizing and completeness
+
+Any deviation from best practices will be flagged as a defect."
+
+### 2. Epic Structure Validation
+
+#### A. User Value Focus Check
+
+For each epic:
+
+- **Epic Title:** Is it user-centric (what user can do)?
+- **Epic Goal:** Does it describe user outcome?
+- **Value Proposition:** Can users benefit from this epic alone?
+
+**Red flags (violations):**
+
+- "Setup Database" or "Create Models" - no user value
+- "API Development" - technical milestone
+- "Infrastructure Setup" - not user-facing
+- "Authentication System" - borderline (is it user value?)
+
+#### B. Epic Independence Validation
+
+Test epic independence:
+
+- **Epic 1:** Must stand alone completely
+- **Epic 2:** Can function using only Epic 1 output
+- **Epic 3:** Can function using Epic 1 & 2 outputs
+- **Rule:** Epic N cannot require Epic N+1 to work
+
+**Document failures:**
+
+- "Epic 2 requires Epic 3 features to function"
+- Stories in Epic 2 referencing Epic 3 components
+- Circular dependencies between epics
+
+### 3. Story Quality Assessment
+
+#### A. Story Sizing Validation
+
+Check each story:
+
+- **Clear User Value:** Does the story deliver something meaningful?
+- **Independent:** Can it be completed without future stories?
+
+**Common violations:**
+
+- "Setup all models" - not a USER story
+- "Create login UI (depends on Story 1.3)" - forward dependency
+
+#### B. Acceptance Criteria Review
+
+For each story's ACs:
+
+- **Given/When/Then Format:** Proper BDD structure?
+- **Testable:** Each AC can be verified independently?
+- **Complete:** Covers all scenarios including errors?
+- **Specific:** Clear expected outcomes?
+
+**Issues to find:**
+
+- Vague criteria like "user can login"
+- Missing error conditions
+- Incomplete happy path
+- Non-measurable outcomes
+
+### 4. Dependency Analysis
+
+#### A. Within-Epic Dependencies
+
+Map story dependencies within each epic:
+
+- Story 1.1 must be completable alone
+- Story 1.2 can use Story 1.1 output
+- Story 1.3 can use Story 1.1 & 1.2 outputs
+
+**Critical violations:**
+
+- "This story depends on Story 1.4"
+- "Wait for future story to work"
+- Stories referencing features not yet implemented
+
+#### B. Database/Entity Creation Timing
+
+Validate database creation approach:
+
+- **Wrong:** Epic 1 Story 1 creates all tables upfront
+- **Right:** Each story creates tables it needs
+- **Check:** Are tables created only when first needed?
+
+### 5. Special Implementation Checks
+
+#### A. Starter Template Requirement
+
+Check if Architecture specifies starter template:
+
+- If YES: Epic 1 Story 1 must be "Set up initial project from starter template"
+- Verify story includes cloning, dependencies, initial configuration
+
+#### B. Greenfield vs Brownfield Indicators
+
+Greenfield projects should have:
+
+- Initial project setup story
+- Development environment configuration
+- CI/CD pipeline setup early
+
+Brownfield projects should have:
+
+- Integration points with existing systems
+- Migration or compatibility stories
+
+### 6. Best Practices Compliance Checklist
+
+For each epic, verify:
+
+- [ ] Epic delivers user value
+- [ ] Epic can function independently
+- [ ] Stories appropriately sized
+- [ ] No forward dependencies
+- [ ] Database tables created when needed
+- [ ] Clear acceptance criteria
+- [ ] Traceability to FRs maintained
+
+### 7. Quality Assessment Documentation
+
+Document all findings by severity:
+
+#### 🔴 Critical Violations
+
+- Technical epics with no user value
+- Forward dependencies breaking independence
+- Epic-sized stories that cannot be completed
+
+#### 🟠 Major Issues
+
+- Vague acceptance criteria
+- Stories requiring future stories
+- Database creation violations
+
+#### 🟡 Minor Concerns
+
+- Formatting inconsistencies
+- Minor structure deviations
+- Documentation gaps
+
+### 8. Autonomous Review Execution
+
+This review runs autonomously to maintain standards:
+
+- Apply best practices without compromise
+- Document every violation with specific examples
+- Provide clear remediation guidance
+- Prepare recommendations for each issue
+
+## REVIEW COMPLETION:
+
+After completing epic quality review:
+
+- Update {outputFile} with all quality findings
+- Document specific best practices violations
+- Provide actionable recommendations
+- Load ./step-06-final-assessment.md for final readiness assessment
+
+## CRITICAL STEP COMPLETION NOTE
+
+This step executes autonomously. Load ./step-06-final-assessment.md only after complete epic quality review is documented.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All epics validated against best practices
+- Every dependency checked and verified
+- Quality violations documented with examples
+- Clear remediation guidance provided
+- No compromise on standards enforcement
+
+### ❌ SYSTEM FAILURE:
+
+- Accepting technical epics as valid
+- Ignoring forward dependencies
+- Not verifying story sizing
+- Overlooking obvious violations
+
+**Master Rule:** Enforce best practices rigorously. Find all violations.

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/steps/step-06-final-assessment.md

@@ -0,0 +1,126 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+---
+
+# Step 6: Final Assessment
+
+## STEP GOAL:
+
+To provide a comprehensive summary of all findings and give the report a final polish, ensuring clear recommendations and overall readiness status.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📖 You are at the final step - complete the assessment
+- 📋 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 delivering the FINAL ASSESSMENT
+- ✅ Your findings are objective and backed by evidence
+- ✅ Provide clear, actionable recommendations
+- ✅ Success is measured by value of findings
+
+### Step-Specific Rules:
+
+- 🎯 Compile and summarize all findings
+- 🚫 Don't soften the message - be direct
+- 💬 Provide specific examples for problems
+- 🚪 Add final section to the report
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Review all findings from previous steps
+- 💾 Add summary and recommendations
+- 📖 Determine overall readiness status
+- 🚫 Complete and present final report
+
+## FINAL ASSESSMENT PROCESS:
+
+### 1. Initialize Final Assessment
+
+"Completing **Final Assessment**.
+
+I will now:
+
+1. Review all findings from previous steps
+2. Provide a comprehensive summary
+3. Add specific recommendations
+4. Determine overall readiness status"
+
+### 2. Review Previous Findings
+
+Check the {outputFile} for sections added by previous steps:
+
+- File and FR Validation findings
+- UX Alignment issues
+- Epic Quality violations
+
+### 3. Add Final Assessment Section
+
+Append to {outputFile}:
+
+```markdown
+## Summary and Recommendations
+
+### Overall Readiness Status
+
+[READY/NEEDS WORK/NOT READY]
+
+### Critical Issues Requiring Immediate Action
+
+[List most critical issues that must be addressed]
+
+### Recommended Next Steps
+
+1. [Specific action item 1]
+2. [Specific action item 2]
+3. [Specific action item 3]
+
+### Final Note
+
+This assessment identified [X] issues across [Y] categories. Address the critical issues before proceeding to implementation. These findings can be used to improve the artifacts or you may choose to proceed as-is.
+```
+
+### 4. Complete the Report
+
+- Ensure all findings are clearly documented
+- Verify recommendations are actionable
+- Add date and assessor information
+- Save the final report
+
+### 5. Present Completion
+
+Display:
+"**Implementation Readiness Assessment Complete**
+
+Report generated: {outputFile}
+
+The assessment found [number] issues requiring attention. Review the detailed report for specific findings and recommendations."
+
+## WORKFLOW COMPLETE
+
+The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
+
+Implementation Readiness complete. Invoke the `xiaoma-help` skill.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All findings compiled and summarized
+- Clear recommendations provided
+- Readiness status determined
+- Final report saved
+
+### ❌ SYSTEM FAILURE:
+
+- Not reviewing previous findings
+- Incomplete summary
+- No clear recommendations

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/workflow.md

@@ -0,0 +1,49 @@
+# Implementation Readiness
+
+**Goal:** Validate that PRD, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning.
+
+**Your Role:** You are an expert Product Manager and Scrum Master, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the users product vision.
+
+## WORKFLOW ARCHITECTURE
+
+### Core Principles
+
+- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
+- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so
+- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
+- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
+- **Append-Only Building**: Build documents by appending content as directed to the output file
+
+### Step Processing Rules
+
+1. **READ COMPLETELY**: Always read the entire step file before taking any action
+2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
+3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
+4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
+5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
+6. **LOAD NEXT**: When directed, read fully and follow the next step file
+
+### Critical Rules (NO EXCEPTIONS)
+
+- 🛑 **NEVER** load multiple step files simultaneously
+- 📖 **ALWAYS** read entire step file before execution
+- 🚫 **NEVER** skip steps or optimize the sequence
+- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
+- 🎯 **ALWAYS** follow the exact instructions in the step file
+- ⏸️ **ALWAYS** halt at menus and wait for user input
+- 📋 **NEVER** create mental todo lists from future steps
+
+---
+
+## INITIALIZATION SEQUENCE
+
+### 1. Module Configuration Loading
+
+Load and read full config from {project-root}/_xiaoma/xmc/config.yaml and resolve:
+
+- `project_name`, `output_folder`, `planning_artifacts`, `user_name`, `communication_language`, `document_output_language`
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### 2. First Step EXECUTION
+
+Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow.

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/xiaoma-skill-manifest.yaml

@@ -0,0 +1 @@
+type: skill

package/src/xmc/workflows/3-solutioning/xiaoma-create-architecture/SKILL.md

@@ -0,0 +1,6 @@
+---
+name: xiaoma-create-architecture
+description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"'
+---
+
+Follow the instructions in [workflow.md](workflow.md).

package/src/xmc/workflows/3-solutioning/xiaoma-create-architecture/SKILL.md.bak

@@ -0,0 +1,6 @@
+---
+name: bmad-create-architecture
+description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"'
+---
+
+Follow the instructions in [workflow.md](workflow.md).

package/src/xmc/workflows/3-solutioning/xiaoma-create-architecture/steps/step-01-init.md

@@ -0,0 +1,153 @@
+# Step 1: Architecture Workflow Initialization
+
+## 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 initialization and setup only - don't look ahead to future steps
+- 🚪 DETECT existing workflow state and handle continuation properly
+- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 💾 Initialize document and update frontmatter
+- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
+- 🚫 FORBIDDEN to load next step until setup is complete
+
+## CONTEXT BOUNDARIES:
+
+- Variables from workflow.md are available in memory
+- Previous context = what's in output document + frontmatter
+- Don't assume knowledge from other steps
+- Input document discovery happens in this step
+
+## YOUR TASK:
+
+Initialize the Architecture workflow by detecting continuation state, discovering input documents, and setting up the document for collaborative architectural decision making.
+
+## INITIALIZATION SEQUENCE:
+
+### 1. Check for Existing Workflow
+
+First, check if the output document already exists:
+
+- Look for existing {planning_artifacts}/`*architecture*.md`
+- If exists, read the complete file(s) including frontmatter
+- If not exists, this is a fresh workflow
+
+### 2. Handle Continuation (If Document Exists)
+
+If the document exists and has frontmatter with `stepsCompleted`:
+
+- **STOP here** and load `./step-01b-continue.md` immediately
+- Do not proceed with any initialization tasks
+- Let step-01b handle the continuation logic
+
+### 3. Fresh Workflow Setup (If No Document)
+
+If no document exists or no `stepsCompleted` in frontmatter:
+
+#### A. Input Document Discovery
+
+Discover and load context documents using smart discovery. Documents can be in the following locations:
+- {planning_artifacts}/**
+- {output_folder}/**
+- {project_knowledge}/**
+- {project-root}/docs/**
+
+Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
+
+Try to discover the following:
+- Product Brief (`*brief*.md`)
+- Product Requirements Document (`*prd*.md`)
+- UX Design (`*ux-design*.md`) and other
+- Research Documents (`*research*.md`)
+- Project Documentation (generally multiple documents might be found for this in the `{project_knowledge}` or `{project-root}/docs` folder.)
+- Project Context (`**/project-context.md`)
+
+<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
+
+**Loading Rules:**
+
+- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
+- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
+- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
+- index.md is a guide to what's relevant whenever available
+- Track all successfully loaded files in frontmatter `inputDocuments` array
+
+#### B. Validate Required Inputs
+
+Before proceeding, verify we have the essential inputs:
+
+**PRD Validation:**
+
+- If no PRD found: "Architecture requires a PRD to work from. Please run the PRD workflow first or provide the PRD file path."
+- Do NOT proceed without PRD
+
+**Other Input that might exist:**
+
+- UX Spec: "Provides UI/UX architectural requirements"
+
+#### C. Create Initial Document
+
+Copy the template from `../architecture-decision-template.md` to `{planning_artifacts}/architecture.md`
+
+#### D. Complete Initialization and Report
+
+Complete setup and report to user:
+
+**Document Setup:**
+
+- Created: `{planning_artifacts}/architecture.md` from template
+- Initialized frontmatter with workflow state
+
+**Input Documents Discovered:**
+Report what was found:
+"Welcome {{user_name}}! I've set up your Architecture workspace for {{project_name}}.
+
+**Documents Found:**
+
+- PRD: {number of PRD files loaded or "None found - REQUIRED"}
+- UX Design: {number of UX files loaded or "None found"}
+- Research: {number of research files loaded or "None found"}
+- Project docs: {number of project files loaded or "None found"}
+- Project context: {project_context_rules count of rules for AI agents found}
+
+**Files loaded:** {list of specific file names or "No additional documents found"}
+
+Ready to begin architectural decision making. Do you have any other documents you'd like me to include?
+
+[C] Continue to project context analysis
+
+## SUCCESS METRICS:
+
+✅ Existing workflow detected and handed off to step-01b correctly
+✅ Fresh workflow initialized with template and frontmatter
+✅ Input documents discovered and loaded using sharded-first logic
+✅ All discovered files tracked in frontmatter `inputDocuments`
+✅ PRD requirement validated and communicated
+✅ User confirmed document setup and can proceed
+
+## FAILURE MODES:
+
+❌ Proceeding with fresh initialization when existing workflow exists
+❌ Not updating frontmatter with discovered input documents
+❌ Creating document without proper template
+❌ Not checking sharded folders first before whole files
+❌ Not reporting what documents were found to user
+❌ Proceeding without validating PRD requirement
+
+❌ **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] to continue, only after ensuring all the template output has been created, then load `./step-02-context.md` to analyze the project context and begin architectural decision making.
+
+Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed!