Báo bug bằng tiếng Anh: từ quan sát đến bước tái hiện

Người nhận cần biết điều gì?

Một báo lỗi hữu ích giúp người khác hiểu bối cảnh và thử lại. Nêu chức năng, bước thực hiện, kết quả thực tế và kết quả mong đợi. Thêm môi trường hoặc tần suất nếu chúng giúp khoanh vùng; không đính kèm dữ liệu riêng không cần thiết.

Ví dụ có cấu trúc

Title: The profile name does not update after saving.

Steps: Open Profile, change the display name, and select Save. Reload the page.

Expected: The new name is still displayed.

Actual: The previous name is displayed after reload.

Đây là ví dụ minh họa về cách trình bày, không phải báo cáo lỗi đang tồn tại của Chibi English. Các nhãn Expected và Actual giúp tách điều đáng lẽ xảy ra khỏi điều đã quan sát.

Tránh kết luận quá sớm

The database is broken là một kết luận rộng. Nếu mới quan sát thấy thay đổi bị mất sau reload, hãy viết đúng điều đó. Có thể thêm giả thuyết bằng This may be related to..., nhưng ghi rõ chưa xác minh và không thay thế bằng chứng bằng phỏng đoán.

Hỏi và xác nhận phạm vi

Can you reproduce this with another test account? hỏi người khác có tái hiện được không. It happens only when... nêu điều kiện, nhưng chỉ dùng khi bạn đã thử phạm vi đó. Nếu chưa biết tần suất, viết I reproduced it twice in this environment thay vì It always happens.

Tự luyện

Lấy một tình huống giả lập, viết tiêu đề một dòng và bốn mục ngắn. Loại bỏ token, email thật, request nhạy cảm và ảnh có dữ liệu cá nhân. Đọc như người chưa biết dự án để xem họ có thể thử lại không. Sau đó mở lộ trình IT để luyện cách mô tả vấn đề.

Nguồn tham khảo

• developer.mozilla.org/en-US/docs/Learn_web_development
• developer.mozilla.org/en-US/docs/MDN/Community/Issues