@zeyue0329/xiaoma-cli 1.6.4 → 1.7.0

package/src/xmc/workflows/2-plan-workflows/xiaoma-edit-prd/steps-e/step-e-03-edit.md

@@ -0,0 +1,254 @@
+---
+name: 'step-e-03-edit'
+description: 'Edit & Update - Apply changes to PRD following approved change plan'
+
+# File references (ONLY variables used in this step)
+nextStepFile: './step-e-04-complete.md'
+prdFile: '{prd_file_path}'
+prdPurpose: '{project-root}/_xiaoma/xmc/workflows/2-plan-workflows/create-prd/data/prd-purpose.md'
+---
+
+# Step E-3: Edit & Update
+
+## STEP GOAL:
+
+Apply changes to the PRD following the approved change plan from step e-02, including content updates, structure improvements, and format conversion if needed.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 ALWAYS generate content WITH user input/approval
+- 📖 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 PRD Improvement 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 analytical expertise and precise editing skills
+- ✅ User brings domain knowledge and approval authority
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on implementing approved changes from step e-02
+- 🚫 FORBIDDEN to make changes beyond the approved plan
+- 💬 Approach: Methodical, section-by-section execution
+- 🚪 This is a middle step - user can request adjustments
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Follow approved change plan systematically
+- 💾 Edit PRD content according to plan
+- 📖 Update frontmatter as needed
+- 🚫 FORBIDDEN to proceed without completion
+
+## CONTEXT BOUNDARIES:
+
+- Available context: PRD file, approved change plan from step e-02, prd-purpose standards
+- Focus: Implementing changes from approved plan only
+- Limits: Don't add changes beyond plan, don't validate yet
+- Dependencies: Step e-02 completed - plan approved by user
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Retrieve Approved Change Plan
+
+From step e-02, retrieve:
+- **Approved changes:** Section-by-section list
+- **Priority order:** Sequence to apply changes
+- **User requirements:** Edit goals from step e-01
+
+Display: "**Starting PRD Edits**
+
+**Change Plan:** {summary}
+**Total Changes:** {count}
+**Estimated Effort:** {effort level}
+
+**Proceeding with edits section by section...**"
+
+### 2. Attempt Sub-Process Edits (For Complex Changes)
+
+**Try to use Task tool with sub-agent for major sections:**
+
+"Execute PRD edits for {section_name}:
+
+**Context:**
+- Section to edit: {section_name}
+- Current content: {existing content}
+- Changes needed: {specific changes from plan}
+- BMAD PRD standards: Load from prd-purpose.md
+
+**Tasks:**
+1. Read current PRD section
+2. Apply specified changes
+3. Ensure BMAD PRD principles compliance:
+   - High information density (no filler)
+   - Measurable requirements
+   - Clear structure
+   - Proper markdown formatting
+4. Return updated section content
+
+Apply changes and return updated section."
+
+**Graceful degradation (if no Task tool):**
+- Perform edits directly in current context
+- Load PRD section, apply changes, save
+
+### 3. Execute Changes Section-by-Section
+
+**For each section in approved plan (in priority order):**
+
+**a) Load current section**
+- Read the current PRD section content
+- Note what exists
+
+**b) Apply changes per plan**
+- Additions: Create new sections with proper content
+- Updates: Modify existing content per plan
+- Removals: Remove specified content
+- Restructuring: Reformat content to BMAD standard
+
+**c) Update PRD file**
+- Apply changes to PRD
+- Save updated PRD
+- Verify changes applied correctly
+
+**Display progress after each section:**
+"**Section Updated:** {section_name}
+Changes: {brief summary}
+{More sections remaining...}"
+
+### 4. Handle Restructuring (If Needed)
+
+**If conversion mode is "Full restructuring" or "Both":**
+
+**For restructuring:**
+- Reorganize PRD to BMAD standard structure
+- Ensure proper ## Level 2 headers
+- Reorder sections logically
+- Update PRD frontmatter to match BMAD format
+
+**Follow BMAD PRD structure:**
+1. Executive Summary
+2. Success Criteria
+3. Product Scope
+4. User Journeys
+5. Domain Requirements (if applicable)
+6. Innovation Analysis (if applicable)
+7. Project-Type Requirements
+8. Functional Requirements
+9. Non-Functional Requirements
+
+Display: "**PRD Restructured**
+BMAD standard structure applied.
+{Sections added/reordered}"
+
+### 5. Update PRD Frontmatter
+
+**Ensure frontmatter is complete and accurate:**
+
+```yaml
+---
+workflowType: 'prd'
+workflow: 'create'  # or 'validate' or 'edit'
+classification:
+  domain: '{domain}'
+  projectType: '{project_type}'
+  complexity: '{complexity}'
+inputDocuments: [list of input documents]
+stepsCompleted: ['step-e-01-discovery', 'step-e-02-review', 'step-e-03-edit']
+lastEdited: '{current_date}'
+editHistory:
+  - date: '{current_date}'
+    changes: '{summary of changes}'
+---
+```
+
+**Update frontmatter accordingly.**
+
+### 6. Final Review of Changes
+
+**Load complete updated PRD**
+
+**Verify:**
+- All approved changes applied correctly
+- PRD structure is sound
+- No unintended modifications
+- Frontmatter is accurate
+
+**If issues found:**
+- Fix them now
+- Note corrections made
+
+**If user wants adjustments:**
+- Accept feedback and make adjustments
+- Re-verify after adjustments
+
+### 7. Confirm Completion
+
+Display:
+
+"**PRD Edits Complete**
+
+**Changes Applied:** {count} sections modified
+**PRD Updated:** {prd_file_path}
+
+**Summary of Changes:**
+{Brief bullet list of major changes}
+
+**PRD is ready for:**
+- Use in downstream workflows (UX, Architecture)
+- Validation (if not yet validated)
+
+**What would you like to do next?**"
+
+### 8. Present MENU OPTIONS
+
+**[V] Run Validation** - Execute full validation workflow (steps-v/step-v-01-discovery.md)
+**[S] Summary Only** - End with summary of changes (no validation)
+**[A] Adjust** - Make additional edits
+**[X] Exit** - Exit edit workflow
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- IF V (Validate): Display "Starting validation workflow..." then read fully and follow: steps-v/step-v-01-discovery.md
+- IF S (Summary): Present edit summary and exit
+- IF A (Adjust): Accept additional requirements, loop back to editing
+- IF X (Exit): Display summary and exit
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All approved changes from step e-02 applied correctly
+- Changes executed in planned priority order
+- Restructuring completed (if needed)
+- Frontmatter updated accurately
+- Final verification confirms changes
+- User can proceed to validation or exit with summary
+- Option to run validation seamlessly integrates edit and validate modes
+
+### ❌ SYSTEM FAILURE:
+
+- Making changes beyond approved plan
+- Not following priority order
+- Missing restructuring (if conversion mode)
+- Not updating frontmatter
+- No final verification
+- Not saving updated PRD
+
+**Master Rule:** Execute the plan exactly as approved. PRD is now ready for validation or downstream use. Validation integration ensures quality.

package/src/xmc/workflows/2-plan-workflows/xiaoma-edit-prd/steps-e/step-e-04-complete.md

@@ -0,0 +1,168 @@
+---
+name: 'step-e-04-complete'
+description: 'Complete & Validate - Present options for next steps including full validation'
+
+# File references (ONLY variables used in this step)
+prdFile: '{prd_file_path}'
+validationWorkflow: '{project-root}/_xiaoma/xmc/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md'
+---
+
+# Step E-4: Complete & Validate
+
+## STEP GOAL:
+
+Present summary of completed edits and offer next steps including seamless integration with validation workflow.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 ALWAYS generate content WITH user input/approval
+- 📖 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 PRD Improvement 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
+- ✅ User chooses next actions
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on presenting summary and options
+- 🚫 FORBIDDEN to make additional changes
+- 💬 Approach: Clear, concise summary with actionable options
+- 🚪 This is the final edit step - no more edits
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Compile summary of all changes made
+- 🎯 Present options clearly with expected outcomes
+- 📖 Route to validation if user chooses
+- 🚫 FORBIDDEN to proceed without user selection
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Updated PRD file, edit history from step e-03
+- Focus: Summary and options only (no more editing)
+- Limits: Don't make changes, just present options
+- Dependencies: Step e-03 completed - all edits applied
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Compile Edit Summary
+
+From step e-03 change execution, compile:
+
+**Changes Made:**
+- Sections added: {list with names}
+- Sections updated: {list with names}
+- Content removed: {list}
+- Structure changes: {description}
+
+**Edit Details:**
+- Total sections affected: {count}
+- Mode: {restructure/targeted/both}
+- Priority addressed: {Critical/High/Medium/Low}
+
+**PRD Status:**
+- Format: {BMAD Standard / BMAD Variant / Legacy (converted)}
+- Completeness: {assessment}
+- Ready for: {downstream use cases}
+
+### 2. Present Completion Summary
+
+Display:
+
+"**✓ PRD Edit Complete**
+
+**Updated PRD:** {prd_file_path}
+
+**Changes Summary:**
+{Present bulleted list of major changes}
+
+**Edit Mode:** {mode}
+**Sections Modified:** {count}
+
+**PRD Format:** {format}
+
+**PRD is now ready for:**
+- Downstream workflows (UX Design, Architecture)
+- Validation to ensure quality
+- Production use
+
+**What would you like to do next?**"
+
+### 3. Present MENU OPTIONS
+
+Display:
+
+**[V] Run Full Validation** - Execute complete validation workflow (steps-v) to verify PRD quality
+**[E] Edit More** - Make additional edits to the PRD
+**[S] Summary** - End with detailed summary of changes
+**[X] Exit** - Exit edit workflow
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- **IF V (Run Full Validation):**
+  - Display: "**Starting Validation Workflow**"
+  - Display: "This will run all 13 validation checks on the updated PRD."
+  - Display: "Preparing to validate: {prd_file_path}"
+  - Display: "**Proceeding to validation...**"
+  - Read fully and follow: {validationWorkflow} (steps-v/step-v-01-discovery.md)
+  - Note: This hands off to the validation workflow which will run its complete 13-step process
+
+- **IF E (Edit More):**
+  - Display: "**Additional Edits**"
+  - Ask: "What additional edits would you like to make?"
+  - Accept input, then display: "**Returning to edit step...**"
+  - Read fully and follow: step-e-03-edit.md again
+
+- **IF S (Summary):**
+  - Display detailed summary including:
+    - Complete list of all changes made
+    - Before/after comparison (key improvements)
+    - Recommendations for next steps
+  - Display: "**Edit Workflow Complete**"
+  - Exit
+
+- **IF X (Exit):**
+  - Display summary
+  - Display: "**Edit Workflow Complete**"
+  - Exit
+
+- **IF Any other:** Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Complete edit summary compiled accurately
+- All changes clearly documented
+- Options presented with clear expectations
+- Validation option seamlessly integrates with steps-v workflow
+- User can validate, edit more, or exit
+- Clean handoff to validation workflow (if chosen)
+- Edit workflow completes properly
+
+### ❌ SYSTEM FAILURE:
+
+- Missing changes in summary
+- Not offering validation option
+- Not documenting completion properly
+- No clear handoff to validation workflow
+
+**Master Rule:** Edit workflow seamlessly integrates with validation. User can edit → validate → edit again → validate again in iterative improvement cycle.

package/src/xmc/workflows/2-plan-workflows/xiaoma-edit-prd/workflow.md

@@ -0,0 +1,64 @@
+---
+main_config: '{project-root}/_xiaoma/xmc/config.yaml'
+editWorkflow: './steps-e/step-e-01-discovery.md'
+---
+
+# PRD Edit Workflow
+
+**Goal:** Edit and improve existing PRDs through structured enhancement workflow.
+
+**Your Role:** PRD improvement 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 Edit Workflow
+
+"**Edit Mode: Improving an existing PRD.**"
+
+Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file."
+
+Then read fully and follow: `{editWorkflow}` (steps-e/step-e-01-discovery.md)

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

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

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/SKILL.md

@@ -0,0 +1,6 @@
+---
+name: xiaoma-validate-prd
+description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
+---
+
+Follow the instructions in [workflow.md](workflow.md).

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/SKILL.md.bak

@@ -0,0 +1,6 @@
+---
+name: bmad-validate-prd
+description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
+---
+
+Follow the instructions in [workflow.md](workflow.md).

package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/data/domain-complexity.csv

@@ -0,0 +1,15 @@
+domain,signals,complexity,key_concerns,required_knowledge,suggested_workflow,web_searches,special_sections
+healthcare,"medical,diagnostic,clinical,FDA,patient,treatment,HIPAA,therapy,pharma,drug",high,"FDA approval;Clinical validation;HIPAA compliance;Patient safety;Medical device classification;Liability","Regulatory pathways;Clinical trial design;Medical standards;Data privacy;Integration requirements","domain-research","FDA software medical device guidance {date};HIPAA compliance software requirements;Medical software standards {date};Clinical validation software","clinical_requirements;regulatory_pathway;validation_methodology;safety_measures"
+fintech,"payment,banking,trading,investment,crypto,wallet,transaction,KYC,AML,funds,fintech",high,"Regional compliance;Security standards;Audit requirements;Fraud prevention;Data protection","KYC/AML requirements;PCI DSS;Open banking;Regional laws (US/EU/APAC);Crypto regulations","domain-research","fintech regulations {date};payment processing compliance {date};open banking API standards;cryptocurrency regulations {date}","compliance_matrix;security_architecture;audit_requirements;fraud_prevention"
+govtech,"government,federal,civic,public sector,citizen,municipal,voting",high,"Procurement rules;Security clearance;Accessibility (508);FedRAMP;Privacy;Transparency","Government procurement;Security frameworks;Accessibility standards;Privacy laws;Open data requirements","domain-research","government software procurement {date};FedRAMP compliance requirements;section 508 accessibility;government security standards","procurement_compliance;security_clearance;accessibility_standards;transparency_requirements"
+edtech,"education,learning,student,teacher,curriculum,assessment,K-12,university,LMS",medium,"Student privacy (COPPA/FERPA);Accessibility;Content moderation;Age verification;Curriculum standards","Educational privacy laws;Learning standards;Accessibility requirements;Content guidelines;Assessment validity","domain-research","educational software privacy {date};COPPA FERPA compliance;WCAG education requirements;learning management standards","privacy_compliance;content_guidelines;accessibility_features;curriculum_alignment"
+aerospace,"aircraft,spacecraft,aviation,drone,satellite,propulsion,flight,radar,navigation",high,"Safety certification;DO-178C compliance;Performance validation;Simulation accuracy;Export controls","Aviation standards;Safety analysis;Simulation validation;ITAR/export controls;Performance requirements","domain-research + technical-model","DO-178C software certification;aerospace simulation standards {date};ITAR export controls software;aviation safety requirements","safety_certification;simulation_validation;performance_requirements;export_compliance"
+automotive,"vehicle,car,autonomous,ADAS,automotive,driving,EV,charging",high,"Safety standards;ISO 26262;V2X communication;Real-time requirements;Certification","Automotive standards;Functional safety;V2X protocols;Real-time systems;Testing requirements","domain-research","ISO 26262 automotive software;automotive safety standards {date};V2X communication protocols;EV charging standards","safety_standards;functional_safety;communication_protocols;certification_requirements"
+scientific,"research,algorithm,simulation,modeling,computational,analysis,data science,ML,AI",medium,"Reproducibility;Validation methodology;Peer review;Performance;Accuracy;Computational resources","Scientific method;Statistical validity;Computational requirements;Domain expertise;Publication standards","technical-model","scientific computing best practices {date};research reproducibility standards;computational modeling validation;peer review software","validation_methodology;accuracy_metrics;reproducibility_plan;computational_requirements"
+legaltech,"legal,law,contract,compliance,litigation,patent,attorney,court",high,"Legal ethics;Bar regulations;Data retention;Attorney-client privilege;Court system integration","Legal practice rules;Ethics requirements;Court filing systems;Document standards;Confidentiality","domain-research","legal technology ethics {date};law practice management software requirements;court filing system standards;attorney client privilege technology","ethics_compliance;data_retention;confidentiality_measures;court_integration"
+insuretech,"insurance,claims,underwriting,actuarial,policy,risk,premium",high,"Insurance regulations;Actuarial standards;Data privacy;Fraud detection;State compliance","Insurance regulations by state;Actuarial methods;Risk modeling;Claims processing;Regulatory reporting","domain-research","insurance software regulations {date};actuarial standards software;insurance fraud detection;state insurance compliance","regulatory_requirements;risk_modeling;fraud_detection;reporting_compliance"
+energy,"energy,utility,grid,solar,wind,power,electricity,oil,gas",high,"Grid compliance;NERC standards;Environmental regulations;Safety requirements;Real-time operations","Energy regulations;Grid standards;Environmental compliance;Safety protocols;SCADA systems","domain-research","energy sector software compliance {date};NERC CIP standards;smart grid requirements;renewable energy software standards","grid_compliance;safety_protocols;environmental_compliance;operational_requirements"
+process_control,"industrial automation,process control,PLC,SCADA,DCS,HMI,operational technology,OT,control system,cyberphysical,MES,historian,instrumentation,I&C,P&ID",high,"Functional safety;OT cybersecurity;Real-time control requirements;Legacy system integration;Process safety and hazard analysis;Environmental compliance and permitting;Engineering authority and PE requirements","Functional safety standards;OT security frameworks;Industrial protocols;Process control architecture;Plant reliability and maintainability","domain-research + technical-model","IEC 62443 OT cybersecurity requirements {date};functional safety software requirements {date};industrial process control architecture;ISA-95 manufacturing integration","functional_safety;ot_security;process_requirements;engineering_authority"
+building_automation,"building automation,BAS,BMS,HVAC,smart building,lighting control,fire alarm,fire protection,fire suppression,life safety,elevator,access control,DDC,energy management,sequence of operations,commissioning",high,"Life safety codes;Building energy standards;Multi-trade coordination and interoperability;Commissioning and ongoing operational performance;Indoor environmental quality and occupant comfort;Engineering authority and PE requirements","Building automation protocols;HVAC and mechanical controls;Fire alarm, fire protection, and life safety design;Commissioning process and sequence of operations;Building codes and energy standards","domain-research","smart building software architecture {date};BACnet integration best practices;building automation cybersecurity {date};ASHRAE building standards","life_safety;energy_compliance;commissioning_requirements;engineering_authority"
+gaming,"game,player,gameplay,level,character,multiplayer,quest",redirect,"REDIRECT TO GAME WORKFLOWS","Game design","game-brief","NA","NA"
+general,"",low,"Standard requirements;Basic security;User experience;Performance","General software practices","continue","software development best practices {date}","standard_requirements"