nhật ký dự án
Nhật ký dự án (project-logs.md) ghi lại mọi quyết định quan trọng, thay đổi kiến trúc và cột mốc trong hệ thống thiết kế 1thay. Nó đóng vai trò là bộ nhớ thể chế cho cả con người và tác nhân AI.
định dạng nhật ký
Mỗi mục ghi chép theo cấu trúc sau:
## session YYYY-MM-DD (time) — topic summary
### decisions
| # | area | decision | reason |
|---|---|---|---|
| N | area | what was decided | why |
### state after session
| metric | value |
|---|---|
| components | xem storybook |
| design tokens | xem check-tokens |
| ... | ... | khi nào cần ghi
Ghi nhật ký khi:
- Một nhóm component mới được tạo hoặc component được thêm/xóa
- Design token được thêm, đổi tên hoặc tái cấu trúc
- Các quyết định kiến trúc được đưa ra (công cụ build, quy trình làm việc, quy ước)
- Tài liệu được tái cấu trúc
- Một lỗi hoặc bài học quan trọng xảy ra
theo dõi trạng thái
Sau mỗi phiên làm việc, cập nhật bảng trạng thái với số liệu hiện tại:
components— tổng số + phân loại nhómdesign tokens— số lượng snapshot hiện tạibrands— số lượng chế độ thương hiệu đang hoạt độngastro pages— tổng số trangstories— tổng số storytests— tổng số bài kiểm tralint errors— luôn phải là 0
dành cho tác nhân
Khi thực hiện thay đổi trong dự án:
- Đọc các mục nhật ký mới nhất để lấy bối cảnh trước khi bắt đầu
- Thêm mục nhật ký mới ở đầu file khi hoàn thành
- Bao gồm mọi quyết định kèm lý do
- Cập nhật bảng trạng thái với số liệu chính xác (xác minh qua build)
- Đây không phải tùy chọn — tài liệu là một phần của hệ thống thiết kế