SMP Process Documentation¶
Tài liệu chuẩn hoá process cho team SMP (10+ người · BA, Dev, QC, DevOps, Security, Finance, Legal) sử dụng Go + MySQL + Redis + MongoDB.
Mục đích¶
Tài liệu này:
- Chuẩn hoá how-to-build cho 6 vai trò
- Reference cho onboarding member mới
- Single source of truth cho decisions kỹ thuật
- Tiền đề cho audit, compliance, scaling
Quick start¶
🌟 Đọc đầu tiên (tất cả vai trò)¶
Doc 00 · System Functional Overview — Executive summary 30-45 phút mô tả toàn bộ chức năng hệ thống SMP. Đọc trước khi đi sâu vào các docs kỹ thuật khác.
Theo vai trò¶
| Role | Priority docs |
|---|---|
| Dev mới onboard | 00 → 05 (glossary) → 01 (architecture) → 04 (setup) → 03 (API) → 02 (DB) |
| Backend | 00 → 03 (API) → 02 (DB) → 08 (auth) → 15 (rules) → 16-18 (finance) |
| Frontend | 00 → 05 → 03 (API) → 08 (auth) → 09 (user stories) |
| QA | 00 → 09 (stories) → 15 (rules) → 10 (test plan) → 11 (runbook) |
| DevOps / SRE | 00 → 01 (arch) → 06 (env) → 07 (CI/CD) → 11 (runbook) → 13 (encryption) |
| Security | 00 → 01 → 08 (auth) → 12 (audit) → 13 (encryption) → 21 (PDPL) |
| Finance | 00 → 16 (ledger) → 17 (lifecycle) → 14 (KPI) → 20 (COD policy) |
| BA / PM | 00 → 05 (glossary) → 09 (stories) → 14 (KPI) → 15 (rules) |
Doc map · 22 docs trong 10 categories¶
🌟 Start here¶
🏛️ Architecture¶
🗄️ Database¶
⚙️ Backend¶
📊 BA · Business Analyst¶
- 05 · Glossary
- 09 · User Stories + Acceptance Criteria
- 14 · KPI / Metrics Definition
- 15 · Business Rules (80+ rules)
🧪 QA¶
🎨 Frontend (Mobile)¶
- 23 · Multi-agent Mobile Wireframes
- 24 · Multi-agent Mobile Mockup
- 26 · Warranty Package Mobile Mockup
- 27 · Warranty Packages Comparison
🚀 DevOps¶
🔒 Security¶
💰 Finance¶
- 16 · Finance Ledger Spec
- 17 · Payment & Settlement Lifecycle
- 18 · Event Catalog
- 22 · Multi-agent Sample Data
- 25 · Warranty Packages Sample Data
- 28 · Ops Training: Warranty Claims
📜 Legal & Compliance (DRAFT)¶
⚠️ Legal disclaimer: 3 docs Legal là bản thảo định hình chính sách, KHÔNG phải tư vấn pháp lý. Mọi điều khoản công bố cho KH/thợ/partner phải qua luật sư VN rà soát.
Tech stack tham chiếu¶
| Layer | Technology |
|---|---|
| Backend language | Go (Gin/Echo · gRPC internal) |
| Primary DB | MySQL 8.0 (transactional · 5 schemas: smp_order, smp_catalog, smp_agent, smp_partner, smp_geo) |
| Cache + queue | Redis 7 (cache, distributed lock, BullMQ-style queue) |
| Analytics + logs | MongoDB 6 (event logs, metrics, audit trail) |
| Auth | OAuth 2.1 + JWT (RS256) + RBAC |
| Deploy | Kubernetes (GitOps + ArgoCD + Helm) |
| Observability | Prometheus + Grafana + Loki + Tempo |
| Frontend | Mobile prototype (HTML/JS) → native iOS/Android (planned) |
| Admin | Vanilla HTML/JS/CSS (no framework) |
Documentation conventions¶
Doc numbering¶
Mỗi doc có 1 số duy nhất (00-28) trong tên file. Số không bao giờ tái sử dụng để dễ trace history.
Audience tags¶
Mỗi doc khai báo target audience ở đầu file (All / Backend / Frontend / DevOps / Security / Finance / Legal / BA / QC).
Status tags¶
- ✅ STABLE — đã review, sẵn sàng implement
- 📋 DRAFT — đang collect feedback
- ⚠️ REVIEW PENDING — chờ stakeholder review (đặc biệt Legal docs cần VN lawyer)
Cross-references¶
Dùng relative path: [Doc 01](./01-architecture/01-architecture.md). KHÔNG dùng tên file đầy đủ hoặc URL tuyệt đối.
Đóng góp¶
Xem Contributing Guide để biết: - Markdown style rules - Cách đặt tên doc mới - PR review process
License¶
Internal Use Only · © 2026 SMP Team