Đối chiếu README với code và cấu hình để sửa hướng dẫn sai, bổ sung điều kiện chạy đúng và làm rõ cách dùng thực tế.
Điền thông tin của bạn
Prompt
Bạn là kỹ sư tài liệu kỹ thuật kiêm người đọc mã nguồn. Hãy đối chiếu nội dung README với mã nguồn, file cấu hình, script và cách chạy hiện có trong repository để viết lại tài liệu sao cho khớp thực tế. Mục tiêu là loại bỏ hướng dẫn sai, giảm chỗ mơ hồ, nêu rõ các điều kiện cần có để chạy thành công, và chỉ giữ lại những bước người dùng thật sự cần. Nếu có nhiều cách chạy, hãy phân biệt rõ cách nào là mặc định, cách nào chỉ dùng cho môi trường phát triển, kiểm thử hoặc triển khai. Khi phát hiện README đang mô tả tính năng không còn tồn tại, hãy thay bằng mô tả đúng hiện trạng; nếu thiếu thông tin quan trọng, hãy ghi chú rõ phần còn cần xác minh thay vì suy đoán. Đầu ra cần là bản README đã chỉnh sửa với cấu trúc rõ ràng, câu chữ ngắn gọn, thực dụng và nhất quán với repository.
Biến đầu vào:
- {{readme_hien_tai}}: nội dung README hiện có
- {{cau_hinh_du_an}}: các file cấu hình liên quan như package, build, env, CI, Docker hoặc tương đương
- {{cach_chay_thuc_te}}: mô tả hoặc log cho thấy cách dự án đang được chạy thành công
- {{ghi_chu_bat_thuong}}: các điểm lệch giữa tài liệu và code, nếu đã phát hiện
Yêu cầu sửa đổi:
1. Giữ giọng văn kỹ thuật rõ ràng, không quảng cáo, không dài dòng.
2. Ưu tiên thực tế đang chạy được hơn mô tả cũ.
3. Chỉ nêu lệnh, biến môi trường, cấu hình và điều kiện cần thiết thật sự tồn tại trong repo.
4. Nếu có chỗ phụ thuộc môi trường, nêu điều kiện cụ thể để người đọc tự kiểm tra.
5. Không bịa thêm chức năng, không suy đoán logic chưa thấy trong mã nguồn.
6. Hãy trả lại nội dung README hoàn chỉnh hoặc danh sách thay đổi có thể áp dụng trực tiếp.
Định dạng đầu ra mong muốn:
- Tiêu đề chính
- Mô tả ngắn về dự án
- Yêu cầu hệ thống và phụ thuộc
- Cài đặt
- Cách chạy
- Cấu hình
- Kiểm thử nếu có
- Lưu ý lỗi thường gặp và điều kiện chạy thành công
README hiện tại nói rằng dự án chạy bằng npm start, nhưng package.json có script dev và test; log thực tế cho thấy cần NODE_ENV=development để khởi động.
Output mẫu
README được sửa để nêu cài đặt bằng npm install, chạy bằng npm run dev, kiểm thử bằng npm test, đồng thời ghi rõ NODE_ENV=development là điều kiện cần cho bước khởi động.
Cách sử dụng
Điền README, cấu hình và cách chạy thực tế vào đúng biến. Dán prompt vào Codex hoặc công cụ sửa tài liệu trong repo, rồi kiểm tra lại phần lệnh, biến môi trường và mô tả tính năng có khớp code hiện hành hay không.
Giải thích cấu trúc
Role: biên soạn viên tài liệu kỹ thuật bám repo. Context: README đang lệch so với trạng thái code và cấu hình thực. Task: viết lại tài liệu đúng hiện trạng, làm rõ điều kiện chạy. Constraints: không bịa chức năng, không thêm hướng dẫn không có căn cứ, chỉ nêu thông tin xác minh được. Output: README hoàn chỉnh hoặc nội dung chỉnh sửa có thể áp dụng trực tiếp.
Mẹo sử dụng
So khớp từng lệnh trong README với script thật trong package hoặc file tương đương.
Ưu tiên mô tả điều kiện chạy thành công hơn là mô tả ý định ban đầu của dự án.
Nếu có nhiều môi trường, tách rõ dev, test và production để tránh nhầm lẫn.
Nguồn và giấy phép
ONTER biên tập · original
Đánh giá prompt
Chọn số sao theo trải nghiệm của bạn. Bạn có thể sửa đánh giá sau một phút.