ARCHITECTURE.md
Tệp này là bản đồ cấp cao nhất của hệ thống. Nó nên ngắn gọn và trỏ đến các tài liệu sâu hơn khi cần.
Hình dạng Hệ thống
- Sản phẩm:
[thay thế bằng tên sản phẩm] - Workflow người dùng chính:
[thay thế bằng workflow chính] - Bề mặt runtime:
[desktop / web / cli / services / workers] - Nguồn sự thật cho hành vi sản phẩm:
docs/product-specs/
Bản đồ Domain
| Domain | Mục đích | Điểm đầu vào chính | Spec liên quan |
|---|---|---|---|
[domain-a] | [những gì nó sở hữu] | [modules / routes / commands] | [đường dẫn spec] |
[domain-b] | [những gì nó sở hữu] | [modules / routes / commands] | [đường dẫn spec] |
Mô hình Lớp
Sử dụng mô hình định hướng cố định để agent không tự phát minh ra kiến trúc ad hoc:
Types -> Config -> Repo -> Service -> Runtime -> UI
Các mối quan tâm xuyên suốt nên đi vào qua các ranh giới provider hoặc adapter rõ ràng thay vì tiếp cận trực tiếp qua các lớp.
Quy tắc Phụ thuộc Cứng
- Các lớp thấp hơn không được phụ thuộc vào các lớp cao hơn.
- UI không được bỏ qua các hợp đồng runtime hoặc service.
- Truy cập dữ liệu phải đi qua các repository hoặc adapter tương đương.
- Các tiện ích dùng chung phải là chung chung và không được tích lũy logic domain.
- Các phụ thuộc mới nên được chứng minh trong kế hoạch hoặc tài liệu thiết kế phù hợp.
Giao diện Xuyên suốt
| Mối quan tâm | Ranh giới được phê duyệt | Ghi chú |
|---|---|---|
| Logging và tracing | [đường dẫn provider / utility] | [chỉ có cấu trúc, không sử dụng console ad hoc] |
| Auth | [đường dẫn provider] | [quy tắc token/session] |
| External API | [đường dẫn client hoặc provider] | [hướng dẫn rate limit / retry] |
| Feature flags | [ranh giới flag] | [quyền sở hữu] |
Điểm Nóng Hiện tại
[khu vực khó thay đổi an toàn nhất cho agent][khu vực có ranh giới yếu hoặc test dễ vỡ]
Danh sách Kiểm tra Thay đổi
Khi bạn chạm vào mã liên quan đến kiến trúc:
- Cập nhật tệp này nếu bản đồ domain hoặc ranh giới được phép thay đổi.
- Cập nhật tài liệu thiết kế liên quan trong
docs/design-docs/nếu lý luận thay đổi. - Thêm hoặc cập nhật kiểm tra có thể thực thi nếu quy tắc nên được thực thi cơ học.