Tại sao trích dẫn ID lỗi trong ghi chú vá lỗi được coi là một thực tiễn xấu?

Dựa trên một nhận xét và các lần nâng cấp tiếp theo từ Bug mở lại so với mới :

Trích dẫn ID lỗi trong ghi chú vá chỉ là .. rất không thân thiện. - Trợ giúp

Nó xuất hiện ít nhất một số người cảm thấy rằng tham chiếu ID lỗi trong ghi chú vá lỗi không phải là một ý tưởng tốt. Tôi là một nhà phát triển khá thiếu kinh nghiệm, vì vậy tôi tự hỏi tại sao lại như vậy.

Theo tôi, đó là một thực tiễn tốt, giả sử người dùng của bạn đã đọc quyền truy cập vào cơ sở dữ liệu lỗi của bạn. Có rất nhiều lần mọi người đang chờ đợi một lỗi nhất định được sửa chữa để quyết định khi nào cần nâng cấp.

Tôi nghĩ những gì nhíu mày chỉ là trích dẫn id lỗi và không có gì khác. Bạn cũng nên luôn luôn cung cấp một mô tả có thể hiểu được mà không cần đến trình theo dõi lỗi. Điều đó cũng cho phép bạn chuyển đổi trình theo dõi lỗi trong tương lai mà không làm mất hiệu lực hoàn toàn các ghi chú phát hành trước đó của bạn.

Đó là, như đã nói trong bình luận trích dẫn ... không thân thiện.

Không thân thiện với bản thân

Hãy tưởng tượng kịch bản sau đây. Bạn đang xem nhật ký trong kiểm soát nguồn. Bạn đang tự hỏi những gì một cam kết thay đổi. Thay vì giải thích nó bằng tiếng Anh, nó nói với bạn:

Đã giải quyết # 1307

Bạn chạy hệ thống theo dõi lỗi, hy vọng sẽ có một cái gì đó hữu ích. Lỗi # 1307 được báo cáo là đã giải quyết. Trong phần mô tả, bạn thấy:

Lỗi tương tự như # 1284

Cảm ơn, nó rất hữu ích. Bây giờ bạn phải điều hướng đến báo cáo lỗi # 1284 để đọc rằng đó là bản sao của lỗi # 1113 đề cập đến các lỗi # 1112, # 1065 và # 1067.

Năm phút sau, bạn không biết bạn đang tìm kiếm cái gì lúc đầu.

Một thông điệp nhật ký kiểm soát phiên bản hữu ích hơn nhiều sẽ là:

Đã giải quyết vấn đề người dùng không thể đăng nhập bằng mật khẩu dài hơn 25 ký tự (xem # 1307), bằng cách xóa áp dụng chính sách độ dài mật khẩu tương tự cho lớp truy cập dữ liệu như mật khẩu được sử dụng trong trang web.

Theo cách tương tự, trong hệ thống theo dõi lỗi, báo cáo # 1307 có thể tự giải thích nhiều hơn , nhớ lại báo cáo lỗi # 1284 là gì và báo cáo mới khác với báo cáo cũ như thế nào.

Không thân thiện với khách hàng

Đây không phải là vấn đề thân thiện duy nhất.

Thứ hai là bằng cách tham chiếu quá nhiều mà không có thêm thông tin, bạn đang làm cho các ghi chú vá / nhật ký kiểm soát phiên bản / hệ thống theo dõi lỗi báo cáo không thể sử dụng được cho một người không quen thuộc với các hệ thống đó . Khi bạn đối phó với hệ thống theo dõi lỗi hàng ngày, bạn sẽ biết cách nhanh chóng điều hướng qua các báo cáo, xem nhiều báo cáo cạnh nhau, v.v. Khi bạn là khách hàng không có nền tảng kỹ thuật, bạn có thể dễ dàng bị mất.

Ở đây một lần nữa, thông điệp chi tiết hơn rất hữu ích hơn chỉ là một tài liệu tham khảo. Lưu ý rằng bạn vẫn muốn giữ tài liệu tham khảo: không có gì sai hơn một lỗi giống như lỗi bạn gặp hai tuần trước, nhưng đừng nhớ lại ID của nó.

Một lưu ý, vấn đề tương tự tồn tại trong nhiều khu vực pháp lý. Ở Pháp chẳng hạn, không có gì lạ khi luật pháp đề cập đến nhiều nguồn, có thể thay đổi trong khi đó. Điều này có nghĩa là để hoàn toàn hiểu nó, đôi khi bạn phải dành hàng giờ trong thư viện, tìm kiếm hàng tá văn bản được giới thiệu, mỗi văn bản có tài liệu tham khảo riêng cho người khác.

Không có gì sai khi trích dẫn số vấn đề trong ghi chú vá, miễn là người dùng có thể đọc được vấn đề đang được trích dẫn. Nếu cơ sở dữ liệu lỗi của bạn cho phép bất cứ ai đọc, trích dẫn số lỗi có thể rất hữu ích. . vẫn có thể hữu ích khi có những cái được che giấu (ví dụ: nơi họ có mật khẩu trực tiếp!)

Trích dẫn một số vấn đề mà người đọc không thể đi và tìm kiếm các chi tiết và lịch sử của lỗi, điều đó khá không thân thiện. Không phải là trích dẫn các vấn đề như vậy mà không có ID vấn đề là thân thiện hơn nhiều.

Nó rõ ràng phụ thuộc vào những người sẽ đọc ghi chú vá lỗi và người dùng mục tiêu của phần mềm.

Nhưng trong hầu hết các trường hợp, đại đa số người dùng của bạn chỉ đơn giản là không quan tâm đến ID lỗi là gì. Họ không quan tâm tại sao nó bị hỏng, cách khắc phục hoặc bất cứ điều gì khác - họ chỉ muốn biết điều gì đã thay đổi với một mô tả văn bản rất ngắn gọn mà không cần phải đi đến một trang khác cho mỗi thay đổi.

Việc trích dẫn ID lỗi khiến tôi dừng lại và suy nghĩ, và tôi - với tư cách là người dùng - không muốn nghĩ. Đó là một vấn đề về khả năng sử dụng.

Hãy xem ví dụ ở log thay đổi của Visual Assist X . Tất cả những ID lỗi được liên kết đó chỉ là tiếng ồn làm tôi mất tập trung vào việc hiểu những gì đã thay đổi. Và đây là một tiện ích bổ sung cho Visual Studio, nhắm mục tiêu đến các lập trình viên. Và tôi là một lập trình viên. Nếu điều này làm phiền tôi, hãy tưởng tượng người dùng trung bình thậm chí không biết trình theo dõi lỗi là gì ..

PS: Tôi là tác giả của bình luận đã gây ra câu hỏi

ID lỗi là bắt buộc đối với một điểm tham chiếu . Những lý do:

• Ngăn ngừa sự mơ hồ: Hai hoặc nhiều lỗi có thể có mô tả tương tự. Vì vậy, người ta sẽ cần một số neo để phân biệt giữa chúng.
• Thuận tiện : Khi thảo luận về một lỗi, với khách hàng hoặc nội bộ, ID lỗi thường được sử dụng dưới dạng ngắn. Nếu ID sẽ bị bỏ qua khỏi các ghi chú vá, sẽ rất khó để thảo luận về chúng:

3052 đã được sửa, vẫn hoạt động trên 3077

thuận tiện hơn:

"Lỗi ứng dụng trên nút áp dụng" đã được sửa, vẫn hoạt động trên "NullReferenceException khi nhấp vào thay đổi người dùng"

Tôi sẽ nói rằng nó phụ thuộc vào hệ thống của bạn: Tôi may mắn rằng cái tôi sử dụng sẽ tự động phát hiện các tham chiếu như vậy trong các thông báo cam kết và thêm một liên kết đến vé được lưu trong trình theo dõi lỗi, vì vậy đó không phải là vấn đề.

Nhưng nếu tôi ở trên một hệ thống không có sẵn, tôi vẫn đề cập đến ID vé (theo cách đó bạn có thể nhanh chóng tìm kiếm trong nhật ký bằng ID vé ) cùng với một mô tả ngắn về lỗi là gì.