Một báo cáo lỗi tốt cần có những gì?

Một báo cáo lỗi tốt giúp lập trình viên hiểu, tái hiện và đánh giá mức ưu tiên mà không cần hỏi thêm.

Cần có:

• Tiêu đề rõ ràng, cụ thể nêu triệu chứng và vị trí, ví dụ "Nút thanh toán bị vô hiệu sau khi áp dụng mã giảm giá trên Safari".
• Môi trường: phiên bản ứng dụng hoặc bản build, thiết bị, hệ điều hành, trình duyệt, loại tài khoản và dữ liệu kiểm thử đã dùng.
• Các bước tái hiện: ngắn gọn, đánh số và bắt đầu từ một trạng thái đã biết.
• Kết quả mong đợi và kết quả thực tế, tách riêng.
• Bằng chứng: ảnh chụp hoặc video, log, lỗi console, request mạng và mốc thời gian.
• Tần suất: luôn xảy ra, thỉnh thoảng, hoặc chỉ trong điều kiện nhất định.
• Mức độ nghiêm trọng và tác động: ai bị ảnh hưởng, có cách khắc phục tạm không và dữ liệu có bị rủi ro không.

Mỗi báo cáo chỉ một lỗi, giữ giọng điệu khách quan và tránh đổ lỗi hay đưa phỏng đoán như sự thật. Trước tiên hãy tìm báo cáo trùng, và cố thu hẹp nguyên nhân, ví dụ xem lỗi có xảy ra trên trình duyệt khác hay chỉ sau một thay đổi cụ thể.

Một báo cáo tái hiện được giúp cả nhóm tiết kiệm thời gian và là cách nhanh nhất để lỗi được sửa.