Giao diện
Tài liệu kỹ thuật PIDEAL
Kiến trúc, cơ sở dữ liệu, module nghiệp vụ, bảo mật và vận hành của hệ thống PIDEAL. Phần lớn nội dung sinh tự động từ source code, nên tài liệu không thể nói sai về code quá một pull request.
Bắt đầu từ đâu
| Bạn là | Đọc |
|---|---|
| Người mới vào dự án | PIDEAL là gì → Kiến trúc back-end → Cơ sở dữ liệu |
| Đang sửa một tính năng | Module của tính năng đó, rồi Tra cứu API |
| Rà soát bảo mật | Bảo mật & tiêu chuẩn |
| Muốn biết tài liệu này đáng tin đến đâu | Phạm vi & độ tin cậy |
Tài liệu này được làm thế nào
- Không gõ tay con số nào. Số bảng, số cột, số API, số quyền, số migration đều do bộ sinh đọc từ source. Ví dụ phần cơ sở dữ liệu: chạy toàn bộ migration lên PostgreSQL 17 rồi đọc
pg_catalog, chứ không đếm dòng SQL — migration là forward-only nên một đối tượng bị tạo và sửa nhiều lần, đếm dòng SQL ra số khác hẳn số đối tượng cuối cùng. - Mọi câu mô tả đều có nguồn:
COMMENT ONtrong migration, JSDoc trong code, hoặc một file trongdocs/. Chân mỗi trang ghi nguồn và commit đã sinh. - Chỗ source không nói gì thì ghi thẳng "Chưa có mô tả" và vào danh sách cần bổ sung. Không đoán.
- Gate trong CI chặn khi tài liệu lệch source (
docgen-check).
Giới hạn của tài liệu này được khai ở Phạm vi & độ tin cậy — đọc trang đó trước khi dùng tài liệu để ra quyết định.