Viết README để 3 tháng sau còn làm tiếp được

Khi nào dùng

Khi dự án đã chạy được, và cập nhật sau mỗi thay đổi lớn.

Chuẩn bị

Dự án đã chạy; NOTES.md có ghi các quyết định.

Prompt

Viết README.md cho dự án này, cho người đọc là chính tôi sau 3 tháng không đụng vào
(tôi không chuyên lập trình). Dựa trên mã nguồn, BRIEF.md và NOTES.md.

Các mục:
1. Dự án là gì (2-3 câu).
2. Chạy trên máy: cài gì, lệnh nào, mở địa chỉ nào. Từng bước.
3. Cấu trúc thư mục: chỉ các file/thư mục quan trọng, mỗi cái một dòng giải thích.
4. Sửa nội dung thường gặp: đổi chữ, đổi ảnh, đổi số điện thoại nằm ở đâu.
5. Deploy: dịch vụ nào, quy trình, cách quay lại bản trước.
6. Biến môi trường: tên biến và mục đích (KHÔNG ghi giá trị).
7. Quyết định quan trọng và lý do.
8. Hạn chế đã biết.

Chỉ ghi những gì có thật trong dự án. Lệnh nào bạn không chắc chạy được thì đánh dấu [CẦN KIỂM].

Kết quả tốt trông thế nào

• Bạn làm theo README trên máy khác mà chạy được.
• Có mục “sửa nội dung thường gặp” cho việc hằng ngày.

Dấu hiệu AI làm sai

• README chung chung kiểu mẫu, có lệnh không tồn tại trong dự án.
• Ghi giá trị bí mật vào README.

Bước tiếp theo

Tự làm theo README từ đầu một lần để kiểm.