Chuyển tới nội dung chính

DevLink Backend Documentation

Tài liệu kỹ thuật và nghiệp vụ của DevLink, nền tảng tuyển dụng IT tại Việt Nam. Repository này là backend NestJS; tài liệu giúp bạn hiểu hệ thống vận hành thế nào, từ nghiệp vụ tuyển dụng đến kiến trúc, dữ liệu, AI và xử lý bất đồng bộ.

Mục lục đầy đủ ở SUMMARY.md. Đọc báo cáo bao phủ để biết phần nào đã xác minh, phần nào chưa, và các phát hiện quan trọng từ việc đối chiếu code.

Bắt đầu theo vai trò​

Bạn làĐọc theo thứ tự
Người chưa biết dự ánTổng quan dự án, rồi Bối cảnh hệ thống
Developer mớiChạy thử, Môi trường local, Cấu trúc dự án, Tổng quan kiến trúc
Tech Lead hoặc reviewerTổng quan kiến trúc, Công nghệ và lý do, Khả năng mở rộng
Người đóng gópHướng dẫn viết tài liệu, Quy trình phát triển
Người vận hànhTriển khai, Checklist bảo mật, Xử lý sự cố

Các khu vực tài liệu​

Khu vựcNội dungTrạng thái
00-getting-startedGiới thiệu, chạy thử, môi trường local, cấu trúc dự ánCó
01-productVai trò người dùng, tính năng, quy tắc nghiệp vụCó
02-architectureSơ đồ C4, phụ thuộc module, luồng dữ liệu, cache, bất đồng bộ, công nghệ, quan sát, mở rộngCó
03-modulesGiải thích từng moduleCó (17 tài liệu)
04-databaseData dictionary 17 collection, quan hệ, indexCó
05-api116 route theo từng controller, thời gian thựcCó
06-workflowsUse case, sequence, state diagramCó
07-integrationsAI, email, Google, nguồn tin, SentryCó
08-securityXác thực, phân quyền, bảo vệ dữ liệu, checklistCó
09-infrastructureDocker, CI/CD, triển khaiCó
10-testingChiến lược và thống kê testCó
11-operationsHealth check, xử lý sự cố, sao lưuCó
12-decisionsQuyết định kiến trúc (ADR)Có
13-contributingQuy chuẩn viết tài liệu và quy trình phát triểnCó
14-referenceThuật ngữ, biến môi trường, đối chiếu tài liệu cũCó

Quy ước độ tin cậy​

Mỗi tài liệu dùng năm nhãn để phân biệt hiện trạng với kế hoạch: Current Implementation, Design Decision, Known Limitation, Future Improvement, Chưa xác minh. Xem định nghĩa trong documentation-guide.md.

Khi tài liệu và code khác nhau, code đúng. Hãy sửa tài liệu trong cùng Pull Request.

Tài liệu cũ​

Thư mục docs/ từng chứa 171 ghi chú theo giai đoạn phát triển. Chúng đã được phân loại và chuyển vào docs/archive/ (chỉ có ở local), xem legacy-docs-migration. Đừng xem chúng là nguồn chính thức.