Prompt miễn phí
Viết tài liệu cho module phức tạp từ code hiện có
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.
Prompt dùng để làm gì?
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
Input mẫu
Output mẫu
"loai_mau": "Minh họa cấu trúc kết quả mong đợi; không phải log thực thi hoặc benchmark model",
"ket_qua_minh_hoa": "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.",
"kiem_chung_can_lam": "Mọi mô tả interface, dependency và side effect phải truy ngược được tới code; đánh dấu phần chưa đọc được."
}
Cách sử dụng
Mọi mô tả interface, dependency và side effect phải truy ngược được tới code; đánh dấu phần chưa đọc được. Chỉ dùng mã, log và fixture được phép chia sẻ. Phân biệt đề xuất với thay đổi đã áp dụng; chỉ ghi PASS khi có lệnh chạy và kết quả thực tế.
Giải thích cấu trúc
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.
Prompt liên quan
Phân tích module lớn và đề xuất tách trách nhiệm
Đề xuất cách chia nhỏ module quá tải thành các phần rõ trách nhiệm, kèm thứ tự triển khai an toàn và tiêu chí hoàn thành.
Kiểm tra phân quyền theo vai trò trong luồng quản trị
Rà soát logic phân quyền ở màn hình và endpoint quản trị, phát hiện quyền thiếu, sai hoặc không nhất quán.
Chuẩn hóa tên biến và hàm cho module lõi
Đổi tên biến, hàm, hằng số theo quy ước thống nhất để code dễ hiểu hơn mà không đổi hành vi.
Ghi chú tài liệu cho API công khai khó hiểu
Tạo chú thích ngắn, đúng chức năng cho hàm và class công khai để người dùng nội bộ hiểu cách gọi, tham số, giá trị trả về và lỗi.
