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

package/src/modules/xmc/docs/workflows-analysis.md

@@ -0,0 +1,266 @@
+# XMC Analysis Workflows (Phase 1)
+
+## Overview
+
+Phase 1 (Analysis) workflows are **optional** exploration and discovery tools that help validate ideas, understand markets, and generate strategic context before planning begins.
+
+**Key principle:** Analysis workflows help you think strategically before committing to implementation. Skip them if your requirements are already clear.
+
+**When to use:** Starting new projects, exploring opportunities, validating market fit, generating ideas, understanding problem spaces.
+
+**When to skip:** Continuing existing projects with clear requirements, well-defined features with known solutions, strict constraints where discovery is complete.
+
+---
+
+## Phase 1 Analysis Workflow Overview
+
+Phase 1 Analysis consists of three categories of optional workflows:
+
+### Discovery & Ideation (Optional)
+
+- **brainstorm-project** - Multi-track solution exploration for software projects
+- **brainstorm-game** - Game concept generation (coming soon)
+
+### Research & Validation (Optional)
+
+- **research** - Market, technical, competitive, user, domain, and AI research
+- **domain-research** - Industry-specific deep dive research
+
+### Strategic Capture (Recommended for Greenfield)
+
+- **product-brief** - Product vision and strategy definition
+
+These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` workflow.
+
+---
+
+## Quick Reference
+
+| Workflow               | Agent   | Required    | Purpose                                                        | Output                       |
+| ---------------------- | ------- | ----------- | -------------------------------------------------------------- | ---------------------------- |
+| **brainstorm-project** | Analyst | No          | Explore solution approaches and architectures                  | Solution options + rationale |
+| **research**           | Analyst | No          | Multi-type research (market/technical/competitive/user/domain) | Research reports             |
+| **product-brief**      | Analyst | Recommended | Define product vision and strategy (interactive)               | Product Brief document       |
+
+---
+
+## Workflow Descriptions
+
+### brainstorm-project
+
+**Purpose:** Generate multiple solution approaches through parallel ideation tracks (architecture, UX, integration, value).
+
+**Agent:** Analyst
+
+**When to Use:**
+
+- Unclear technical approach with business objectives
+- Multiple solution paths need evaluation
+- Hidden assumptions need discovery
+- Innovation beyond obvious solutions
+
+**Key Outputs:**
+
+- Architecture proposals with trade-off analysis
+- Value framework (prioritized features)
+- Risk analysis (dependencies, challenges)
+- Strategic recommendation with rationale
+
+**Example:** "We need a customer dashboard" → Options: Monolith SSR (faster), Microservices SPA (scalable), Hybrid (balanced) with recommendation.
+
+---
+
+### research
+
+**Purpose:** Comprehensive multi-type research system consolidating market, technical, competitive, user, and domain analysis.
+
+**Agent:** Analyst
+
+**Research Types:**
+
+| Type            | Purpose                                                | Use When                            |
+| --------------- | ------------------------------------------------------ | ----------------------------------- |
+| **market**      | TAM/SAM/SOM, competitive analysis                      | Need market viability validation    |
+| **technical**   | Technology evaluation, ADRs                            | Choosing frameworks/platforms       |
+| **competitive** | Deep competitor analysis                               | Understanding competitive landscape |
+| **user**        | Customer insights, personas, JTBD                      | Need user understanding             |
+| **domain**      | Industry deep dives, trends                            | Understanding domain/industry       |
+| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research    |
+
+**Key Features:**
+
+- Real-time web research
+- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle)
+- Platform-specific optimization for deep_prompt type
+- Configurable research depth (quick/standard/comprehensive)
+
+**Example (market):** "SaaS project management tool" → TAM $50B, SAM $5B, SOM $50M, top competitors (Asana, Monday), positioning recommendation.
+
+---
+
+### product-brief
+
+**Purpose:** Interactive product brief creation that guides strategic product vision definition.
+
+**Agent:** Analyst
+
+**When to Use:**
+
+- Starting new product/major feature initiative
+- Aligning stakeholders before detailed planning
+- Transitioning from exploration to strategy
+- Need executive-level product documentation
+
+**Modes:**
+
+- **Interactive Mode** (Recommended): Step-by-step collaborative development with probing questions
+- **YOLO Mode**: AI generates complete draft from context, then iterative refinement
+
+**Key Outputs:**
+
+- Executive summary
+- Problem statement with evidence
+- Proposed solution and differentiators
+- Target users (segmented)
+- MVP scope (ruthlessly defined)
+- Financial impact and ROI
+- Strategic alignment
+- Risks and open questions
+
+**Integration:** Feeds directly into PRD workflow (Phase 2).
+
+---
+
+## Decision Guide
+
+### Starting a Software Project
+
+```
+brainstorm-project (if unclear) → research (market/technical) → product-brief → Phase 2 (prd)
+```
+
+### Validating an Idea
+
+```
+research (market type) → product-brief → Phase 2
+```
+
+### Technical Decision Only
+
+```
+research (technical type) → Use findings in Phase 3 (architecture)
+```
+
+### Understanding Market
+
+```
+research (market/competitive type) → product-brief → Phase 2
+```
+
+### Domain Research for Complex Industries
+
+```
+domain-research → research (compliance/regulatory) → product-brief → Phase 2
+```
+
+---
+
+## Integration with Phase 2 (Planning)
+
+Analysis outputs feed directly into Planning:
+
+| Analysis Output             | Planning Input             |
+| --------------------------- | -------------------------- |
+| product-brief.md            | **prd** workflow           |
+| market-research.md          | **prd** context            |
+| domain-research.md          | **prd** context            |
+| technical-research.md       | **architecture** (Phase 3) |
+| competitive-intelligence.md | **prd** positioning        |
+
+Planning workflows automatically load these documents if they exist in the output folder.
+
+---
+
+## Best Practices
+
+### 1. Don't Over-Invest in Analysis
+
+Analysis is optional. If requirements are clear, skip to Phase 2 (Planning).
+
+### 2. Iterate Between Workflows
+
+Common pattern: brainstorm → research (validate) → brief (synthesize)
+
+### 3. Document Assumptions
+
+Analysis surfaces and validates assumptions. Document them explicitly for planning to challenge.
+
+### 4. Keep It Strategic
+
+Focus on "what" and "why", not "how". Leave implementation for Planning and Solutioning.
+
+### 5. Involve Stakeholders
+
+Use analysis workflows to align stakeholders before committing to detailed planning.
+
+---
+
+## Common Patterns
+
+### Greenfield Software (Full Analysis)
+
+```
+1. brainstorm-project - explore approaches
+2. research (market/technical/domain) - validate viability
+3. product-brief - capture strategic vision
+4. → Phase 2: prd
+```
+
+### Skip Analysis (Clear Requirements)
+
+```
+→ Phase 2: prd or tech-spec directly
+```
+
+### Technical Research Only
+
+```
+1. research (technical) - evaluate technologies
+2. → Phase 3: architecture (use findings in ADRs)
+```
+
+---
+
+## Related Documentation
+
+- [Phase 2: Planning Workflows](workflows-planning.md) - Next phase
+- [Phase 3: Solutioning Workflows](workflows-solutioning.md)
+- [Phase 4: Implementation Workflows](workflows-implementation.md)
+- [Scale Adaptive System](scale-adaptive-system.md) - Understanding project complexity
+- [Agents Guide](agents-guide.md) - Complete agent reference
+
+---
+
+## Troubleshooting
+
+**Q: Do I need to run all analysis workflows?**
+A: No! Analysis is entirely optional. Use only workflows that help you think through your problem.
+
+**Q: Which workflow should I start with?**
+A: If unsure, start with `research` (market type) to validate viability, then move to `product-brief`.
+
+**Q: Can I skip straight to Planning?**
+A: Yes! If you know what you're building and why, skip Phase 1 entirely and start with Phase 2 (prd/tech-spec).
+
+**Q: How long should Analysis take?**
+A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Move to Planning.
+
+**Q: What if I discover problems during Analysis?**
+A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment.
+
+**Q: Should brownfield projects do Analysis?**
+A: Usually no. Start with `document-project` (Documentation prerequisite), then skip to Planning (Phase 2).
+
+---
+
+_Phase 1 Analysis - Optional strategic thinking before commitment._

package/src/modules/xmc/docs/workflows-implementation.md

@@ -0,0 +1,171 @@
+# XMC Implementation Workflows (Phase 4)
+
+## Overview
+
+Phase 4 (Implementation) workflows manage the iterative sprint-based development cycle using a **story-centric workflow** where each story moves through a defined lifecycle from creation to completion.
+
+**Key principle:** One story at a time, move it through the entire lifecycle before starting the next.
+
+---
+
+## Complete Workflow Context
+
+Phase 4 is the final phase of the XiaoMa Method workflow. To see how implementation fits into the complete methodology:
+
+The XiaoMa Method consists of four phases working in sequence:
+
+1. **Phase 1 (Analysis)** - Optional exploration and discovery workflows
+2. **Phase 2 (Planning)** - Required requirements definition using scale-adaptive system
+3. **Phase 3 (Solutioning)** - Technical architecture and design decisions
+4. **Phase 4 (Implementation)** - Iterative sprint-based development with story-centric workflow
+
+Phase 4 focuses on the iterative epic and story cycles where stories are implemented, reviewed, and completed one at a time.
+
+For a visual representation of the complete workflow, see: [workflow-method-greenfield.excalidraw](images/workflow-method-greenfield.excalidraw)
+
+---
+
+## Quick Reference
+
+| Workflow            | Agent | When                  | Purpose                               |
+| ------------------- | ----- | --------------------- | ------------------------------------- |
+| **sprint-planning** | SM    | Once at Phase 4 start | Initialize sprint tracking file       |
+| **create-story**    | SM    | Per story             | Create next story from epic backlog   |
+| **dev-story**       | DEV   | Per story             | Implement story with tests            |
+| **code-review**     | DEV   | Per story             | Senior dev quality review             |
+| **retrospective**   | SM    | After epic complete   | Review lessons and extract insights   |
+| **correct-course**  | SM    | When issues arise     | Handle significant mid-sprint changes |
+
+---
+
+## Agent Roles
+
+### SM (Scrum Master) - Primary Implementation Orchestrator
+
+**Workflows:** sprint-planning, create-story, retrospective, correct-course
+
+**Responsibilities:**
+
+- Initialize and maintain sprint tracking
+- Create stories from epic backlog
+- Handle course corrections when issues arise
+- Facilitate retrospectives after epic completion
+- Orchestrate overall implementation flow
+
+### DEV (Developer) - Implementation and Quality
+
+**Workflows:** dev-story, code-review
+
+**Responsibilities:**
+
+- Implement stories with tests
+- Perform senior developer code reviews
+- Ensure quality and adherence to standards
+- Complete story implementation lifecycle
+
+---
+
+## Story Lifecycle States
+
+Stories move through these states in the sprint status file:
+
+1. **TODO** - Story identified but not started
+2. **IN PROGRESS** - Story being implemented (create-story → story-context → dev-story)
+3. **READY FOR REVIEW** - Implementation complete, awaiting code review
+4. **DONE** - Accepted and complete
+
+---
+
+## Typical Sprint Flow
+
+### Sprint 0 (Planning Phase)
+
+- Complete Phases 1-3 (Analysis, Planning, Solutioning)
+- PRD/GDD + Architecture complete
+- **V6: Epics+Stories created via create-epics-and-stories workflow (runs AFTER architecture)**
+
+### Sprint 1+ (Implementation Phase)
+
+**Start of Phase 4:**
+
+1. SM runs `sprint-planning` (once)
+
+**Per Epic:**
+
+- Epic context and stories are already prepared from Phase 3
+
+**Per Story (repeat until epic complete):**
+
+1. SM runs `create-story`
+2. DEV runs `dev-story`
+3. DEV runs `code-review`
+4. If code review fails: DEV fixes issues in `dev-story`, then re-runs `code-review`
+
+**After Epic Complete:**
+
+- SM runs `retrospective`
+- Move to next epic
+
+**As Needed:**
+
+- Run `workflow-status` anytime to check progress
+- Run `correct-course` if significant changes needed
+
+---
+
+## Key Principles
+
+### One Story at a Time
+
+Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
+
+### Quality Gates
+
+Every story goes through `code-review` before being marked done. No exceptions.
+
+### Continuous Tracking
+
+The `sprint-status.yaml` file is the single source of truth for all implementation progress.
+
+---
+
+### (XiaoMa Method / Enterprise)
+
+```
+PRD (PM) → Architecture (Architect)
+  → create-epics-and-stories (PM)  ← V6: After architecture!
+  → implementation-readiness (Architect)
+  → sprint-planning (SM, once)
+  → [Per Epic]:
+      → story loop (SM/DEV)
+      → retrospective (SM)
+  → [Next Epic]
+```
+
+---
+
+## Related Documentation
+
+- [Phase 1: Analysis Workflows](workflows-analysis.md)
+- [Phase 2: Planning Workflows](workflows-planning.md)
+- [Phase 3: Solutioning Workflows](workflows-solutioning.md)
+
+---
+
+## Troubleshooting
+
+**Q: Which workflow should I run next?**
+A: Run `workflow-status` - it reads the sprint status file and tells you exactly what to do.
+
+**Q: Story needs significant changes mid-implementation?**
+A: Run `correct-course` to analyze impact and route appropriately.
+
+**Q: Can I work on multiple stories in parallel?**
+A: Not recommended. Complete one story's full lifecycle before starting the next. Prevents context switching and ensures quality.
+
+**Q: What if code review finds issues?**
+A: DEV runs `dev-story` to make fixes, re-runs tests, then runs `code-review` again until it passes.
+
+---
+
+_Phase 4 Implementation - One story at a time, done right._