🛠️ Hướng dẫn Phát triển (Developer Guide) - Dự án DX-VAS¶
Chào mừng đến với dự án DX-VAS!
Tài liệu này là "nguồn chân lý" dành cho tất cả các lập trình viên khi tham gia phát triển hệ thống. Mục tiêu của bộ hướng dẫn này là đảm bảo chúng ta xây dựng nên một sản phẩm có chất lượng cao, nhất quán, dễ bảo trì và có khả năng mở rộng.
Mọi thành viên, dù là từ đội ngũ DX-VAS hay từ đối tác Hoàng Vũ, đều phải tuân thủ các quy tắc và hướng dẫn được nêu trong đây.
"Code giỏi không chỉ là viết cho máy hiểu, mà còn là viết cho những người sẽ kế thừa và phát triển nó trong 5 năm tới." - Stephen Le
📚 Mục lục¶
Cây thư mục
/docs
|-- ... (ADR, architecture, etc.)
|-- /dev-guide/
| |-- README.md
| |-- 01-getting-started.md
| |-- 02-core-principles.md
| |-- 03-workflow-and-process.md
| |-- /technical-guides/
| | |-- 04-api-development.md
| | |-- 05-database-and-migrations.md
| | |-- 06-event-driven-development.md
| | |-- 07-logging-and-tracing.md
| | |-- 08-error-handling.md
| | |-- 09-configuration-and-secrets.md
| |-- /specialized-guides/
| | |-- 10-frontend-guide.md
| |-- /quality-and-operations/
| | |-- 11-testing-guide.md
| | |-- 12-security-checklist.md
| | |-- 13-ci-cd-pipeline.md
| | |-- 14-debugging-guide.md
| | |-- 15-troubleshooting-guide.md
| | |-- 16-incident-response.md
| | |-- 17-release-versioning.md
| |-- /productivity-and-tools/
| | |-- 18-local-dev-productivity.md
| | |-- 19-tooling-cheatsheet.md
|-- /process/
| |-- ONBOARDING.md
| |-- OFFBOARDING.md
|
|-- CONTRIBUTING.md
|-- README.md
...
Phần 1: Nền tảng & Quy trình (Foundation & Process)¶
Đây là những tài liệu bắt buộc phải đọc đối với mọi thành viên mới.
- 01 - Getting Started: Hướng dẫn cài đặt môi trường và chạy dự án.
- 02 - Core Principles: Các nguyên tắc vàng và tư duy kiến trúc cần tuân thủ.
- 03 - Workflow & Process: Quy trình làm việc với Git, Pull Request.
Phần 2: Hướng dẫn Kỹ thuật Cốt lõi (Core Technical Guides)¶
Đây là các "bộ luật" chi tiết cho việc phát triển backend service.
- 04 - API Development: Cách thiết kế và triển khai API.
- 05 - Database & Migrations: Quy trình làm việc với CSDL và schema migration.
- 06 - Event-Driven Development: Cách phát và tiêu thụ sự kiện qua Pub/Sub.
- 07 - Logging & Tracing: Quy chuẩn về ghi log và truy vết.
- 08 - Error Handling: Cách xử lý và trả về lỗi.
- 09 - Configuration & Secrets: Cách quản lý cấu hình và biến môi trường.
Phần 3: Hướng dẫn Chuyên biệt (Specialized Guides)¶
Các hướng dẫn dành cho các lĩnh vực phát triển cụ thể.
- 10 - Frontend Development Guide: Các quy ước riêng cho việc phát triển Frontend.
Phần 4: Đảm bảo Chất lượng & Vận hành (Quality & Operations)¶
Các quy trình và hướng dẫn để đảm bảo hệ thống ổn định và đáng tin cậy.
- 11 - Testing Guide: Chiến lược và hướng dẫn viết các loại test.
- 12 - Security Checklist: Danh sách kiểm tra bảo mật cho lập trình viên.
- 13 - CI/CD Pipeline & Operations: Hướng dẫn tương tác với pipeline và các môi trường.
- 14 - Debugging Guide: Hướng dẫn gỡ lỗi các vấn đề đã biết.
- 15 - Troubleshooting Guide: Phương pháp luận xử lý sự cố có hệ thống.
- 16 - Incident Response Guide: Quy trình phản ứng khi có sự cố nghiêm trọng.
- 17 - Release & Versioning Guide: Chiến lược đánh số phiên bản và quản lý release.
Phần 5: Năng suất & Công cụ (Productivity & Tools)¶
Các tài liệu tham khảo nhanh giúp tăng tốc độ làm việc.
- 18 - Local Dev Productivity Tips: Các mẹo để tăng năng suất khi phát triển local.
- 19 - Tooling Cheatsheet: Tổng hợp các lệnh và công cụ thường dùng.