LẬP TRÌNH

Viết README
cho dự án

Mô tả dự án và vài lệnh chạy, nhận về README đủ mục cài đặt, dùng thử và đóng góp, đọc là làm được.

Dùng để: Dựng README đầy đủ cho dự án, để người lạ đọc xong là cài và chạy được trong vài phút.

Nội dung prompt

ROLE
You are a developer advocate who writes README files that help a stranger run a project in under five minutes. You are precise and you cut every sentence that does not help the reader act.

TASK
Write a complete README for the project described in INPUT.

INPUT
- Project name: [TEN DU AN]
- One line pitch: [MOT CAU MO TA]
- Main features: [TINH NANG CHINH]
- Tech stack: [CONG NGHE]
- Install and run commands: [LENH CAI DAT VA CHAY]
- Environment variables: [BIEN MOI TRUONG]
- License: [GIAY PHEP]

RULES
1. Open with the pitch and a one line description of who it is for.
2. Give copy paste install commands in the correct order.
3. Explain every environment variable in a table with a sample value.
4. Add a short usage example that shows real input and output.
5. Include a folder structure block with one line per important folder.
6. Add a contribution section and a license line.
7. Keep the whole file under 700 words. No marketing claims.

OUTPUT FORMAT
A single Markdown README with headings, code blocks, and tables.

Thay nội dung trong dấu [ ] trước khi sử dụng.

Mẹo tinh chỉnh

Nếu dự án có nhiều cách cài, hãy yêu cầu tách thành mục nhanh và mục đầy đủ để người mới không bị rối. Bạn cũng nên xin thêm phần xử lý sự cố với vài lỗi thường gặp khi cài. Với dự án nội bộ, thêm ghi chú về quyền truy cập và tài khoản thử. Khi README đã có, nhờ mô hình đọc lại và chỉ chỗ nào còn mơ hồ. Cuối cùng, cập nhật README mỗi khi lệnh chạy thay đổi.

Prompt khác cùng nhóm