Từ code hiện tại, suy ra mục đích, interface, phụ thuộc và lưu ý thay đổi để tạo tài liệu rõ ràng cho dev.
Điền thông tin của bạn
Prompt
Bạn là kỹ sư phần mềm kiêm người viết tài liệu kỹ thuật. Hãy đọc code trong {{pham_vi_thu_muc_hoac_file}} và viết tài liệu cho module dựa trên những gì có thể suy ra trực tiếp từ mã nguồn. Mục tiêu là làm rõ module dùng để làm gì, các interface hoặc hàm chính, dữ liệu đầu vào đầu ra, các phụ thuộc quan trọng, và những lưu ý cần biết trước khi thay đổi. Hãy mô tả luồng xử lý theo cách dễ hiểu cho dev mới, nhưng không thổi phồng chức năng ngoài những gì code chứng minh được. Nếu có phần hành vi không rõ, hãy ghi chú là chưa đủ thông tin thay vì đoán. Tài liệu nên ngắn gọn nhưng đủ dùng để người khác bắt đầu làm việc, đồng thời chỉ ra các điểm dễ gây lỗi khi sửa. Trả về: 1) mô tả mục đích module, 2) danh sách thành phần chính, 3) phụ thuộc quan trọng, 4) luồng xử lý tóm tắt, 5) lưu ý khi chỉnh sửa.
Tài liệu mô tả module payments là nơi xử lý tạo yêu cầu thanh toán, nhận phản hồi và cập nhật trạng thái. Liệt kê các hàm chính, phụ thuộc vào gateway client và repository, cùng lưu ý không đổi thứ tự ghi trạng thái khi chưa kiểm tra test.
Cách sử dụng
Chỉ rõ thư mục hoặc file cần tài liệu rồi dán vào Codex. Sau khi có kết quả, đối chiếu tài liệu với code thật, nhất là tên hàm, luồng xử lý và phụ thuộc, để tránh mô tả vượt quá những gì mã nguồn chứng minh.
Giải thích cấu trúc
Role: người đọc và biên soạn tài liệu kỹ thuật từ code. Context: module phức tạp nhưng ít mô tả, cần tài liệu dựa trên bằng chứng trong mã nguồn. Task: suy ra mục đích, interface, phụ thuộc, luồng xử lý và lưu ý chỉnh sửa. Constraints: không suy đoán vượt code, ghi chú khi thiếu dữ liệu, tài liệu ngắn gọn nhưng hữu ích. Output: mô tả mục đích, thành phần chính, phụ thuộc, luồng xử lý và lưu ý khi sửa.
Mẹo sử dụng
Nếu thư mục lớn, hãy khoanh vùng file trọng tâm để kết quả không bị loãng.
Yêu cầu liệt kê tên hàm hoặc lớp chính để tài liệu bám sát code.
Nhắc Codex chỉ mô tả những gì quan sát được từ mã nguồn.
Đọc lại tài liệu cùng một dev khác để phát hiện chỗ suy diễn quá mức.
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.
