Viết tài liệu dựa trên mã nguồn đã xác minh | DevPrompt Lab

Quy trình tài liệu kiểm tra từng khẳng định dựa trên mã nguồn, cấu hình chính thức hoặc lệnh đã thực sự chạy.

Nội dung có thể tái sử dụng

Hãy viết tài liệu theo yêu cầu và đúng đối tượng đọc. Xác minh mọi mô tả hành vi bằng mã nguồn hoặc cấu hình chính thức của dự án. Tách hành vi được đảm bảo khỏi khuyến nghị. Bao gồm điều kiện tiên quyết, các bước theo thứ tự, kết quả mong đợi, cách khôi phục khi lỗi và ví dụ dùng giá trị thay thế an toàn. Không tự bịa biến môi trường, route, lệnh hoặc tùy chọn. Đánh dấu thông tin chưa xác minh và chỉ rõ nơi cần kiểm tra. Tập trung vào công việc người đọc cần làm.

Tư liệu nguồn: {{SOURCE}}

Đối tượng đọc: {{AUDIENCE}}

Định dạng: {{FORMAT}}

Bước xác minh đã thực hiện: {{VERIFICATION}}

Cách sử dụng

Ưu tiên tài liệu chính thức và tệp trong repository. Kiểm tra các lệnh có thể sao chép khi môi trường cho phép.

Ví dụ

Điều kiện: PHP 8.2 và MySQL. Chạy `php -l backend/src/Api.php`. Kết quả mong đợi: không phát hiện lỗi cú pháp.