Mục tiêu

Prompt này được thiết kế để yêu cầu AI phân tích mã nguồn hiện có và chuyển hóa thành tài liệu API rõ ràng, có cấu trúc, dễ dùng cho lập trình viên, QA và đội tích hợp. Kết quả đầu ra nên ưu tiên tính chính xác, khả năng đọc nhanh và dễ đồng bộ với quy ước nội bộ.

Khi nào nên dùng

• Khi dự án đã có code nhưng tài liệu API còn thiếu hoặc rời rạc.
• Khi cần chuẩn hóa cách mô tả endpoint, request, response và lỗi.
• Khi muốn tạo tài liệu onboarding cho team mới hoặc đối tác tích hợp.
• Khi cần rút ngắn thời gian viết docs thủ công từ mã nguồn.

Hướng dẫn tùy biến

Bạn có thể thay đổi ngôn ngữ đầu ra, mức độ chi tiết, định dạng trình bày và chuẩn tài liệu theo nhu cầu. Nếu dự án có framework cụ thể, hãy thêm thông tin về cấu trúc thư mục, quy ước đặt tên, kiểu auth, versioning và ví dụ request thực tế để AI suy luận chính xác hơn.

• Thêm tiêu chuẩn đầu ra như Markdown, bảng, hay cấu trúc theo OpenAPI.
• Yêu cầu AI chỉ dựa trên mã nguồn và không bịa thông tin nếu thiếu dữ liệu.
• Chỉ định rõ đối tượng đọc: backend, frontend, QA, khách hàng hay đối tác.
• Bổ sung yêu cầu sinh ví dụ request/response ngắn gọn hoặc đầy đủ.

Lưu ý

• AI có thể suy luận sai nếu code thiếu comment, type hoặc naming không rõ ràng.
• Nên yêu cầu AI đánh dấu phần không chắc chắn thay vì tự suy đoán.
• Với hệ thống lớn, nên chia nhỏ theo module hoặc nhóm endpoint để tránh quá tải ngữ cảnh.
• Nếu có tài liệu cũ, hãy cung cấp để AI đối chiếu và tránh lệch chuẩn.

Giá trị chính

Prompt này giúp bạn tiết kiệm thời gian viết docs, tăng độ đồng nhất và tạo ra tài liệu API có thể dùng ngay cho nội bộ hoặc chia sẻ với bên ngoài.