@zeyue0329/xiaoma-cli 1.6.4 → 1.7.0

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/steps-v/step-v-12-completeness-validation.md

@@ -0,0 +1,242 @@
+---
+name: 'step-v-12-completeness-validation'
+description: 'Completeness Check - Final comprehensive completeness check before report generation'
+
+# File references (ONLY variables used in this step)
+nextStepFile: './step-v-13-report-complete.md'
+prdFile: '{prd_file_path}'
+prdFrontmatter: '{prd_frontmatter}'
+validationReportPath: '{validation_report_path}'
+---
+
+# Step 12: Completeness Validation
+
+## STEP GOAL:
+
+Final comprehensive completeness check - validate no template variables remain, each section has required content, section-specific completeness, and frontmatter is properly populated.
+
+## 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 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 systematic validation, not collaborative dialogue
+- ✅ You bring attention to detail and completeness verification
+- ✅ This step runs autonomously - no user input needed
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on completeness verification
+- 🚫 FORBIDDEN to validate quality (done in step 11) or other aspects
+- 💬 Approach: Systematic checklist-style verification
+- 🚪 This is a validation sequence step - auto-proceeds when complete
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Check template completeness (no variables remaining)
+- 🎯 Validate content completeness (each section has required content)
+- 🎯 Validate section-specific completeness
+- 🎯 Validate frontmatter completeness
+- 💾 Append completeness matrix to validation report
+- 📖 Display "Proceeding to final step..." and load next step
+- 🚫 FORBIDDEN to pause or request user input
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete PRD file, frontmatter, validation report
+- Focus: Completeness verification only (final gate)
+- Limits: Don't assess quality, don't pause for user input
+- Dependencies: Steps 1-11 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. Attempt Sub-Process Validation
+
+**Try to use Task tool to spawn a subprocess:**
+
+"Perform completeness validation on this PRD - final gate check:
+
+**1. Template Completeness:**
+- Scan PRD for any remaining template variables
+- Look for: {variable}, {{variable}}, {placeholder}, [placeholder], etc.
+- List any found with line numbers
+
+**2. Content Completeness:**
+- Executive Summary: Has vision statement? ({key content})
+- Success Criteria: All criteria measurable? ({metrics present})
+- Product Scope: In-scope and out-of-scope defined? ({both present})
+- User Journeys: User types identified? ({users listed})
+- Functional Requirements: FRs listed with proper format? ({FRs present})
+- Non-Functional Requirements: NFRs with metrics? ({NFRs present})
+
+For each section: Is required content present? (Yes/No/Partial)
+
+**3. Section-Specific Completeness:**
+- Success Criteria: Each has specific measurement method?
+- User Journeys: Cover all user types?
+- Functional Requirements: Cover MVP scope?
+- Non-Functional Requirements: Each has specific criteria?
+
+**4. Frontmatter Completeness:**
+- stepsCompleted: Populated?
+- classification: Present (domain, projectType)?
+- inputDocuments: Tracked?
+- date: Present?
+
+Return completeness matrix with status for each check."
+
+**Graceful degradation (if no Task tool):**
+- Manually scan for template variables
+- Manually check each section for required content
+- Manually verify frontmatter fields
+- Build completeness matrix
+
+### 2. Build Completeness Matrix
+
+**Template Completeness:**
+- Template variables found: count
+- List if any found
+
+**Content Completeness by Section:**
+- Executive Summary: Complete / Incomplete / Missing
+- Success Criteria: Complete / Incomplete / Missing
+- Product Scope: Complete / Incomplete / Missing
+- User Journeys: Complete / Incomplete / Missing
+- Functional Requirements: Complete / Incomplete / Missing
+- Non-Functional Requirements: Complete / Incomplete / Missing
+- Other sections: [List completeness]
+
+**Section-Specific Completeness:**
+- Success criteria measurable: All / Some / None
+- Journeys cover all users: Yes / Partial / No
+- FRs cover MVP scope: Yes / Partial / No
+- NFRs have specific criteria: All / Some / None
+
+**Frontmatter Completeness:**
+- stepsCompleted: Present / Missing
+- classification: Present / Missing
+- inputDocuments: Present / Missing
+- date: Present / Missing
+
+**Overall completeness:**
+- Sections complete: X/Y
+- Critical gaps: [list if any]
+
+### 3. Report Completeness Findings to Validation Report
+
+Append to validation report:
+
+```markdown
+## Completeness Validation
+
+### Template Completeness
+
+**Template Variables Found:** {count}
+{If count > 0, list variables with line numbers}
+{If count = 0, note: No template variables remaining ✓}
+
+### Content Completeness by Section
+
+**Executive Summary:** [Complete/Incomplete/Missing]
+{If incomplete or missing, note specific gaps}
+
+**Success Criteria:** [Complete/Incomplete/Missing]
+{If incomplete or missing, note specific gaps}
+
+**Product Scope:** [Complete/Incomplete/Missing]
+{If incomplete or missing, note specific gaps}
+
+**User Journeys:** [Complete/Incomplete/Missing]
+{If incomplete or missing, note specific gaps}
+
+**Functional Requirements:** [Complete/Incomplete/Missing]
+{If incomplete or missing, note specific gaps}
+
+**Non-Functional Requirements:** [Complete/Incomplete/Missing]
+{If incomplete or missing, note specific gaps}
+
+### Section-Specific Completeness
+
+**Success Criteria Measurability:** [All/Some/None] measurable
+{If Some or None, note which criteria lack metrics}
+
+**User Journeys Coverage:** [Yes/Partial/No] - covers all user types
+{If Partial or No, note missing user types}
+
+**FRs Cover MVP Scope:** [Yes/Partial/No]
+{If Partial or No, note scope gaps}
+
+**NFRs Have Specific Criteria:** [All/Some/None]
+{If Some or None, note which NFRs lack specificity}
+
+### Frontmatter Completeness
+
+**stepsCompleted:** [Present/Missing]
+**classification:** [Present/Missing]
+**inputDocuments:** [Present/Missing]
+**date:** [Present/Missing]
+
+**Frontmatter Completeness:** {complete_fields}/4
+
+### Completeness Summary
+
+**Overall Completeness:** {percentage}% ({complete_sections}/{total_sections})
+
+**Critical Gaps:** [count] [list if any]
+**Minor Gaps:** [count] [list if any]
+
+**Severity:** [Critical if template variables exist or critical sections missing, Warning if minor gaps, Pass if complete]
+
+**Recommendation:**
+[If Critical] "PRD has completeness gaps that must be addressed before use. Fix template variables and complete missing sections."
+[If Warning] "PRD has minor completeness gaps. Address minor gaps for complete documentation."
+[If Pass] "PRD is complete with all required sections and content present."
+```
+
+### 4. Display Progress and Auto-Proceed
+
+Display: "**Completeness Validation Complete**
+
+Overall Completeness: {percentage}% ({severity})
+
+**Proceeding to final step...**"
+
+Without delay, read fully and follow: {nextStepFile} (step-v-13-report-complete.md)
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Scanned for template variables systematically
+- Validated each section for required content
+- Validated section-specific completeness (measurability, coverage, scope)
+- Validated frontmatter completeness
+- Completeness matrix built with all checks
+- Severity assessed correctly
+- Findings reported to validation report
+- Auto-proceeds to final step
+- Subprocess attempted with graceful degradation
+
+### ❌ SYSTEM FAILURE:
+
+- Not scanning for template variables
+- Missing section-specific completeness checks
+- Not validating frontmatter
+- Not building completeness matrix
+- Not reporting findings to validation report
+- Not auto-proceeding
+
+**Master Rule:** Final gate to ensure document is complete before presenting findings. Template variables or critical gaps must be fixed.

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-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/xiaoma-validate-prd/workflow.md

@@ -0,0 +1,62 @@
+---
+main_config: '{project-root}/_xiaoma/xmc/config.yaml'
+validateWorkflow: './steps-v/step-v-01-discovery.md'
+---
+
+# PRD Validate Workflow
+
+**Goal:** Validate existing PRDs against BMAD 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 BMAD standards.**"
+
+Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/xiaoma-skill-manifest.yaml

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

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

@@ -0,0 +1,6 @@
+---
+name: xiaoma-check-implementation-readiness
+description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
+---
+
+Follow the instructions in [workflow.md](workflow.md).

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

@@ -0,0 +1,6 @@
+---
+name: bmad-check-implementation-readiness
+description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
+---
+
+Follow the instructions in [workflow.md](workflow.md).