Prompt viết tài liệu kỹ thuật và file README cho dự án

Bạn là kỹ sư phần mềm giàu kinh nghiệm, viết tài liệu rõ ràng cho người mới. Hãy viết file README.md bằng tiếng Việt cho dự án sau.
- Tên và mục đích: [mô tả ngắn]
- Công nghệ: [ngôn ngữ, framework]
- Cấu trúc thư mục: [dán cây thư mục]
- Cách cài đặt và chạy đã dùng được: [dán các lệnh thật]
- Biến môi trường cần có: [tên biến, không ghi giá trị thật]
Bố cục: Giới thiệu, Tính năng, Yêu cầu, Cài đặt, Cách dùng, Cấu trúc thư mục, Đóng góp, Giấy phép. Chỉ viết những gì tôi đã cung cấp. Chỗ nào thiếu thông tin hãy ghi “TODO: cần bổ sung” thay vì đoán.

Viết mục “Cài đặt” trong README cho người chưa quen dòng lệnh, hệ điều hành Windows 11. Dựa trên các lệnh thật sau: [dán lệnh]. Đánh số từng bước, giải thích mỗi lệnh dùng để làm gì trong một câu, và ghi rõ chỗ người dùng phải tự thay bằng giá trị của mình. Thêm mục “Lỗi thường gặp” với 3 lỗi tôi từng gặp: [liệt kê].

README hiện tại của tôi quá dài: [dán nội dung]. Hãy tái cấu trúc để 10 dòng đầu trả lời được 3 câu hỏi: dự án làm gì, chạy thử thế nào, đọc tiếp ở đâu. Chuyển phần chi tiết sang các mục phía dưới. Giữ nguyên mọi lệnh và số phiên bản.

Dưới đây là chữ ký hàm và mô tả ngắn các hàm trong module [tên module]: [dán danh sách]. Hãy viết tài liệu tham chiếu gồm: mục đích, tham số (tên, kiểu, bắt buộc hay không), giá trị trả về, lỗi có thể xảy ra, và một ví dụ gọi hàm ngắn. Nếu thông tin nào tôi chưa cung cấp, ghi “chưa rõ” và liệt kê câu hỏi để tôi bổ sung.

Tôi cần tài liệu giới thiệu kiến trúc hệ thống cho thành viên mới. Hệ thống gồm: [các thành phần và cách chúng nối với nhau]. Hãy viết khoảng 400 từ gồm bức tranh tổng thể, luồng dữ liệu chính từ người dùng đến cơ sở dữ liệu, và 5 điều cần biết trước khi sửa code. Thêm sơ đồ dạng văn bản (ASCII) hoặc danh sách luồng.

Viết tài liệu vận hành (runbook) cho dịch vụ [tên dịch vụ] gồm: cách kiểm tra dịch vụ đang chạy, cách khởi động lại an toàn, các dấu hiệu lỗi thường gặp và việc cần làm, khi nào phải báo cho người phụ trách. Dựa trên thông tin thật: [thông tin]. Lệnh nào có thể ảnh hưởng dữ liệu phải có cảnh báo in đậm.

Từ danh sách commit hoặc thay đổi sau: [dán danh sách], hãy viết ghi chú phát hành (changelog) bằng tiếng Việt, nhóm theo Tính năng mới, Sửa lỗi, Thay đổi có thể ảnh hưởng người dùng. Mỗi mục một dòng, ngôn ngữ người dùng dễ hiểu, không thêm thay đổi nào ngoài danh sách.

Soạn file CONTRIBUTING.md ngắn cho dự án [tên dự án]: cách báo lỗi (cần cung cấp gì), cách đề xuất tính năng, quy ước đặt tên nhánh và viết thông điệp commit theo thói quen của nhóm: [mô tả quy ước], và checklist trước khi gửi yêu cầu hợp nhất.