@zeyue0329/xiaoma-cli 1.0.48 → 1.0.66

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/steps-v/step-v-02-format-detection.md

@@ -0,0 +1,188 @@
+---
+# File references (ONLY variables used in this step)
+nextStepFile: './step-v-03-density-validation.md'
+altStepFile: './step-v-02b-parity-check.md'
+prdFile: '{prd_file_path}'
+validationReportPath: '{validation_report_path}'
+---
+
+# Step 2: Format Detection & Structure Analysis
+
+## STEP GOAL:
+
+Detect if PRD follows XiaoMa format and route appropriately - classify as XiaoMa Standard / XiaoMa Variant / Non-Standard, with optional parity check for non-standard formats.
+
+## 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 collaborative dialogue, not command-response
+- ✅ You bring systematic validation expertise and pattern recognition
+- ✅ User brings domain knowledge and PRD context
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on detecting format and classifying structure
+- 🚫 FORBIDDEN to perform other validation checks in this step
+- 💬 Approach: Analytical and systematic, clear reporting of findings
+- 🚪 This is a branch step - may route to parity check for non-standard PRDs
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Analyze PRD structure systematically
+- 💾 Append format findings to validation report
+- 📖 Route appropriately based on format classification
+- 🚫 FORBIDDEN to skip format detection or proceed without classification
+
+## CONTEXT BOUNDARIES:
+
+- Available context: PRD file loaded in step 1, validation report initialized
+- Focus: Format detection and classification only
+- Limits: Don't perform other validation, don't skip classification
+- Dependencies: Step 1 completed - PRD loaded and report initialized
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Extract PRD Structure
+
+Load the complete PRD file and extract:
+
+**All Level 2 (##) headers:**
+- Scan through entire PRD document
+- Extract all ## section headers
+- List them in order
+
+**PRD frontmatter:**
+- Extract classification.domain if present
+- Extract classification.projectType if present
+- Note any other relevant metadata
+
+### 2. Check for XiaoMa PRD Core Sections
+
+Check if the PRD contains the following XiaoMa PRD core sections:
+
+1. **Executive Summary** (or variations: ## Executive Summary, ## Overview, ## Introduction)
+2. **Success Criteria** (or: ## Success Criteria, ## Goals, ## Objectives)
+3. **Product Scope** (or: ## Product Scope, ## Scope, ## In Scope, ## Out of Scope)
+4. **User Journeys** (or: ## User Journeys, ## User Stories, ## User Flows)
+5. **Functional Requirements** (or: ## Functional Requirements, ## Features, ## Capabilities)
+6. **Non-Functional Requirements** (or: ## Non-Functional Requirements, ## NFRs, ## Quality Attributes)
+
+**Count matches:**
+- How many of these 6 core sections are present?
+- Which specific sections are present?
+- Which are missing?
+
+### 3. Classify PRD Format
+
+Based on core section count, classify:
+
+**XiaoMa Standard:**
+- 5-6 core sections present
+- Follows XiaoMa PRD structure closely
+
+**XiaoMa Variant:**
+- 3-4 core sections present
+- Generally follows XiaoMa patterns but may have structural differences
+- Missing some sections but recognizable as XiaoMa-style
+
+**Non-Standard:**
+- Fewer than 3 core sections present
+- Does not follow XiaoMa PRD structure
+- May be completely custom format, legacy format, or from another framework
+
+### 4. Report Format Findings to Validation Report
+
+Append to validation report:
+
+```markdown
+## Format Detection
+
+**PRD Structure:**
+[List all ## Level 2 headers found]
+
+**XiaoMa Core Sections Present:**
+- Executive Summary: [Present/Missing]
+- Success Criteria: [Present/Missing]
+- Product Scope: [Present/Missing]
+- User Journeys: [Present/Missing]
+- Functional Requirements: [Present/Missing]
+- Non-Functional Requirements: [Present/Missing]
+
+**Format Classification:** [XiaoMa Standard / XiaoMa Variant / Non-Standard]
+**Core Sections Present:** [count]/6
+```
+
+### 5. Route Based on Format Classification
+
+**IF format is XiaoMa Standard or XiaoMa Variant:**
+
+Display: "**Format Detected:** {classification}
+
+Proceeding to systematic validation checks..."
+
+Without delay, read fully and follow: {nextStepFile} (step-v-03-density-validation.md)
+
+**IF format is Non-Standard (< 3 core sections):**
+
+Display: "**Format Detected:** Non-Standard PRD
+
+This PRD does not follow XiaoMa standard structure (only {count}/6 core sections present).
+
+You have options:"
+
+Present MENU OPTIONS below for user selection
+
+### 6. Present MENU OPTIONS (Non-Standard PRDs Only)
+
+**[A] Parity Check** - Analyze gaps and estimate effort to reach XiaoMa PRD parity
+**[B] Validate As-Is** - Proceed with validation using current structure
+**[C] Exit** - Exit validation and review format findings
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- IF A (Parity Check): Read fully and follow: {altStepFile} (step-v-02b-parity-check.md)
+- IF B (Validate As-Is): Display "Proceeding with validation..." then read fully and follow: {nextStepFile}
+- IF C (Exit): Display format findings summary and exit validation
+- IF Any other: help user respond, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All ## Level 2 headers extracted successfully
+- XiaoMa core sections checked systematically
+- Format classified correctly based on section count
+- Findings reported to validation report
+- XiaoMa Standard/Variant PRDs proceed directly to next validation step
+- Non-Standard PRDs pause and present options to user
+- User can choose parity check, validate as-is, or exit
+
+### ❌ SYSTEM FAILURE:
+
+- Not extracting all headers before classification
+- Incorrect format classification
+- Not reporting findings to validation report
+- Not pausing for non-standard PRDs
+- Proceeding without user decision for non-standard formats
+
+**Master Rule:** Format detection determines validation path. Non-standard PRDs require user choice before proceeding.

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/steps-v/step-v-02b-parity-check.md

@@ -0,0 +1,206 @@
+---
+# File references (ONLY variables used in this step)
+nextStepFile: './step-v-03-density-validation.md'
+prdFile: '{prd_file_path}'
+validationReportPath: '{validation_report_path}'
+---
+
+# Step 2B: Document Parity Check
+
+## STEP GOAL:
+
+Analyze non-standard PRD and identify gaps to achieve XiaoMa PRD parity, presenting user with options for how to proceed.
+
+## 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 collaborative dialogue, not command-response
+- ✅ You bring XiaoMa PRD standards expertise and gap analysis
+- ✅ User brings domain knowledge and PRD context
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on analyzing gaps and estimating parity effort
+- 🚫 FORBIDDEN to perform other validation checks in this step
+- 💬 Approach: Systematic gap analysis with clear recommendations
+- 🚪 This is an optional branch step - user chooses next action
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Analyze each XiaoMa PRD section for gaps
+- 💾 Append parity analysis to validation report
+- 📖 Present options and await user decision
+- 🚫 FORBIDDEN to proceed without user selection
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Non-standard PRD from step 2, validation report in progress
+- Focus: Parity analysis only - what's missing, what's needed
+- Limits: Don't perform validation checks, don't auto-proceed
+- Dependencies: Step 2 classified PRD as non-standard and user chose parity check
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Analyze Each XiaoMa PRD Section
+
+For each of the 6 XiaoMa PRD core sections, analyze:
+
+**Executive Summary:**
+- Does PRD have vision/overview?
+- Is problem statement clear?
+- Are target users identified?
+- Gap: [What's missing or incomplete]
+
+**Success Criteria:**
+- Are measurable goals defined?
+- Is success clearly defined?
+- Gap: [What's missing or incomplete]
+
+**Product Scope:**
+- Is scope clearly defined?
+- Are in-scope items listed?
+- Are out-of-scope items listed?
+- Gap: [What's missing or incomplete]
+
+**User Journeys:**
+- Are user types/personas identified?
+- Are user flows documented?
+- Gap: [What's missing or incomplete]
+
+**Functional Requirements:**
+- Are features/capabilities listed?
+- Are requirements structured?
+- Gap: [What's missing or incomplete]
+
+**Non-Functional Requirements:**
+- Are quality attributes defined?
+- Are performance/security/etc. requirements documented?
+- Gap: [What's missing or incomplete]
+
+### 2. Estimate Effort to Reach Parity
+
+For each missing or incomplete section, estimate:
+
+**Effort Level:**
+- Minimal - Section exists but needs minor enhancements
+- Moderate - Section missing but content exists elsewhere in PRD
+- Significant - Section missing, requires new content creation
+
+**Total Parity Effort:**
+- Based on individual section estimates
+- Classify overall: Quick / Moderate / Substantial effort
+
+### 3. Report Parity Analysis to Validation Report
+
+Append to validation report:
+
+```markdown
+## Parity Analysis (Non-Standard PRD)
+
+### Section-by-Section Gap Analysis
+
+**Executive Summary:**
+- Status: [Present/Missing/Incomplete]
+- Gap: [specific gap description]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Success Criteria:**
+- Status: [Present/Missing/Incomplete]
+- Gap: [specific gap description]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Product Scope:**
+- Status: [Present/Missing/Incomplete]
+- Gap: [specific gap description]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**User Journeys:**
+- Status: [Present/Missing/Incomplete]
+- Gap: [specific gap description]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Functional Requirements:**
+- Status: [Present/Missing/Incomplete]
+- Gap: [specific gap description]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+**Non-Functional Requirements:**
+- Status: [Present/Missing/Incomplete]
+- Gap: [specific gap description]
+- Effort to Complete: [Minimal/Moderate/Significant]
+
+### Overall Parity Assessment
+
+**Overall Effort to Reach XiaoMa Standard:** [Quick/Moderate/Substantial]
+**Recommendation:** [Brief recommendation based on analysis]
+```
+
+### 4. Present Parity Analysis and Options
+
+Display:
+
+"**Parity Analysis Complete**
+
+Your PRD is missing {count} of 6 core XiaoMa PRD sections. The overall effort to reach XiaoMa standard is: **{effort level}**
+
+**Quick Summary:**
+[2-3 sentence summary of key gaps]
+
+**Recommendation:**
+{recommendation from analysis}
+
+**How would you like to proceed?**"
+
+### 5. Present MENU OPTIONS
+
+**[C] Continue Validation** - Proceed with validation using current structure
+**[E] Exit & Review** - Exit validation and review parity report
+**[S] Save & Exit** - Save parity report and exit
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- IF C (Continue): Display "Proceeding with validation..." then read fully and follow: {nextStepFile}
+- IF E (Exit): Display parity summary and exit validation
+- IF S (Save): Confirm saved, display summary, exit
+- IF Any other: help user respond, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All 6 XiaoMa PRD sections analyzed for gaps
+- Effort estimates provided for each gap
+- Overall parity effort assessed correctly
+- Parity analysis reported to validation report
+- Clear summary presented to user
+- User can choose to continue validation, exit, or save report
+
+### ❌ SYSTEM FAILURE:
+
+- Not analyzing all 6 sections systematically
+- Missing effort estimates
+- Not reporting parity analysis to validation report
+- Auto-proceeding without user decision
+- Unclear recommendations
+
+**Master Rule:** Parity check informs user of gaps and effort, but user decides whether to proceed with validation or address gaps first.

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

@@ -0,0 +1,171 @@
+---
+# File references (ONLY variables used in this step)
+nextStepFile: './step-v-04-brief-coverage-validation.md'
+prdFile: '{prd_file_path}'
+validationReportPath: '{validation_report_path}'
+---
+
+# Step 3: Information Density Validation
+
+## STEP GOAL:
+
+Validate PRD meets XiaoMa information density standards by scanning for conversational filler, wordy phrases, and redundant expressions that violate conciseness principles.
+
+## 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 analytical rigor and attention to detail
+- ✅ This step runs autonomously - no user input needed
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on information density anti-patterns
+- 🚫 FORBIDDEN to validate other aspects in this step
+- 💬 Approach: Systematic scanning and categorization
+- 🚪 This is a validation sequence step - auto-proceeds when complete
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Scan PRD for density anti-patterns systematically
+- 💾 Append density findings to validation report
+- 📖 Display "Proceeding to next check..." and load next step
+- 🚫 FORBIDDEN to pause or request user input
+
+## CONTEXT BOUNDARIES:
+
+- Available context: PRD file, validation report with format findings
+- Focus: Information density validation only
+- Limits: Don't validate other aspects, don't pause for user input
+- Dependencies: Step 2 completed - format classification 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 information density validation on this PRD:
+
+1. Load the PRD file
+2. Scan for the following anti-patterns:
+   - Conversational filler phrases (examples: 'The system will allow users to...', 'It is important to note that...', 'In order to')
+   - Wordy phrases (examples: 'Due to the fact that', 'In the event of', 'For the purpose of')
+   - Redundant phrases (examples: 'Future plans', 'Absolutely essential', 'Past history')
+3. Count violations by category with line numbers
+4. Classify severity: Critical (>10 violations), Warning (5-10), Pass (<5)
+
+Return structured findings with counts and examples."
+
+### 2. Graceful Degradation (if Task tool unavailable)
+
+If Task tool unavailable, perform analysis directly:
+
+**Scan for conversational filler patterns:**
+- "The system will allow users to..."
+- "It is important to note that..."
+- "In order to"
+- "For the purpose of"
+- "With regard to"
+- Count occurrences and note line numbers
+
+**Scan for wordy phrases:**
+- "Due to the fact that" (use "because")
+- "In the event of" (use "if")
+- "At this point in time" (use "now")
+- "In a manner that" (use "how")
+- Count occurrences and note line numbers
+
+**Scan for redundant phrases:**
+- "Future plans" (just "plans")
+- "Past history" (just "history")
+- "Absolutely essential" (just "essential")
+- "Completely finish" (just "finish")
+- Count occurrences and note line numbers
+
+### 3. Classify Severity
+
+**Calculate total violations:**
+- Conversational filler count
+- Wordy phrases count
+- Redundant phrases count
+- Total = sum of all categories
+
+**Determine severity:**
+- **Critical:** Total > 10 violations
+- **Warning:** Total 5-10 violations
+- **Pass:** Total < 5 violations
+
+### 4. Report Density Findings to Validation Report
+
+Append to validation report:
+
+```markdown
+## Information Density Validation
+
+**Anti-Pattern Violations:**
+
+**Conversational Filler:** {count} occurrences
+[If count > 0, list examples with line numbers]
+
+**Wordy Phrases:** {count} occurrences
+[If count > 0, list examples with line numbers]
+
+**Redundant Phrases:** {count} occurrences
+[If count > 0, list examples with line numbers]
+
+**Total Violations:** {total}
+
+**Severity Assessment:** [Critical/Warning/Pass]
+
+**Recommendation:**
+[If Critical] "PRD requires significant revision to improve information density. Every sentence should carry weight without filler."
+[If Warning] "PRD would benefit from reducing wordiness and eliminating filler phrases."
+[If Pass] "PRD demonstrates good information density with minimal violations."
+```
+
+### 5. Display Progress and Auto-Proceed
+
+Display: "**Information Density Validation Complete**
+
+Severity: {Critical/Warning/Pass}
+
+**Proceeding to next validation check...**"
+
+Without delay, read fully and follow: {nextStepFile} (step-v-04-brief-coverage-validation.md)
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- PRD scanned for all three anti-pattern categories
+- Violations counted with line numbers
+- Severity classified correctly
+- Findings reported to validation report
+- Auto-proceeds to next validation step
+- Subprocess attempted with graceful degradation
+
+### ❌ SYSTEM FAILURE:
+
+- Not scanning all anti-pattern categories
+- Missing severity classification
+- Not reporting findings to validation report
+- Pausing for user input (should auto-proceed)
+- Not attempting subprocess architecture
+
+**Master Rule:** Information density validation runs autonomously. Scan, classify, report, auto-proceed. No user interaction needed.