📘 Documentation Roadmap
[!TIP] This is the central entry point for all team members (DEV, BA, PM, PO, QA) to understand the project structure and reading order.
🗺️ Execution Flow
graph TD
subgraph P1[Phase 1: Core Product]
direction TB
D1["diagnosis-test.md (Logic)"]
D2["don-mu-vocabulary.md (Content)"]
D3["ai-coach-behavior.md (Personality)"]
end
subgraph P2[Phase 2: Technical Foundation]
direction TB
T1["database-schema.md"]
T2["user-flow.md"]
end
subgraph P3[Phase 3: Implementation Strategy]
MVP["/plan MVP Implementation"]
end
subgraph P4[Phase 4: Enhancements]
E1["gamification.md"]
E2["don-diec-listening.md"]
E3["don-cam-pronunciation.md"]
E4["don-yeu-phan-xa-conversation.md"]
E5["api-design.md"]
end
P1 --> P2
P2 --> P3
P3 --> P4
📑 Detailed Breakdown
Phase 1: Core Product (REQUIRED)
Focus: Business Logic & MVP Content
Prerequisites for understanding what we are building.
- diagnosis-test.md: Logic and scoring for the initial English placement test.
- don-mu-vocabulary.md: Structure for the "Don Mu" (Vocabulary) module and MVP content (3000 words).
- ai-coach-behavior.md: Definition of the AI Coach's personality, triggers, and feedback loop.
Phase 2: Technical Foundation (REQUIRED)
Focus: Architecture & Flows
Requires Phase 1 understanding.
- database-schema.md: Supabase PostgreSQL schema design and relationships.
- user-flow.md: Complete user journey maps and screen transition flows.
Phase 3: Implementation Strategy
Focus: Execution
Ready to generate the implementation plan for the MVP.
/plan --split --detailed "Implement Learn English Zero MVP:
- Don Mu (First 500 words)
- Diagnosis Test
- Basic AI Coach
Based on docs/designs/" --save=plans/
Phase 4: Enhancements (Post-MVP)
Focus: Advanced Features & Scalability
- gamification.md: Streaks, badges, and leaderboard logic.
- don-diec-listening.md: Listening skills module (Future).
- don-cam-pronunciation.md: Pronunciation analysis module (Future).
- don-yeu-phan-xa-conversation.md: Shadowing & Conversation module (Future).
- api-design.md: Backend API documentation (Future).
📊 Quick Summary
| Phase | Priority | Files | Description |
|---|---|---|---|
| 1 | 🔴 CRITICAL | diagnosis-test, don-mu-vocabulary, ai-coach |
Must Read First. Defines the product logic. |
| 2 | 🔴 CRITICAL | database-schema, user-flow |
Defines the technical architecture. |
| 3 | 🟡 RECOMMENDED | gamification + Future Docs |
Features for subsequent releases. |
| 4 | ⚪ OPTIONAL | api-design |
Technical reference. |
Note: A minimum of Phase 1 + Phase 2 (5 files) is required to run a comprehensive project plan.