Documentation Index
Thư mục docs/ chia làm 2 lớp:
docs/requirements/: tài liệu yêu cầu (SRS) và roadmap (đã có).docs/*.md: tài liệu triển khai theo chuẩn dự án (foundation) — ngắn gọn, trỏ về requirements để tránh trùng lặp.
Core docs
ARCHITECTURE.md: kiến trúc tổng thể, boundaries của microservices, conventions.DEVELOPMENT.md: hướng dẫn dev local (NX, env, lint/test).INFRASTRUCTURE.md: Docker Compose, ports, credentials, troubleshooting.API.md: conventions API, response/error format, versioning.DATABASE.md: chiến lược DB per service, migrations/seeders, naming.TESTING.md: chiến lược test (unit/integration/e2e), utilities.DEPLOYMENT.md: CI/CD, envs, release strategy.SECURITY.md: authn/authz, secrets, hardening.OBSERVABILITY.md: logging, tracing, metrics (OpenTelemetry + SigNoz).TROUBLESHOOTING.md: lỗi thường gặp & cách xử lý.
Requirements (SRS)
Xem:
requirements/01-OVERVIEW.mdrequirements/02-FUNCTIONAL-REQUIREMENTS.mdrequirements/03-NON-FUNCTIONAL-REQUIREMENTS.mdrequirements/04-API-SPECIFICATIONS.mdrequirements/05-DATABASE-SCHEMA.mdrequirements/06-SYSTEM-DESIGN.mdrequirements/07-SECURITY-REQUIREMENTS.mdrequirements/08-DEPLOYMENT-REQUIREMENTS.mdrequirements/CHECKLIST.mdrequirements/IMPLEMENTATION-ROADMAP.md