Mục tiêu

Prompt này được thiết kế để yêu cầu AI phân tích source code và chuyển đổi thành tài liệu kỹ thuật có cấu trúc, dễ đọc, dễ bảo trì. Kết quả đầu ra có thể dùng cho README, tài liệu kiến trúc, tài liệu module, mô tả API, hướng dẫn triển khai hoặc bàn giao kỹ thuật.

Khi nào nên dùng

• Khi dự án đã có source code nhưng thiếu tài liệu mô tả hệ thống.
• Khi cần chuẩn hóa tài liệu cho onboarding thành viên mới.
• Khi muốn tạo tài liệu bàn giao nhanh từ mã nguồn hiện có.
• Khi cần tóm tắt luồng xử lý, phụ thuộc và vai trò từng module.
• Khi muốn AI hỗ trợ viết tài liệu kỹ thuật nhất quán theo template.

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

Bạn có thể thay đổi loại tài liệu đầu ra tùy nhu cầu, ví dụ: README cho dự án mã nguồn mở, tài liệu nội bộ cho team, hoặc tài liệu API cho backend service. Nếu source code lớn, hãy yêu cầu AI xử lý theo từng thư mục hoặc từng module để kết quả chính xác hơn.

Nên bổ sung ngữ cảnh như ngôn ngữ lập trình, framework, kiến trúc hệ thống, đối tượng người đọc và mức độ chi tiết mong muốn. Nếu có quy ước tài liệu sẵn, hãy đưa vào prompt để AI bám sát phong cách hiện tại.

Lưu ý

• AI chỉ nên mô tả những gì có thể suy ra từ source code và thông tin được cung cấp.
• Không nên yêu cầu AI tự bịa ra chi tiết kiến trúc nếu mã nguồn không đủ dữ liệu.
• Với dự án lớn, nên chia nhỏ theo package, service hoặc repository.
• Để tài liệu chính xác hơn, hãy cung cấp thêm cấu trúc thư mục, file chính và mục tiêu của tài liệu.

Gợi ý đầu ra tốt

Một tài liệu kỹ thuật tốt nên có: tổng quan, phạm vi hệ thống, cấu trúc thư mục, mô tả module, luồng nghiệp vụ, API chính, phụ thuộc, cách chạy, cấu hình môi trường, điểm cần lưu ý và phần đề xuất cải tiến.

Prompt dưới đây có thể dùng ngay hoặc tùy biến cho nhiều AI khác nhau để tạo, viết lại và chuẩn hóa tài liệu từ source code.