@zeyue0329/xiaoma-cli 1.0.49 → 6.0.0-alpha.14

package/src/modules/xmc/workflows/2-plan-workflows/prd/steps/step-09-functional.md

@@ -0,0 +1,251 @@
+# Step 9: Functional Requirements Synthesis
+
+**Progress: Step 9 of 11** - Next: Non-Functional Requirements
+
+## 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 PM peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on creating comprehensive capability inventory for the product
+- 🎯 CRITICAL: This is THE CAPABILITY CONTRACT for all downstream work
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- ⚠️ Present A/P/C menu after generating functional requirements
+- 💾 ONLY save when user chooses C (Continue)
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step
+- 🚫 FORBIDDEN to load next step until C is selected
+
+## COLLABORATION MENUS (A/P/C):
+
+This step will generate content and present choices:
+
+- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive requirement coverage
+- **P (Party Mode)**: Bring multiple perspectives to validate complete requirement set
+- **C (Continue)**: Save the content to the document and proceed to next step
+
+## PROTOCOL INTEGRATION:
+
+- When 'A' selected: Execute {project-root}/{xiaoma_folder}/core/tasks/advanced-elicitation.xml
+- When 'P' selected: Execute {project-root}/{xiaoma_folder}/core/workflows/party-mode/workflow.md
+- PROTOCOLS always return to this step's A/P/C menu
+- User accepts/rejects protocol changes before proceeding
+
+## CONTEXT BOUNDARIES:
+
+- Current document and frontmatter from previous steps are available
+- ALL previous content (executive summary, success criteria, journeys, domain, innovation, project-type) must be referenced
+- No additional data files needed for this step
+- Focus on capabilities, not implementation details
+
+## CRITICAL IMPORTANCE:
+
+**This section defines THE CAPABILITY CONTRACT for the entire product:**
+
+- UX designers will ONLY design what's listed here
+- Architects will ONLY support what's listed here
+- Epic breakdown will ONLY implement what's listed here
+- If a capability is missing from FRs, it will NOT exist in the final product
+
+## FUNCTIONAL REQUIREMENTS SYNTHESIS SEQUENCE:
+
+### 1. Understand FR Purpose and Usage
+
+Start by explaining the critical role of functional requirements:
+
+**Purpose:**
+FRs define WHAT capabilities the product must have. They are the complete inventory of user-facing and system capabilities that deliver the product vision.
+
+**Critical Properties:**
+✅ Each FR is a testable capability
+✅ Each FR is implementation-agnostic (could be built many ways)
+✅ Each FR specifies WHO and WHAT, not HOW
+✅ No UI details, no performance numbers, no technology choices
+✅ Comprehensive coverage of capability areas
+
+**How They Will Be Used:**
+
+1. UX Designer reads FRs → designs interactions for each capability
+2. Architect reads FRs → designs systems to support each capability
+3. PM reads FRs → creates epics and stories to implement each capability
+
+### 2. Review Existing Content for Capability Extraction
+
+Systematically review all previous sections to extract capabilities:
+
+**Extract From:**
+
+- Executive Summary → Core product differentiator capabilities
+- Success Criteria → Success-enabling capabilities
+- User Journeys → Journey-revealed capabilities
+- Domain Requirements → Compliance and regulatory capabilities
+- Innovation Patterns → Innovative feature capabilities
+- Project-Type Requirements → Technical capability needs
+
+### 3. Organize Requirements by Capability Area
+
+Group FRs by logical capability areas (NOT by technology or layer):
+
+**Good Grouping Examples:**
+
+- ✅ "User Management" (not "Authentication System")
+- ✅ "Content Discovery" (not "Search Algorithm")
+- ✅ "Team Collaboration" (not "WebSocket Infrastructure")
+
+**Target 5-8 Capability Areas** for typical projects.
+
+### 4. Generate Comprehensive FR List
+
+Create complete functional requirements using this format:
+
+**Format:**
+
+- FR#: [Actor] can [capability] [context/constraint if needed]
+- Number sequentially (FR1, FR2, FR3...)
+- Aim for 20-50 FRs for typical projects
+
+**Altitude Check:**
+Each FR should answer "WHAT capability exists?" NOT "HOW it's implemented?"
+
+**Examples:**
+
+- ✅ "Users can customize appearance settings"
+- ❌ "Users can toggle light/dark theme with 3 font size options stored in LocalStorage"
+
+### 5. Self-Validation Process
+
+Before presenting to user, validate the FR list:
+
+**Completeness Check:**
+
+1. "Did I cover EVERY capability mentioned in the MVP scope section?"
+2. "Did I include domain-specific requirements as FRs?"
+3. "Did I cover the project-type specific needs?"
+4. "Could a UX designer read ONLY the FRs and know what to design?"
+5. "Could an Architect read ONLY the FRs and know what to support?"
+6. "Are there any user actions or system behaviors we discussed that have no FR?"
+
+**Altitude Check:**
+
+1. "Am I stating capabilities (WHAT) or implementation (HOW)?"
+2. "Am I listing acceptance criteria or UI specifics?" (Remove if yes)
+3. "Could this FR be implemented 5 different ways?" (Good - means it's not prescriptive)
+
+**Quality Check:**
+
+1. "Is each FR clear enough that someone could test whether it exists?"
+2. "Is each FR independent (not dependent on reading other FRs to understand)?"
+3. "Did I avoid vague terms like 'good', 'fast', 'easy'?" (Use NFRs for quality attributes)
+
+### 6. Generate Functional Requirements Content
+
+Prepare the content to append to the document:
+
+#### Content Structure:
+
+When saving to document, append these Level 2 and Level 3 sections:
+
+```markdown
+## Functional Requirements
+
+### [Capability Area Name]
+
+- FR1: [Specific Actor] can [specific capability]
+- FR2: [Specific Actor] can [specific capability]
+- FR3: [Specific Actor] can [specific capability]
+
+### [Another Capability Area]
+
+- FR4: [Specific Actor] can [specific capability]
+- FR5: [Specific Actor] can [specific capability]
+
+[Continue for all capability areas discovered in conversation]
+```
+
+### 7. Present Content and Menu
+
+Show the generated functional requirements and present choices:
+"I've synthesized all our discussions into comprehensive functional requirements. This becomes the capability contract that UX designers, architects, and developers will all work from.
+
+**Here's what I'll add to the document:**
+
+[Show the complete FR list from step 6]
+
+**This is critical because:**
+
+- Every feature we build must trace back to one of these requirements
+- UX designers will ONLY design interactions for these capabilities
+- Architects will ONLY build systems to support these capabilities
+
+**What would you like to do?**
+[A] Advanced Elicitation - Let's ensure we haven't missed any capabilities
+[P] Party Mode - Bring different perspectives to validate complete coverage
+[C] Continue - Save this and move to Non-Functional Requirements (Step 10 of 11)"
+
+### 8. Handle Menu Selection
+
+#### If 'A' (Advanced Elicitation):
+
+- Execute {project-root}/{xiaoma_folder}/core/tasks/advanced-elicitation.xml with the current FR list
+- Process the enhanced capability coverage that comes back
+- Ask user: "Accept these additions to the functional requirements? (y/n)"
+- If yes: Update content with improvements, then return to A/P/C menu
+- If no: Keep original content, then return to A/P/C menu
+
+#### If 'P' (Party Mode):
+
+- Execute {project-root}/{xiaoma_folder}/core/workflows/party-mode/workflow.md with the current FR list
+- Process the collaborative capability validation and additions
+- Ask user: "Accept these changes to the functional requirements? (y/n)"
+- If yes: Update content with improvements, then return to A/P/C menu
+- If no: Keep original content, then return to A/P/C menu
+
+#### If 'C' (Continue):
+
+- Append the final content to `{output_folder}/prd.md`
+- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]`
+- Load `{project-root}/{xiaoma_folder}/xmc/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md`
+
+## APPEND TO DOCUMENT:
+
+When user selects 'C', append the content directly to the document using the structure from step 6.
+
+## SUCCESS METRICS:
+
+✅ All previous discovery content synthesized into FRs
+✅ FRs organized by capability areas (not technology)
+✅ Each FR states WHAT capability exists, not HOW to implement
+✅ Comprehensive coverage with 20-50 FRs typical
+✅ Altitude validation ensures implementation-agnostic requirements
+✅ Completeness check validates coverage of all discussed capabilities
+✅ A/P/C menu presented and handled correctly
+✅ Content properly appended to document when C selected
+
+## FAILURE MODES:
+
+❌ Missing capabilities from previous discovery sections
+❌ Organizing FRs by technology instead of capability areas
+❌ Including implementation details or UI specifics in FRs
+❌ Not achieving comprehensive coverage of discussed capabilities
+❌ Using vague terms instead of testable capabilities
+❌ Not presenting A/P/C menu after content generation
+❌ Appending content without user selecting 'C'
+
+❌ **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
+
+## CAPABILITY CONTRACT REMINDER:
+
+Emphasize to user: "This FR list is now binding. Any feature not listed here will not exist in the final product unless we explicitly add it. This is why it's critical to ensure completeness now."
+
+## NEXT STEP:
+
+After user selects 'C' and content is saved to document, load `{project-root}/{xiaoma_folder}/xmc/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` to define non-functional requirements.
+
+Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved!

package/src/modules/xmc/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md

@@ -0,0 +1,275 @@
+# Step 10: Non-Functional Requirements
+
+**Progress: Step 10 of 11** - Next: Complete PRD
+
+## 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 PM peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on quality attributes that matter for THIS specific product
+- 🎯 SELECTIVE: Only document NFRs that actually apply to the product
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- ⚠️ Present A/P/C menu after generating NFR content
+- 💾 ONLY save when user chooses C (Continue)
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step
+- 🚫 FORBIDDEN to load next step until C is selected
+
+## COLLABORATION MENUS (A/P/C):
+
+This step will generate content and present choices:
+
+- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive quality attributes
+- **P (Party Mode)**: Bring technical perspectives to validate NFR completeness
+- **C (Continue)**: Save the content to the document and proceed to final step
+
+## PROTOCOL INTEGRATION:
+
+- When 'A' selected: Execute {project-root}/{xiaoma_folder}/core/tasks/advanced-elicitation.xml
+- When 'P' selected: Execute {project-root}/{xiaoma_folder}/core/workflows/party-mode/workflow.md
+- PROTOCOLS always return to this step's A/P/C menu
+- User accepts/rejects protocol changes before proceeding
+
+## CONTEXT BOUNDARIES:
+
+- Current document and frontmatter from previous steps are available
+- Functional requirements already defined and will inform NFRs
+- Domain and project-type context will guide which NFRs matter
+- Focus on specific, measurable quality criteria
+
+## YOUR TASK:
+
+Define non-functional requirements that specify quality attributes for the product, focusing only on what matters for THIS specific product.
+
+## NON-FUNCTIONAL REQUIREMENTS SEQUENCE:
+
+### 1. Explain NFR Purpose and Scope
+
+Start by clarifying what NFRs are and why we're selective:
+
+**NFR Purpose:**
+NFRs define HOW WELL the system must perform, not WHAT it must do. They specify quality attributes like performance, security, scalability, etc.
+
+**Selective Approach:**
+We only document NFRs that matter for THIS product. If a category doesn't apply, we skip it entirely. This prevents requirement bloat and focuses on what's actually important.
+
+### 2. Assess Product Context for NFR Relevance
+
+Evaluate which NFR categories matter based on product context:
+
+**Quick Assessment Questions:**
+
+- **Performance**: Is there user-facing impact of speed?
+- **Security**: Are we handling sensitive data or payments?
+- **Scalability**: Do we expect rapid user growth?
+- **Accessibility**: Are we serving broad public audiences?
+- **Integration**: Do we need to connect with other systems?
+- **Reliability**: Would downtime cause significant problems?
+
+### 3. Explore Relevant NFR Categories
+
+For each relevant category, conduct targeted discovery:
+
+#### Performance NFRs (If relevant):
+
+"Let's talk about performance requirements for {{project_name}}.
+
+**Performance Questions:**
+
+- What parts of the system need to be fast for users to be successful?
+- Are there specific response time expectations?
+- What happens if performance is slower than expected?
+- Are there concurrent user scenarios we need to support?"
+
+#### Security NFRs (If relevant):
+
+"Security is critical for products that handle sensitive information.
+
+**Security Questions:**
+
+- What data needs to be protected?
+- Who should have access to what?
+- What are the security risks we need to mitigate?
+- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)?"
+
+#### Scalability NFRs (If relevant):
+
+"Scalability matters if we expect growth or have variable demand.
+
+**Scalability Questions:**
+
+- How many users do we expect initially? Long-term?
+- Are there seasonal or event-based traffic spikes?
+- What happens if we exceed our capacity?"
+- What growth scenarios should we plan for?"
+
+#### Accessibility NFRs (If relevant):
+
+"Accessibility ensures the product works for users with disabilities.
+
+**Accessibility Questions:**
+
+- Are we serving users with visual, hearing, or motor impairments?
+- Are there legal accessibility requirements (WCAG, Section 508)?
+- What accessibility features are most important for our users?"
+
+#### Integration NFRs (If relevant):
+
+"Integration requirements matter for products that connect to other systems.
+
+**Integration Questions:**
+
+- What external systems do we need to connect with?
+- Are there APIs or data formats we must support?
+- How reliable do these integrations need to be?"
+
+### 4. Make NFRs Specific and Measurable
+
+For each relevant NFR category, ensure criteria are testable:
+
+**From Vague to Specific:**
+
+- NOT: "The system should be fast" → "User actions complete within 2 seconds"
+- NOT: "The system should be secure" → "All data is encrypted at rest and in transit"
+- NOT: "The system should scale" → "System supports 10x user growth with <10% performance degradation"
+
+### 5. Generate NFR Content (Only Relevant Categories)
+
+Prepare the content to append to the document:
+
+#### Content Structure (Dynamic based on relevance):
+
+When saving to document, append these Level 2 and Level 3 sections (only include sections that are relevant):
+
+```markdown
+## Non-Functional Requirements
+
+### Performance
+
+[Performance requirements based on conversation - only include if relevant]
+
+### Security
+
+[Security requirements based on conversation - only include if relevant]
+
+### Scalability
+
+[Scalability requirements based on conversation - only include if relevant]
+
+### Accessibility
+
+[Accessibility requirements based on conversation - only include if relevant]
+
+### Integration
+
+[Integration requirements based on conversation - only include if relevant]
+```
+
+### 6. Present Content and Menu
+
+Show the generated NFR content and present choices:
+"I've defined the non-functional requirements that specify how well {{project_name}} needs to perform. I've only included categories that actually matter for this product.
+
+**Here's what I'll add to the document:**
+
+[Show the complete NFR content from step 5]
+
+**Note:** We've skipped categories that don't apply to avoid unnecessary requirements.
+
+**What would you like to do?**
+[A] Advanced Elicitation - Let's ensure we haven't missed critical quality attributes
+[P] Party Mode - Bring technical perspectives to validate NFR specifications
+[C] Continue - Save this and move to Complete PRD (Step 11 of 11)"
+
+### 7. Handle Menu Selection
+
+#### If 'A' (Advanced Elicitation):
+
+- Execute {project-root}/{xiaoma_folder}/core/tasks/advanced-elicitation.xml with the current NFR content
+- Process the enhanced quality attribute insights that come back
+- Ask user: "Accept these improvements to the non-functional requirements? (y/n)"
+- If yes: Update content with improvements, then return to A/P/C menu
+- If no: Keep original content, then return to A/P/C menu
+
+#### If 'P' (Party Mode):
+
+- Execute {project-root}/{xiaoma_folder}/core/workflows/party-mode/workflow.md with the current NFR list
+- Process the collaborative technical validation and additions
+- Ask user: "Accept these changes to the non-functional requirements? (y/n)"
+- If yes: Update content with improvements, then return to A/P/C menu
+- If no: Keep original content, then return to A/P/C menu
+
+#### If 'C' (Continue):
+
+- Append the final content to `{output_folder}/prd.md`
+- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]`
+- Load `{project-root}/{xiaoma_folder}/xmc/workflows/2-plan-workflows/prd/steps/step-11-complete.md`
+
+## APPEND TO DOCUMENT:
+
+When user selects 'C', append the content directly to the document using the structure from step 5.
+
+## SUCCESS METRICS:
+
+✅ Only relevant NFR categories documented (no requirement bloat)
+✅ Each NFR is specific and measurable
+✅ NFRs connected to actual user needs and business context
+✅ Vague requirements converted to testable criteria
+✅ Domain-specific compliance requirements included if relevant
+✅ A/P/C menu presented and handled correctly
+✅ Content properly appended to document when C selected
+
+## FAILURE MODES:
+
+❌ Documenting NFR categories that don't apply to the product
+❌ Leaving requirements vague and unmeasurable
+❌ Not connecting NFRs to actual user or business needs
+❌ Missing domain-specific compliance requirements
+❌ Creating overly prescriptive technical requirements
+❌ Not presenting A/P/C menu after content generation
+❌ Appending content without user selecting 'C'
+
+❌ **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
+
+## NFR CATEGORY GUIDANCE:
+
+**Include Performance When:**
+
+- User-facing response times impact success
+- Real-time interactions are critical
+- Performance is a competitive differentiator
+
+**Include Security When:**
+
+- Handling sensitive user data
+- Processing payments or financial information
+- Subject to compliance regulations
+- Protecting intellectual property
+
+**Include Scalability When:**
+
+- Expecting rapid user growth
+- Handling variable traffic patterns
+- Supporting enterprise-scale usage
+- Planning for market expansion
+
+**Include Accessibility When:**
+
+- Serving broad public audiences
+- Subject to accessibility regulations
+- Targeting users with disabilities
+- B2B customers with accessibility requirements
+
+## NEXT STEP:
+
+After user selects 'C' and content is saved to document, load `{project-root}/{xiaoma_folder}/xmc/workflows/2-plan-workflows/prd/steps/step-11-complete.md` to finalize the PRD and complete the workflow.
+
+Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved!