Skip to content

Tài liệu & Quy ước

  • Hợp đồng API: Duy trì các đặc tả OpenAPI/Swagger rõ ràng cho API. AI sử dụng chúng để tạo client và xác thực yêu cầu/phản hồi.
  • Đặt tên Nhất quán: Sử dụng tên có thể dự đoán được cho biến, hàm, lớp, tệp và module.
  • Định dạng Mã nguồn: Thực thi một trình định dạng nghiêm ngặt (Prettier, Black, v.v.) để mã do AI tạo ra khớp với phong cách của dự án.
  • JSDoc/Docstrings: Thêm nhận xét giải thích logic phức tạp hoặc quy tắc nghiệp vụ. AI thường có thể tận dụng chúng để hiểu rõ hơn.
  • READMEs: Ghi lại trách nhiệm của module/tính năng trong các tệp README bên trong thư mục tính năng.

Xây dựng với VitePress