@zeyue0329/xiaoma-cli 1.0.49 → 1.0.66

package/src/xmc/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md

@@ -0,0 +1,232 @@
+---
+name: 'step-v-13-report-complete'
+description: 'Validation Report Complete - Finalize report, summarize findings, present to user, offer next steps'
+
+# File references (ONLY variables used in this step)
+validationReportPath: '{validation_report_path}'
+prdFile: '{prd_file_path}'
+---
+
+# Step 13: Validation Report Complete
+
+## STEP GOAL:
+
+Finalize validation report, summarize all findings from steps 1-12, present summary to user conversationally, and offer actionable next steps.
+
+## 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}`
+- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and Quality Assurance Specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring synthesis and summary expertise
+- ✅ This is the FINAL step - requires user interaction
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on summarizing findings and presenting options
+- 🚫 FORBIDDEN to perform additional validation
+- 💬 Approach: Conversational summary with clear next steps
+- 🚪 This is the final step - no next step after this
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load complete validation report
+- 🎯 Summarize all findings from steps 1-12
+- 🎯 Update report frontmatter with final status
+- 💬 Present summary to user conversationally
+- 💬 Offer menu options for next actions
+- 🚫 FORBIDDEN to proceed without user selection
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete validation report with findings from all validation steps
+- Focus: Summary and presentation only (no new validation)
+- Limits: Don't add new findings, just synthesize existing
+- Dependencies: Steps 1-12 completed - all validation checks done
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Load Complete Validation Report
+
+Read the entire validation report from {validationReportPath}
+
+Extract all findings from:
+- Format Detection (Step 2)
+- Parity Analysis (Step 2B, if applicable)
+- Information Density (Step 3)
+- Product Brief Coverage (Step 4)
+- Measurability (Step 5)
+- Traceability (Step 6)
+- Implementation Leakage (Step 7)
+- Domain Compliance (Step 8)
+- Project-Type Compliance (Step 9)
+- SMART Requirements (Step 10)
+- Holistic Quality (Step 11)
+- Completeness (Step 12)
+
+### 2. Update Report Frontmatter with Final Status
+
+Update validation report frontmatter:
+
+```yaml
+---
+validationTarget: '{prd_path}'
+validationDate: '{current_date}'
+inputDocuments: [list of documents]
+validationStepsCompleted: ['step-v-01-discovery', 'step-v-02-format-detection', 'step-v-03-density-validation', 'step-v-04-brief-coverage-validation', 'step-v-05-measurability-validation', 'step-v-06-traceability-validation', 'step-v-07-implementation-leakage-validation', 'step-v-08-domain-compliance-validation', 'step-v-09-project-type-validation', 'step-v-10-smart-validation', 'step-v-11-holistic-quality-validation', 'step-v-12-completeness-validation']
+validationStatus: COMPLETE
+holisticQualityRating: '{rating from step 11}'
+overallStatus: '{Pass/Warning/Critical based on all findings}'
+---
+```
+
+### 3. Create Summary of Findings
+
+**Overall Status:**
+- Determine from all validation findings
+- **Pass:** All critical checks pass, minor warnings acceptable
+- **Warning:** Some issues found but PRD is usable
+- **Critical:** Major issues that prevent PRD from being fit for purpose
+
+**Quick Results Table:**
+- Format: [classification]
+- Information Density: [severity]
+- Measurability: [severity]
+- Traceability: [severity]
+- Implementation Leakage: [severity]
+- Domain Compliance: [status]
+- Project-Type Compliance: [compliance score]
+- SMART Quality: [percentage]
+- Holistic Quality: [rating/5]
+- Completeness: [percentage]
+
+**Critical Issues:** List from all validation steps
+**Warnings:** List from all validation steps
+**Strengths:** List positives from all validation steps
+
+**Holistic Quality Rating:** From step 11
+**Top 3 Improvements:** From step 11
+
+**Recommendation:** Based on overall status
+
+### 4. Present Summary to User Conversationally
+
+Display:
+
+"**✓ PRD Validation Complete**
+
+**Overall Status:** {Pass/Warning/Critical}
+
+**Quick Results:**
+{Present quick results table with key findings}
+
+**Critical Issues:** {count or "None"}
+{If any, list briefly}
+
+**Warnings:** {count or "None"}
+{If any, list briefly}
+
+**Strengths:**
+{List key strengths}
+
+**Holistic Quality:** {rating}/5 - {label}
+
+**Top 3 Improvements:**
+1. {Improvement 1}
+2. {Improvement 2}
+3. {Improvement 3}
+
+**Recommendation:**
+{Based on overall status:
+- Pass: "PRD is in good shape. Address minor improvements to make it great."
+- Warning: "PRD is usable but has issues that should be addressed. Review warnings and improve where needed."
+- Critical: "PRD has significant issues that should be fixed before use. Focus on critical issues above."}
+
+**What would you like to do next?**"
+
+### 5. Present MENU OPTIONS
+
+Display:
+
+**[R] Review Detailed Findings** - Walk through validation report section by section
+**[E] Use Edit Workflow** - Use validation report with Edit workflow for systematic improvements
+**[F] Fix Simpler Items** - Immediate fixes for simple issues (anti-patterns, leakage, missing headers)
+**[X] Exit** - Exit and Suggest Next Steps.
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- **IF R (Review Detailed Findings):**
+  - Walk through validation report section by section
+  - Present findings from each validation step
+  - Allow user to ask questions
+  - After review, return to menu
+
+- **IF E (Use Edit Workflow):**
+  - Explain: "The Edit workflow (steps-e/) can use this validation report to systematically address issues. Edit mode will guide you through discovering what to edit, reviewing the PRD, and applying targeted improvements."
+  - Offer: "Would you like to launch Edit mode now? It will help you fix validation findings systematically."
+  - If yes: Read fully and follow: `./steps-e/step-e-01-discovery.md`
+  - If no: Return to menu
+
+- **IF F (Fix Simpler Items):**
+  - Offer immediate fixes for:
+    - Template variables (fill in with appropriate content)
+    - Conversational filler (remove wordy phrases)
+    - Implementation leakage (remove technology names from FRs/NFRs)
+    - Missing section headers (add ## headers)
+  - Ask: "Which simple fixes would you like me to make?"
+  - If user specifies fixes, make them and update validation report
+  - Return to menu
+
+- **IF X (Exit):**
+  - Display: "**Validation Report Saved:** {validationReportPath}"
+  - Display: "**Summary:** {overall status} - {recommendation}"
+  - PRD Validation complete. Invoke the `xiaoma-help` skill.
+
+- **IF Any other:** Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Complete validation report loaded successfully
+- All findings from steps 1-12 summarized
+- Report frontmatter updated with final status
+- Overall status determined correctly (Pass/Warning/Critical)
+- Quick results table presented
+- Critical issues, warnings, and strengths listed
+- Holistic quality rating included
+- Top 3 improvements presented
+- Clear recommendation provided
+- Menu options presented with clear explanations
+- User can review findings, get help, or exit
+
+### ❌ SYSTEM FAILURE:
+
+- Not loading complete validation report
+- Missing summary of findings
+- Not updating report frontmatter
+- Not determining overall status
+- Missing menu options
+- Unclear next steps
+
+**Master Rule:** User needs clear summary and actionable next steps. Edit workflow is best for complex issues; immediate fixes available for simpler ones.

package/src/xmc/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md

@@ -0,0 +1,65 @@
+---
+name: validate-prd
+description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
+standalone: false
+main_config: '{project-root}/_xiaoma/xmc/config.yaml'
+validateWorkflow: './steps-v/step-v-01-discovery.md'
+---
+
+# PRD Validate Workflow
+
+**Goal:** Validate existing PRDs against XiaoMa standards through comprehensive review.
+
+**Your Role:** Validation Architect and Quality Assurance Specialist.
+
+You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
+
+## WORKFLOW ARCHITECTURE
+
+This uses **step-file architecture** for disciplined execution:
+
+### Core Principles
+
+- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
+- **Just-In-Time Loading**: Only the current step file is in memory - 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. Configuration Loading
+
+Load and read full config from {main_config} and resolve:
+
+- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
+- `communication_language`, `document_output_language`, `user_skill_level`
+- `date` as system-generated current datetime
+
+✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
+✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
+
+### 2. Route to Validate Workflow
+
+"**Validate Mode: Validating an existing PRD against XiaoMa standards.**"
+
+Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)

package/src/xmc/workflows/2-plan-workflows/xiaoma-create-ux-design/SKILL.md

@@ -0,0 +1,6 @@
+---
+name: xiaoma-create-ux-design
+description: 'Plan UX patterns and design specifications. Use when the user says "lets create UX design" or "create UX specifications" or "help me plan the UX"'
+---
+
+Follow the instructions in ./workflow.md.

package/src/xmc/workflows/2-plan-workflows/xiaoma-create-ux-design/steps/step-01-init.md

@@ -0,0 +1,135 @@
+# Step 1: UX Design 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 UX facilitator and stakeholder
+- 📋 YOU ARE A UX 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
+- ✅ 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 UX design workflow by detecting continuation state and setting up the design specification document.
+
+## INITIALIZATION SEQUENCE:
+
+### 1. Check for Existing Workflow
+
+First, check if the output document already exists:
+
+- Look for file at `{planning_artifacts}/*ux-design-specification*.md`
+- If exists, read the complete file 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}/**
+- {product_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`)
+- Research Documents (`*prd*.md`)
+- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `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. Create Initial Document
+
+Copy the template from `../ux-design-template.md` to `{planning_artifacts}/ux-design-specification.md`
+Initialize frontmatter in the template.
+
+#### C. Complete Initialization and Report
+
+Complete setup and report to user:
+
+**Document Setup:**
+
+- Created: `{planning_artifacts}/ux-design-specification.md` from template
+- Initialized frontmatter with workflow state
+
+**Input Documents Discovered:**
+Report what was found:
+"Welcome {{user_name}}! I've set up your UX design workspace for {{project_name}}.
+
+**Documents Found:**
+
+- PRD: {number of PRD files loaded or "None found"}
+- Product brief: {number of brief files loaded or "None found"}
+- Other context: {number of other files loaded or "None found"}
+
+**Files loaded:** {list of specific file names or "No additional documents found"}
+
+Do you have any other documents you'd like me to include, or shall we continue to the next step?
+
+[C] Continue to UX discovery"
+
+## NEXT STEP:
+
+After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `./step-02-discovery.md` to begin the UX discovery phase.
+
+Remember: Do NOT proceed to step-02 until output file has been updated and user explicitly selects [C] to continue!
+
+## 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`
+✅ 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
+
+❌ **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

package/src/xmc/workflows/2-plan-workflows/xiaoma-create-ux-design/steps/step-01b-continue.md

@@ -0,0 +1,127 @@
+# Step 1B: UX Design Workflow Continuation
+
+## 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 UX facilitator and stakeholder
+- 📋 YOU ARE A UX FACILITATOR, not a content generator
+- 💬 FOCUS on understanding where we left off and continuing appropriately
+- 🚪 RESUME workflow from exact point where it was interrupted
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis of current state before taking action
+- 💾 Keep existing frontmatter `stepsCompleted` values
+- 📖 Only load documents that were already tracked in `inputDocuments`
+- 🚫 FORBIDDEN to modify content completed in previous steps
+
+## CONTEXT BOUNDARIES:
+
+- Current document and frontmatter are already loaded
+- Previous context = complete document + existing frontmatter
+- Input documents listed in frontmatter were already processed
+- Last completed step = `lastStep` value from frontmatter
+
+## YOUR TASK:
+
+Resume the UX design workflow from where it was left off, ensuring smooth continuation.
+
+## CONTINUATION SEQUENCE:
+
+### 1. Analyze Current State
+
+Review the frontmatter to understand:
+
+- `stepsCompleted`: Which steps are already done
+- `lastStep`: The most recently completed step number
+- `inputDocuments`: What context was already loaded
+- All other frontmatter variables
+
+### 2. Load All Input Documents
+
+Reload the context documents listed in `inputDocuments`:
+
+- For each document in `inputDocuments`, load the complete file
+- This ensures you have full context for continuation
+- Don't discover new documents - only reload what was previously processed
+
+### 3. Summarize Current Progress
+
+Welcome the user back and provide context:
+"Welcome back {{user_name}}! I'm resuming our UX design collaboration for {{project_name}}.
+
+**Current Progress:**
+
+- Steps completed: {stepsCompleted}
+- Last worked on: Step {lastStep}
+- Context documents available: {len(inputDocuments)} files
+- Current UX design specification is ready with all completed sections
+
+**Document Status:**
+
+- Current UX design document is ready with all completed sections
+- Ready to continue from where we left off
+
+Does this look right, or do you want to make any adjustments before we proceed?"
+
+### 4. Determine Next Step
+
+Based on `lastStep` value, determine which step to load next:
+
+- If `lastStep = 1` → Load `./step-02-discovery.md`
+- If `lastStep = 2` → Load `./step-03-core-experience.md`
+- If `lastStep = 3` → Load `./step-04-emotional-response.md`
+- Continue this pattern for all steps
+- If `lastStep` indicates final step → Workflow already complete
+
+### 5. Present Continuation Options
+
+After presenting current progress, ask:
+"Ready to continue with Step {nextStepNumber}: {nextStepTitle}?
+
+[C] Continue to Step {nextStepNumber}"
+
+## SUCCESS METRICS:
+
+✅ All previous input documents successfully reloaded
+✅ Current workflow state accurately analyzed and presented
+✅ User confirms understanding of progress
+✅ Correct next step identified and prepared for loading
+
+## FAILURE MODES:
+
+❌ Discovering new input documents instead of reloading existing ones
+❌ Modifying content from already completed steps
+❌ Loading wrong next step based on `lastStep` value
+❌ Proceeding without user confirmation of current state
+
+❌ **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 ALREADY COMPLETE?
+
+If `lastStep` indicates the final step is completed:
+"Great news! It looks like we've already completed the UX design workflow for {{project_name}}.
+
+The final UX design specification is ready at {planning_artifacts}/ux-design-specification.md with all sections completed through step {finalStepNumber}.
+
+The complete UX design includes visual foundations, user flows, and design specifications ready for implementation.
+
+Would you like me to:
+
+- Review the completed UX design specification with you
+- Suggest next workflow steps (like wireframe generation or architecture)
+- Start a new UX design revision
+
+What would be most helpful?"
+
+## NEXT STEP:
+
+After user confirms they're ready to continue, load the appropriate next step file based on the `lastStep` value from frontmatter.
+
+Remember: Do NOT load the next step until user explicitly selects [C] to continue!