@zeyue0329/xiaoma-cli 1.0.48 → 6.0.0-alpha.13

package/src/modules/xmc/data/documentation-standards.md

@@ -0,0 +1,262 @@
+# Technical Documentation Standards for XIAOMA
+
+**For Agent: Technical Writer**
+**Purpose: Concise reference for documentation creation and review**
+
+---
+
+## CRITICAL RULES
+
+### Rule 1: CommonMark Strict Compliance
+
+ALL documentation MUST follow CommonMark specification exactly. No exceptions.
+
+### Rule 2: NO TIME ESTIMATES
+
+NEVER document time estimates, durations, or completion times for any workflow, task, or activity. This includes:
+
+- Workflow execution time (e.g., "30-60 min", "2-8 hours")
+- Task duration estimates
+- Reading time estimates
+- Implementation time ranges
+- Any temporal measurements
+
+Time varies dramatically based on:
+
+- Project complexity
+- Team experience
+- Tooling and environment
+- Context switching
+- Unforeseen blockers
+
+**Instead:** Focus on workflow steps, dependencies, and outputs. Let users determine their own timelines.
+
+### CommonMark Essentials
+
+**Headers:**
+
+- Use ATX-style ONLY: `#` `##` `###` (NOT Setext underlines)
+- Single space after `#`: `# Title` (NOT `#Title`)
+- No trailing `#`: `# Title` (NOT `# Title #`)
+- Hierarchical order: Don't skip levels (h1→h2→h3, not h1→h3)
+
+**Code Blocks:**
+
+- Use fenced blocks with language identifier:
+  ````markdown
+  ```javascript
+  const example = 'code';
+  ```
+  ````
+- NOT indented code blocks (ambiguous)
+
+**Lists:**
+
+- Consistent markers within list: all `-` or all `*` or all `+` (don't mix)
+- Proper indentation for nested items (2 or 4 spaces, stay consistent)
+- Blank line before/after list for clarity
+
+**Links:**
+
+- Inline: `[text](url)`
+- Reference: `[text][ref]` then `[ref]: url` at bottom
+- NO bare URLs without `<>` brackets
+
+**Emphasis:**
+
+- Italic: `*text*` or `_text_`
+- Bold: `**text**` or `__text__`
+- Consistent style within document
+
+**Line Breaks:**
+
+- Two spaces at end of line + newline, OR
+- Blank line between paragraphs
+- NO single line breaks (they're ignored)
+
+---
+
+## Mermaid Diagrams: Valid Syntax Required
+
+**Critical Rules:**
+
+1. Always specify diagram type first line
+2. Use valid Mermaid v10+ syntax
+3. Test syntax before outputting (mental validation)
+4. Keep focused: 5-10 nodes ideal, max 15
+
+**Diagram Type Selection:**
+
+- **flowchart** - Process flows, decision trees, workflows
+- **sequenceDiagram** - API interactions, message flows, time-based processes
+- **classDiagram** - Object models, class relationships, system structure
+- **erDiagram** - Database schemas, entity relationships
+- **stateDiagram-v2** - State machines, lifecycle stages
+- **gitGraph** - Branch strategies, version control flows
+
+**Formatting:**
+
+````markdown
+```mermaid
+flowchart TD
+    Start[Clear Label] --> Decision{Question?}
+    Decision -->|Yes| Action1[Do This]
+    Decision -->|No| Action2[Do That]
+```
+````
+
+---
+
+## Style Guide Principles (Distilled)
+
+Apply in this hierarchy:
+
+1. **Project-specific guide** (if exists) - always ask first
+2. **XIAOMA conventions** (this document)
+3. **Google Developer Docs style** (defaults below)
+4. **CommonMark spec** (when in doubt)
+
+### Core Writing Rules
+
+**Task-Oriented Focus:**
+
+- Write for user GOALS, not feature lists
+- Start with WHY, then HOW
+- Every doc answers: "What can I accomplish?"
+
+**Clarity Principles:**
+
+- Active voice: "Click the button" NOT "The button should be clicked"
+- Present tense: "The function returns" NOT "The function will return"
+- Direct language: "Use X for Y" NOT "X can be used for Y"
+- Second person: "You configure" NOT "Users configure" or "One configures"
+
+**Structure:**
+
+- One idea per sentence
+- One topic per paragraph
+- Headings describe content accurately
+- Examples follow explanations
+
+**Accessibility:**
+
+- Descriptive link text: "See the API reference" NOT "Click here"
+- Alt text for diagrams: Describe what it shows
+- Semantic heading hierarchy (don't skip levels)
+- Tables have headers
+- Emojis are acceptable if user preferences allow (modern accessibility tools support emojis well)
+
+---
+
+## OpenAPI/API Documentation
+
+**Required Elements:**
+
+- Endpoint path and method
+- Authentication requirements
+- Request parameters (path, query, body) with types
+- Request example (realistic, working)
+- Response schema with types
+- Response examples (success + common errors)
+- Error codes and meanings
+
+**Quality Standards:**
+
+- OpenAPI 3.0+ specification compliance
+- Complete schemas (no missing fields)
+- Examples that actually work
+- Clear error messages
+- Security schemes documented
+
+---
+
+## Documentation Types: Quick Reference
+
+**README:**
+
+- What (overview), Why (purpose), How (quick start)
+- Installation, Usage, Contributing, License
+- Under 500 lines (link to detailed docs)
+
+**API Reference:**
+
+- Complete endpoint coverage
+- Request/response examples
+- Authentication details
+- Error handling
+- Rate limits if applicable
+
+**User Guide:**
+
+- Task-based sections (How to...)
+- Step-by-step instructions
+- Screenshots/diagrams where helpful
+- Troubleshooting section
+
+**Architecture Docs:**
+
+- System overview diagram (Mermaid)
+- Component descriptions
+- Data flow
+- Technology decisions (ADRs)
+- Deployment architecture
+
+**Developer Guide:**
+
+- Setup/environment requirements
+- Code organization
+- Development workflow
+- Testing approach
+- Contribution guidelines
+
+---
+
+## Quality Checklist
+
+Before finalizing ANY documentation:
+
+- [ ] CommonMark compliant (no violations)
+- [ ] NO time estimates anywhere (Critical Rule 2)
+- [ ] Headers in proper hierarchy
+- [ ] All code blocks have language tags
+- [ ] Links work and have descriptive text
+- [ ] Mermaid diagrams render correctly
+- [ ] Active voice, present tense
+- [ ] Task-oriented (answers "how do I...")
+- [ ] Examples are concrete and working
+- [ ] Accessibility standards met
+- [ ] Spelling/grammar checked
+- [ ] Reads clearly at target skill level
+
+---
+
+## XIAOMA-Specific Conventions
+
+**File Organization:**
+
+- `README.md` at root of each major component
+- `docs/` folder for extensive documentation
+- Workflow-specific docs in workflow folder
+- Cross-references use relative paths
+
+**Frontmatter:**
+Use YAML frontmatter when appropriate:
+
+```yaml
+---
+title: Document Title
+description: Brief description
+author: Author name
+date: YYYY-MM-DD
+---
+```
+
+**Metadata:**
+
+- Always include last-updated date
+- Version info for versioned docs
+- Author attribution for accountability
+
+---
+
+**Remember: This is your foundation. Follow these rules consistently, and all documentation will be clear, accessible, and maintainable.**

package/src/modules/xmc/data/project-context-template.md

@@ -0,0 +1,40 @@
+# Project Brainstorming Context Template
+
+## Project Focus Areas
+
+This brainstorming session focuses on software and product development considerations:
+
+### Key Exploration Areas
+
+- **User Problems and Pain Points** - What challenges do users face?
+- **Feature Ideas and Capabilities** - What could the product do?
+- **Technical Approaches** - How might we build it?
+- **User Experience** - How will users interact with it?
+- **Business Model and Value** - How does it create value?
+- **Market Differentiation** - What makes it unique?
+- **Technical Risks and Challenges** - What could go wrong?
+- **Success Metrics** - How will we measure success?
+
+### Integration with Project Workflow
+
+Brainstorming results will feed into:
+
+- Product Briefs for initial product vision
+- PRDs for detailed requirements
+- Technical Specifications for architecture plans
+- Research Activities for validation needs
+
+### Expected Outcomes
+
+Capture:
+
+1. Problem Statements - Clearly defined user challenges
+2. Solution Concepts - High-level approach descriptions
+3. Feature Priorities - Categorized by importance and feasibility
+4. Technical Considerations - Architecture and implementation thoughts
+5. Next Steps - Actions needed to advance concepts
+6. Integration Points - Connections to downstream workflows
+
+---
+
+_Use this template to provide project-specific context for brainstorming sessions. Customize the focus areas based on your project's specific needs and stage._

package/src/modules/xmc/docs/README.md

@@ -0,0 +1,252 @@
+# XMC Documentation
+
+Complete guides for the XiaoMa Method Module (XMC) - AI-powered agile development workflows that adapt to your project's complexity.
+
+---
+
+## 🚀 Getting Started
+
+**New to XMC?** Start here:
+
+- **[Quick Start Guide](quick-start.md)** - Step-by-step guide to building your first project (15 min read)
+  - Installation and setup
+  - Understanding the four phases
+  - Running your first workflows
+  - Agent-based development flow
+
+**Quick Path:** Install → workflow-init → Follow agent guidance
+
+### 📊 Visual Overview
+
+**[Complete Workflow Diagram](images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the XiaoMa Method standard greenfield track.
+
+---
+
+## 📖 Core Concepts
+
+Understanding how XMC adapts to your needs:
+
+- **[Scale Adaptive System](scale-adaptive-system.md)** - How XMC adapts to project size and complexity (42 min read)
+  - Three planning tracks (Quick Flow, XiaoMa Method, Enterprise Method)
+  - Automatic track recommendation
+  - Documentation requirements per track
+  - Planning workflow routing
+
+- **[XIAOMA Quick Flow](xiaoma-quick-flow.md)** - Fast-track development workflow (32 min read)
+  - 3-step process: spec → dev → optional review
+  - Perfect for bug fixes and small features
+  - Rapid prototyping with production quality
+  - Hours to implementation, not days
+  - Barry (Quick Flow Solo Dev) agent owned
+
+- **[Quick Flow Solo Dev Agent](quick-flow-solo-dev.md)** - Elite solo developer for rapid development (18 min read)
+  - Barry is an elite developer who thrives on autonomous execution
+  - Lives and breathes the XIAOMA Quick Flow workflow
+  - Takes projects from concept to deployment with ruthless efficiency
+  - No handoffs, no delays - just pure focused development
+
+---
+
+## 🤖 Agents and Collaboration
+
+Complete guide to XMC's AI agent team:
+
+- **[Agents Guide](agents-guide.md)** - Comprehensive agent reference (45 min read)
+  - 12 specialized XMC agents + XiaoMa Master
+  - Agent roles, workflows, and when to use them
+  - Agent customization system
+  - Best practices and common patterns
+
+- **[Party Mode Guide](party-mode.md)** - Multi-agent collaboration (20 min read)
+  - How party mode works (19+ agents collaborate in real-time)
+  - When to use it (strategic, creative, cross-functional, complex)
+  - Example party compositions
+  - Multi-module integration (XMC + CIS + XMB + custom)
+  - Agent customization in party mode
+  - Best practices
+
+---
+
+## 🔧 Working with Existing Code
+
+Comprehensive guide for brownfield development:
+
+- **[Brownfield Development Guide](brownfield-guide.md)** - Complete guide for existing codebases (53 min read)
+  - Documentation phase strategies
+  - Track selection for brownfield
+  - Integration with existing patterns
+  - Phase-by-phase workflow guidance
+  - Common scenarios
+
+---
+
+## 📚 Quick References
+
+Essential reference materials:
+
+- **[Glossary](glossary.md)** - Key terminology and concepts
+- **[FAQ](faq.md)** - Frequently asked questions across all topics
+- **[Enterprise Agentic Development](enterprise-agentic-development.md)** - Team collaboration strategies
+
+---
+
+## 🎯 Choose Your Path
+
+### I need to...
+
+**Build something new (greenfield)**
+→ Start with [Quick Start Guide](quick-start.md)
+→ Then review [Scale Adaptive System](scale-adaptive-system.md) to understand tracks
+
+**Fix a bug or add small feature**
+→ Go to [XIAOMA Quick Flow](xiaoma-quick-flow.md) for rapid development
+→ Or use [Quick Flow Solo Dev](quick-flow-solo-dev.md) directly
+
+**Work with existing codebase (brownfield)**
+→ Read [Brownfield Development Guide](brownfield-guide.md)
+→ Pay special attention to documentation requirements for brownfield projects
+
+**Understand planning tracks and methodology**
+→ See [Scale Adaptive System](scale-adaptive-system.md)
+
+**Find specific commands or answers**
+→ Check [FAQ](faq.md)
+
+---
+
+## 📋 Workflow Guides
+
+Comprehensive documentation for all XMC workflows organized by phase:
+
+- **[Phase 1: Analysis Workflows](workflows-analysis.md)** - Optional exploration and research workflows (595 lines)
+  - brainstorm-project, product-brief, research, and more
+  - When to use analysis workflows
+  - Creative and strategic tools
+
+- **[Phase 2: Planning Workflows](workflows-planning.md)** - Scale-adaptive planning (967 lines)
+  - prd, tech-spec, gdd, narrative, ux
+  - Track-based planning approach (Quick Flow, XiaoMa Method, Enterprise Method)
+  - Which planning workflow to use
+
+- **[Phase 3: Solutioning Workflows](workflows-solutioning.md)** - Architecture and validation (638 lines)
+  - architecture, create-epics-and-stories, implementation-readiness
+  - V6: Epics created AFTER architecture for better quality
+  - Required for XiaoMa Method and Enterprise Method tracks
+  - Preventing agent conflicts
+
+- **[Phase 4: Implementation Workflows](workflows-implementation.md)** - Sprint-based development (1,634 lines)
+  - sprint-planning, create-story, dev-story, code-review
+  - Complete story lifecycle
+  - One-story-at-a-time discipline
+
+- **[Testing & QA Workflows](test-architecture.md)** - Comprehensive quality assurance (1,420 lines)
+  - Test strategy, automation, quality gates
+  - TEA agent and test healing
+  - XiaoMa-integrated vs standalone modes
+
+**Total: 34 workflows documented across all phases**
+
+### Advanced Workflow References
+
+For detailed technical documentation on specific complex workflows:
+
+- **[Document Project Workflow Reference](workflow-document-project-reference.md)** - Technical deep-dive (445 lines)
+  - v1.2.0 context-safe architecture
+  - Scan levels, resumability, write-as-you-go
+  - Multi-part project detection
+  - Deep-dive mode for targeted analysis
+
+- **[Architecture Workflow Reference](workflow-architecture-reference.md)** - Decision architecture guide (320 lines)
+  - Starter template intelligence
+  - Novel pattern design
+  - Implementation patterns for agent consistency
+  - Adaptive facilitation approach
+
+---
+
+## 🧪 Testing and Quality
+
+Quality assurance guidance:
+
+<!-- Test Architect documentation to be added -->
+
+- Test design workflows
+- Quality gates
+- Risk assessment
+- NFR validation
+
+---
+
+## 🏗️ Module Structure
+
+Understanding XMC components:
+
+- **[XMC Module README](../README.md)** - Overview of module structure
+  - Agent roster and roles
+  - Workflow organization
+  - Teams and collaboration
+  - Best practices
+
+---
+
+## 🌐 External Resources
+
+### Community and Support
+
+- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#general-dev, #bugs-issues)
+- **[GitHub Issues](https://github.com/xiaoma-code-org/XIAOMA-CLI/issues)** - Report bugs or request features
+- **[YouTube Channel](https://www.youtube.com/@XiaoMaCode)** - Video tutorials and walkthroughs
+
+### Additional Documentation
+
+- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure your development environment
+  - Claude Code
+  - Cursor
+  - Windsurf
+  - VS Code
+  - Other IDEs
+
+---
+
+## 📊 Documentation Map
+
+```mermaid
+flowchart TD
+    START[New to XMC?]
+    START --> QS[Quick Start Guide]
+
+    QS --> DECIDE{What are you building?}
+
+    DECIDE -->|Bug fix or<br/>small feature| QF[XIAOMA Quick Flow]
+    DECIDE -->|Need rapid<br/>development| PE[Principal Engineer]
+    DECIDE -->|New project| SAS[Scale Adaptive System]
+    DECIDE -->|Existing codebase| BF[Brownfield Guide]
+
+    QF --> IMPL[Implementation]
+    PE --> IMPL
+    SAS --> IMPL
+    BF --> IMPL
+
+    IMPL --> REF[Quick References<br/>Glossary, FAQ]
+
+    style START fill:#bfb,stroke:#333,stroke-width:2px,color:#000
+    style QS fill:#bbf,stroke:#333,stroke-width:2px,color:#000
+    style DECIDE fill:#ffb,stroke:#333,stroke-width:2px,color:#000
+    style QF fill:#e1f5fe,stroke:#333,stroke-width:2px,color:#000
+    style PE fill:#fff3e0,stroke:#333,stroke-width:2px,color:#000
+    style IMPL fill:#f9f,stroke:#333,stroke-width:2px,color:#000
+```
+
+---
+
+## 💡 Tips for Using This Documentation
+
+1. **Start with Quick Start** if you're new - it provides the essential foundation
+2. **Use the FAQ** to find quick answers without reading entire guides
+3. **Bookmark Glossary** for terminology references while reading other docs
+4. **Follow the suggested paths** above based on your specific situation
+5. **Join Discord** for interactive help and community insights
+
+---
+
+**Ready to begin?** → [Start with the Quick Start Guide](quick-start.md)