@zeyue0329/xiaoma-cli 1.6.4 → 1.7.0

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/steps/step-01-document-discovery.md

@@ -0,0 +1,179 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+---
+
+# Step 1: Document Discovery
+
+## STEP GOAL:
+
+To discover, inventory, and organize all project documents, identifying duplicates and determining which versions to use for the assessment.
+
+## 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 expert Product Manager and Scrum Master
+- ✅ Your focus is on finding organizing and documenting what exists
+- ✅ You identify ambiguities and ask for clarification
+- ✅ Success is measured in clear file inventory and conflict resolution
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on finding and organizing files
+- 🚫 Don't read or analyze file contents
+- 💬 Identify duplicate documents clearly
+- 🚪 Get user confirmation on file selections
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Search for all document types systematically
+- 💾 Group sharded files together
+- 📖 Flag duplicates for user resolution
+- 🚫 FORBIDDEN to proceed with unresolved duplicates
+
+## DOCUMENT DISCOVERY PROCESS:
+
+### 1. Initialize Document Discovery
+
+"Beginning **Document Discovery** to inventory all project files.
+
+I will:
+
+1. Search for all required documents (PRD, Architecture, Epics, UX)
+2. Group sharded documents together
+3. Identify any duplicates (whole + sharded versions)
+4. Present findings for your confirmation"
+
+### 2. Document Search Patterns
+
+Search for each document type using these patterns:
+
+#### A. PRD Documents
+
+- Whole: `{planning_artifacts}/*prd*.md`
+- Sharded: `{planning_artifacts}/*prd*/index.md` and related files
+
+#### B. Architecture Documents
+
+- Whole: `{planning_artifacts}/*architecture*.md`
+- Sharded: `{planning_artifacts}/*architecture*/index.md` and related files
+
+#### C. Epics & Stories Documents
+
+- Whole: `{planning_artifacts}/*epic*.md`
+- Sharded: `{planning_artifacts}/*epic*/index.md` and related files
+
+#### D. UX Design Documents
+
+- Whole: `{planning_artifacts}/*ux*.md`
+- Sharded: `{planning_artifacts}/*ux*/index.md` and related files
+
+### 3. Organize Findings
+
+For each document type found:
+
+```
+## [Document Type] Files Found
+
+**Whole Documents:**
+- [filename.md] ([size], [modified date])
+
+**Sharded Documents:**
+- Folder: [foldername]/
+  - index.md
+  - [other files in folder]
+```
+
+### 4. Identify Critical Issues
+
+#### Duplicates (CRITICAL)
+
+If both whole and sharded versions exist:
+
+```
+⚠️ CRITICAL ISSUE: Duplicate document formats found
+- PRD exists as both whole.md AND prd/ folder
+- YOU MUST choose which version to use
+- Remove or rename the other version to avoid confusion
+```
+
+#### Missing Documents (WARNING)
+
+If required documents not found:
+
+```
+⚠️ WARNING: Required document not found
+- Architecture document not found
+- Will impact assessment completeness
+```
+
+### 5. Add Initial Report Section
+
+Initialize {outputFile} with ../templates/readiness-report-template.md.
+
+### 6. Present Findings and Get Confirmation
+
+Display findings and ask:
+"**Document Discovery Complete**
+
+[Show organized file list]
+
+**Issues Found:**
+
+- [List any duplicates requiring resolution]
+- [List any missing documents]
+
+**Required Actions:**
+
+- If duplicates exist: Please remove/rename one version
+- Confirm which documents to use for assessment
+
+**Ready to proceed?** [C] Continue after resolving issues"
+
+### 7. Present MENU OPTIONS
+
+Display: **Select an Option:** [C] Continue to File Validation
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed with 'C' selection
+- If duplicates identified, insist on resolution first
+- User can clarify file locations or request additional searches
+
+#### Menu Handling Logic:
+
+- IF C: Save document inventory to {outputFile}, update frontmatter with completed step and files being included, and then read fully and follow: ./step-02-prd-analysis.md
+- IF Any other comments or queries: help user respond then redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and document inventory is saved will you load ./step-02-prd-analysis.md to begin file validation.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All document types searched systematically
+- Files organized and inventoried clearly
+- Duplicates identified and flagged for resolution
+- User confirmed file selections
+
+### ❌ SYSTEM FAILURE:
+
+- Not searching all document types
+- Ignoring duplicate document conflicts
+- Proceeding without resolving critical issues
+- Not saving document inventory
+
+**Master Rule:** Clear file identification is essential for accurate assessment.

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/steps/step-02-prd-analysis.md

@@ -0,0 +1,168 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file
+---
+
+# Step 2: PRD Analysis
+
+## STEP GOAL:
+
+To fully read and analyze the PRD document (whole or sharded) to extract all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for validation against epics coverage.
+
+## 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 expert Product Manager and Scrum Master
+- ✅ Your expertise is in requirements analysis and traceability
+- ✅ You think critically about requirement completeness
+- ✅ Success is measured in thorough requirement extraction
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on reading and extracting from PRD
+- 🚫 Don't validate files (done in step 1)
+- 💬 Read PRD completely - whole or all sharded files
+- 🚪 Extract every FR and NFR with numbering
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load and completely read the PRD
+- 💾 Extract all requirements systematically
+- 📖 Document findings in the report
+- 🚫 FORBIDDEN to skip or summarize PRD content
+
+## PRD ANALYSIS PROCESS:
+
+### 1. Initialize PRD Analysis
+
+"Beginning **PRD Analysis** to extract all requirements.
+
+I will:
+
+1. Load the PRD document (whole or sharded)
+2. Read it completely and thoroughly
+3. Extract ALL Functional Requirements (FRs)
+4. Extract ALL Non-Functional Requirements (NFRs)
+5. Document findings for coverage validation"
+
+### 2. Load and Read PRD
+
+From the document inventory in step 1:
+
+- If whole PRD file exists: Load and read it completely
+- If sharded PRD exists: Load and read ALL files in the PRD folder
+- Ensure complete coverage - no files skipped
+
+### 3. Extract Functional Requirements (FRs)
+
+Search for and extract:
+
+- Numbered FRs (FR1, FR2, FR3, etc.)
+- Requirements labeled "Functional Requirement"
+- User stories or use cases that represent functional needs
+- Business rules that must be implemented
+
+Format findings as:
+
+```
+## Functional Requirements Extracted
+
+FR1: [Complete requirement text]
+FR2: [Complete requirement text]
+FR3: [Complete requirement text]
+...
+Total FRs: [count]
+```
+
+### 4. Extract Non-Functional Requirements (NFRs)
+
+Search for and extract:
+
+- Performance requirements (response times, throughput)
+- Security requirements (authentication, encryption, etc.)
+- Usability requirements (accessibility, ease of use)
+- Reliability requirements (uptime, error rates)
+- Scalability requirements (concurrent users, data growth)
+- Compliance requirements (standards, regulations)
+
+Format findings as:
+
+```
+## Non-Functional Requirements Extracted
+
+NFR1: [Performance requirement]
+NFR2: [Security requirement]
+NFR3: [Usability requirement]
+...
+Total NFRs: [count]
+```
+
+### 5. Document Additional Requirements
+
+Look for:
+
+- Constraints or assumptions
+- Technical requirements not labeled as FR/NFR
+- Business constraints
+- Integration requirements
+
+### 6. Add to Assessment Report
+
+Append to {outputFile}:
+
+```markdown
+## PRD Analysis
+
+### Functional Requirements
+
+[Complete FR list from section 3]
+
+### Non-Functional Requirements
+
+[Complete NFR list from section 4]
+
+### Additional Requirements
+
+[Any other requirements or constraints found]
+
+### PRD Completeness Assessment
+
+[Initial assessment of PRD completeness and clarity]
+```
+
+### 7. Auto-Proceed to Next Step
+
+After PRD analysis complete, immediately load next step for epic coverage validation.
+
+## PROCEEDING TO EPIC COVERAGE VALIDATION
+
+PRD analysis complete. Read fully and follow: `./step-03-epic-coverage-validation.md`
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- PRD loaded and read completely
+- All FRs extracted with full text
+- All NFRs identified and documented
+- Findings added to assessment report
+
+### ❌ SYSTEM FAILURE:
+
+- Not reading complete PRD (especially sharded versions)
+- Missing requirements in extraction
+- Summarizing instead of extracting full text
+- Not documenting findings in report
+
+**Master Rule:** Complete requirement extraction is essential for traceability validation.

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/steps/step-03-epic-coverage-validation.md

@@ -0,0 +1,169 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+---
+
+# Step 3: Epic Coverage Validation
+
+## STEP GOAL:
+
+To validate that all Functional Requirements from the PRD are captured in the epics and stories document, identifying any gaps in coverage.
+
+## 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 expert Product Manager and Scrum Master
+- ✅ Your expertise is in requirements traceability
+- ✅ You ensure no requirements fall through the cracks
+- ✅ Success is measured in complete FR coverage
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on FR coverage validation
+- 🚫 Don't analyze story quality (that's later)
+- 💬 Compare PRD FRs against epic coverage list
+- 🚪 Document every missing FR
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load epics document completely
+- 💾 Extract FR coverage from epics
+- 📖 Compare against PRD FR list
+- 🚫 FORBIDDEN to proceed without documenting gaps
+
+## EPIC COVERAGE VALIDATION PROCESS:
+
+### 1. Initialize Coverage Validation
+
+"Beginning **Epic Coverage Validation**.
+
+I will:
+
+1. Load the epics and stories document
+2. Extract FR coverage information
+3. Compare against PRD FRs from previous step
+4. Identify any FRs not covered in epics"
+
+### 2. Load Epics Document
+
+From the document inventory in step 1:
+
+- Load the epics and stories document (whole or sharded)
+- Read it completely to find FR coverage information
+- Look for sections like "FR Coverage Map" or similar
+
+### 3. Extract Epic FR Coverage
+
+From the epics document:
+
+- Find FR coverage mapping or list
+- Extract which FR numbers are claimed to be covered
+- Document which epics cover which FRs
+
+Format as:
+
+```
+## Epic FR Coverage Extracted
+
+FR1: Covered in Epic X
+FR2: Covered in Epic Y
+FR3: Covered in Epic Z
+...
+Total FRs in epics: [count]
+```
+
+### 4. Compare Coverage Against PRD
+
+Using the PRD FR list from step 2:
+
+- Check each PRD FR against epic coverage
+- Identify FRs NOT covered in epics
+- Note any FRs in epics but NOT in PRD
+
+Create coverage matrix:
+
+```
+## FR Coverage Analysis
+
+| FR Number | PRD Requirement | Epic Coverage  | Status    |
+| --------- | --------------- | -------------- | --------- |
+| FR1       | [PRD text]      | Epic X Story Y | ✓ Covered |
+| FR2       | [PRD text]      | **NOT FOUND**  | ❌ MISSING |
+| FR3       | [PRD text]      | Epic Z Story A | ✓ Covered |
+```
+
+### 5. Document Missing Coverage
+
+List all FRs not covered:
+
+```
+## Missing FR Coverage
+
+### Critical Missing FRs
+
+FR#: [Full requirement text from PRD]
+- Impact: [Why this is critical]
+- Recommendation: [Which epic should include this]
+
+### High Priority Missing FRs
+
+[List any other uncovered FRs]
+```
+
+### 6. Add to Assessment Report
+
+Append to {outputFile}:
+
+```markdown
+## Epic Coverage Validation
+
+### Coverage Matrix
+
+[Complete coverage matrix from section 4]
+
+### Missing Requirements
+
+[List of uncovered FRs from section 5]
+
+### Coverage Statistics
+
+- Total PRD FRs: [count]
+- FRs covered in epics: [count]
+- Coverage percentage: [percentage]
+```
+
+### 7. Auto-Proceed to Next Step
+
+After coverage validation complete, immediately load next step.
+
+## PROCEEDING TO UX ALIGNMENT
+
+Epic coverage validation complete. Read fully and follow: `./step-04-ux-alignment.md`
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Epics document loaded completely
+- FR coverage extracted accurately
+- All gaps identified and documented
+- Coverage matrix created
+
+### ❌ SYSTEM FAILURE:
+
+- Not reading complete epics document
+- Missing FRs in comparison
+- Not documenting uncovered requirements
+- Incomplete coverage analysis
+
+**Master Rule:** Every FR must have a traceable implementation path.

package/src/xmc/workflows/3-solutioning/xiaoma-check-implementation-readiness/steps/step-04-ux-alignment.md

@@ -0,0 +1,129 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+---
+
+# Step 4: UX Alignment
+
+## STEP GOAL:
+
+To check if UX documentation exists and validate that it aligns with PRD requirements and Architecture decisions, ensuring architecture accounts for both PRD and UX needs.
+
+## 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 UX VALIDATOR ensuring user experience is properly addressed
+- ✅ UX requirements must be supported by architecture
+- ✅ Missing UX documentation is a warning if UI is implied
+- ✅ Alignment gaps must be documented
+
+### Step-Specific Rules:
+
+- 🎯 Check for UX document existence first
+- 🚫 Don't assume UX is not needed
+- 💬 Validate alignment between UX, PRD, and Architecture
+- 🚪 Add findings to the output report
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Search for UX documentation
+- 💾 If found, validate alignment
+- 📖 If not found, assess if UX is implied
+- 🚫 FORBIDDEN to proceed without completing assessment
+
+## UX ALIGNMENT PROCESS:
+
+### 1. Initialize UX Validation
+
+"Beginning **UX Alignment** validation.
+
+I will:
+
+1. Check if UX documentation exists
+2. If UX exists: validate alignment with PRD and Architecture
+3. If no UX: determine if UX is implied and document warning"
+
+### 2. Search for UX Documentation
+
+Search patterns:
+
+- `{planning_artifacts}/*ux*.md` (whole document)
+- `{planning_artifacts}/*ux*/index.md` (sharded)
+- Look for UI-related terms in other documents
+
+### 3. If UX Document Exists
+
+#### A. UX ↔ PRD Alignment
+
+- Check UX requirements reflected in PRD
+- Verify user journeys in UX match PRD use cases
+- Identify UX requirements not in PRD
+
+#### B. UX ↔ Architecture Alignment
+
+- Verify architecture supports UX requirements
+- Check performance needs (responsiveness, load times)
+- Identify UI components not supported by architecture
+
+### 4. If No UX Document
+
+Assess if UX/UI is implied:
+
+- Does PRD mention user interface?
+- Are there web/mobile components implied?
+- Is this a user-facing application?
+
+If UX implied but missing: Add warning to report
+
+### 5. Add Findings to Report
+
+Append to {outputFile}:
+
+```markdown
+## UX Alignment Assessment
+
+### UX Document Status
+
+[Found/Not Found]
+
+### Alignment Issues
+
+[List any misalignments between UX, PRD, and Architecture]
+
+### Warnings
+
+[Any warnings about missing UX or architectural gaps]
+```
+
+### 6. Auto-Proceed to Next Step
+
+After UX assessment complete, immediately load next step.
+
+## PROCEEDING TO EPIC QUALITY REVIEW
+
+UX alignment assessment complete. Read fully and follow: `./step-05-epic-quality-review.md`
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- UX document existence checked
+- Alignment validated if UX exists
+- Warning issued if UX implied but missing
+- Findings added to report
+
+### ❌ SYSTEM FAILURE:
+
+- Not checking for UX document
+- Ignoring alignment issues
+- Not documenting warnings