Documentation Index
Tài liệu tổ chức theo 7 nhóm:
| Nhóm | Mục đích | Thư mục |
|---|---|---|
| Product | Tầm nhìn, business, PRD | product/ |
| Architecture | Technical design, API, data model | architecture/ |
| Flows | Nghiệp vụ end-to-end | flows/ |
| Rules | Conventions bắt buộc | rules/ |
| Operations | Setup, deploy, onboarding | operations/ |
| Mobile | Plan cho mobile app (owner + staff) | mobile/ |
| Progress | Tiến độ, changelog | progress/ |
Product — Tầm nhìn & PRD
| Doc | Nội dung |
|---|---|
product/product-brief.md |
Business context, target users, MVP scope |
product/prd.md |
User stories, acceptance criteria, API mapping |
Architecture — Technical Design
| Doc | Nội dung |
|---|---|
architecture/architecture.md |
Tech stack, system design, module structure |
architecture/role-matrix.md |
BẮT BUỘC — Ma trận quyền endpoint × role × action (audit pending) |
architecture/api-design.md |
BẮT BUỘC — API conventions, response envelope, error codes |
architecture/payment-architecture.md |
BẮT BUỘC — DDD + Hexagonal Payment bounded context |
architecture/tech-versions.md |
Pinned versions, breaking change notes |
Flows — Nghiệp vụ End-to-End
| Doc | Nội dung |
|---|---|
flows/booking-flow.md |
BẮT BUỘC — Booking create/update, settings enforcement, integration events |
flows/booking-status-flow.md |
BẮT BUỘC — State machine, transitions, guards, role matrix |
flows/payment-flow.md |
BẮT BUỘC — Payment flows, sequence diagrams, error scenarios |
flows/loyalty-flow.md |
Loyalty redemption + auto-earn lifecycle |
flows/status-matrix/ |
Bức tranh toàn cảnh — transition matrix theo status × payment × performer + gaps-and-plan.md |
Rules — Conventions Bắt Buộc
| Doc | Nội dung |
|---|---|
rules/development-rules.md |
BẮT BUỘC — Git, testing, code quality, ESLint, PR rules |
rules/ui-conventions.md |
BẮT BUỘC — Admin UI design system |
rules/task-workflow.md |
BẮT BUỘC — Quy trình 7 phases cho mọi task |
Operations — Setup & Deploy
| Doc | Nội dung |
|---|---|
operations/onboarding.md |
Clone, install, chạy local dev |
operations/owner-onboarding.md |
Salon owner onboarding flow |
operations/deploy-vps.md |
VPS deployment guide |
operations/deploy-docs-site.md |
Deploy static docs site (PM2 + Nginx) — documents.<domain> |
operations/gitnexus-setup.md |
GitNexus code intelligence setup |
Mobile — Plan cho Mobile App
| Doc | Nội dung |
|---|---|
mobile/admin-settings-inventory.md |
Inventory toàn bộ cài đặt đang quản lý trên /admin + mức ưu tiên khi port lên mobile |
mobile/feature-plan.md |
Kiến trúc thông tin + phân pha MVP/V1/V2 cho owner + staff app, milestone, dependencies backend |
Progress — Tiến Độ
| Doc | Nội dung |
|---|---|
progress/features.md |
Feature overview & status |
progress/changelog.md |
Development history, test coverage |
progress/testing.md |
Test inventory (unit / integration / E2E) across all repos |