Biến một bản ghi thành báo cáo mà ai đó có thể hành động
Tải bản ghi màn hình của lỗi. Phát nó, và mỗi khi có điều gì quan trọng xảy ra, hãy đánh dấu nó. Dấu thời gian được ghi lại, một khung hình được lấy từ video tại thời điểm đó, và bước này được đưa vào một danh sách được đánh số.
Viết tóm tắt, những gì bạn mong đợi và những gì đã xảy ra thay vào đó, sau đó sao chép toàn bộ dưới dạng Markdown cho GitHub, đánh dấu Jira, hoặc văn bản thuần túy. Chi tiết trình duyệt và màn hình đã được điền sẵn.
Bản ghi không bao giờ rời khỏi máy của bạn. Nó được phát từ một tệp cục bộ và các khung hình được vẽ trên thiết bị của bạn, điều này quan trọng khi lỗi nằm trong một bản dựng chưa phát hành hoặc tài khoản của khách hàng.
Tại sao điều này không sử dụng AI để viết báo cáo
Một mô hình xem bản ghi màn hình có thể mô tả những gì nó thấy. Nó không thể biết những gì bạn mong đợi thấy, và đó là một nửa của báo cáo lỗi quyết định liệu ai đó có thể hành động dựa trên nó hay không.
“Nhấn Xác nhận, bảng hóa đơn trống” là một quan sát. Liệu đó có phải là một lỗi hay không hoàn toàn phụ thuộc vào những gì đáng lẽ phải xuất hiện ở đó, và người duy nhất biết điều đó là bạn. Một công cụ tạo ra hành vi mong đợi từ một video đang đoán và trình bày sự đoán đó như một phát hiện, điều này tồi tệ hơn việc để trống trường, bởi vì một kỳ vọng sai có vẻ hợp lý sẽ đưa nhà phát triển đi sai hướng.
Vì vậy, sự phân chia ở đây là có chủ ý. Công cụ thực hiện công việc cơ học mà nó có thể làm một cách chính xác: dấu thời gian, khung hình, môi trường, định dạng, đánh số. Bạn cung cấp sự đánh giá. Điều đó mất khoảng một phút và kết quả là một báo cáo mà không ai phải quay lại hỏi bạn.
Ba Điều Báo Cáo Thường Bỏ Sót
Sau khi đọc rất nhiều báo cáo lỗi sơ sài, những thiếu sót tương tự lại tái diễn, và cả ba đều mang tính cơ học chứ không khó.
Dấu thời gian. Một báo cáo nói “xem video đính kèm” khiến người đọc phải xem bốn phút để tìm ra khoảnh khắc. Một bước nói rằng nó xảy ra lúc 1:12 thì không.
Môi trường. Trình duyệt, hệ điều hành, kích thước màn hình. Ai cũng biết phải bao gồm nó nhưng hầu như không ai làm, bởi vì điều đó có nghĩa là mở một bảng cài đặt trong khi bạn đang suy nghĩ. Nó được đọc từ trình duyệt của bạn ở đây và nằm trong báo cáo đã được điền sẵn, và bạn có thể sửa lại.
Ảnh tĩnh. Một khung hình tại thời điểm xảy ra lỗi là thứ được quét trong danh sách hai mươi vấn đề. Việc trích xuất khung hình từ video thủ công đủ tẻ nhạt đến mức mọi người bỏ qua, vì vậy nó xảy ra tự động ở mỗi bước bạn đánh dấu.
Những Gì Được Ghi Lại, Chính Xác
Mỗi bước được đánh dấu ghi lại thời gian phát lại chính xác và một khung hình JPEG từ video tại thời điểm đó, được thu nhỏ để giữ cho báo cáo nhẹ. Bạn có thể tải xuống các khung hình để đính kèm vào vấn đề.
Môi trường đến từ trình duyệt: tên và phiên bản của nó, hệ điều hành, kích thước màn hình với tỷ lệ pixel của nó, và kích thước khung nhìn. Các trình duyệt hiện báo cáo ít thông tin về bản thân hơn trước đây, vì vậy một số thông tin đó có thể trở lại không xác định, và mỗi trường đều có thể chỉnh sửa chứ không bị khóa.
Không có gì được suy ra từ các pixel. Công cụ không cố gắng đọc văn bản lỗi trên màn hình hoặc đoán phần tử nào bạn đã nhấp, bởi vì làm điều đó không đáng tin cậy còn tệ hơn là không làm.
Cấu Trúc Nó Điền Vào
Đầu ra tuân theo hình dạng mà một báo cáo lỗi đã được định hình, bởi vì các công cụ theo dõi và những người đọc chúng đều mong đợi điều đó. Nếu bạn đang tìm kiếm một mẫu báo cáo lỗi, đây là một mẫu đã được điền sẵn chứ không phải mẫu bạn dán vào rồi nhìn chằm chằm.
Tóm tắt trước tiên, trong một dòng duy nhất, bởi vì dòng đó là thứ mà ai đó quét qua trong danh sách ba mươi vấn đề và nó quyết định xem báo cáo của bạn có được mở hôm nay hay không.
Sau đó là các bước được đánh số với mã thời gian trên mỗi bước, hành vi mong đợi, hành vi thực tế và môi trường. Thứ tự đó không phải là trang trí. Người đọc kiểm tra các bước để xem liệu nó có thể tái tạo được không, cặp mong đợi và thực tế để xem liệu đó có thực sự là một lỗi không, và môi trường để xem liệu nó có phải là của họ không. Ẩn bất kỳ thông tin nào trong số đó sẽ tốn một chu trình kiểm tra.
Điều mà một mẫu trống không thể làm là tự điền vào, đây là phần khiến mọi người bỏ qua nó. Ở đây, các bước, mã thời gian, khung hình và môi trường đã được điền sẵn, và bạn viết ba trường mà một công cụ thực sự không thể biết.
Trước khi ghi hình
Báo cáo chỉ tốt khi bản ghi tốt, và hai thói quen sau tạo nên sự khác biệt.
Bắt đầu từ một trạng thái đã biết. Bản ghi bắt đầu giữa phiên làm việc khiến người đọc phải đoán những gì đã xảy ra trước đó, do đó các bước không thể tái tạo được. Hãy bắt đầu từ màn hình đăng nhập, một trang mới, hoặc một điểm bắt đầu được mô tả.
Xóa màn hình khỏi bất kỳ thứ gì không nên xuất hiện. Token trong thanh URL, tên khách hàng, một email không liên quan trong tab khác, một khóa API trong bảng công cụ nhà phát triển. Một báo cáo lỗi được chuyển tiếp, dán vào trò chuyện và được đọc bởi những người ngoài nhóm, và một bản ghi màn hình mang theo bất cứ thứ gì trên màn hình vào thời điểm đó. Công cụ này không bao giờ tải video lên, nhưng báo cáo và các khung hình sẽ đi đến bất cứ nơi nào bạn gửi chúng.
Những gì nó không làm
Nó không gửi vấn đề. Không có kết nối với GitHub, Jira hay bất kỳ thứ gì khác; bạn sao chép báo cáo và dán nó vào nơi cần thiết, điều đó cũng có nghĩa là bạn được đọc nó trước bất kỳ ai khác.
Nó không thu thập nhật ký, yêu cầu mạng hoặc đầu ra console. Những thứ đó nằm trong công cụ dành cho nhà phát triển của bạn và cực kỳ quan trọng đối với một số lỗi. Hãy đính kèm chúng thông qua bất kỳ tuyến đường bảo mật nào mà nhóm của bạn đã sử dụng thay vì quay phim một console.
Và nó không chẩn đoán bất cứ điều gì. Nó sẽ không cho bạn biết nguyên nhân, thành phần nào bị lỗi, hoặc liệu đây có phải là lỗi trùng lặp với một vấn đề hiện có hay không. Nó đưa bằng chứng vào một dạng mà ai đó có thể làm việc được, và đó là toàn bộ công việc.
Ghi lại lỗi ngay từ đầu
Nếu bạn vẫn cần ghi lại sự cố, trình ghi màn hình sẽ ghi lại một tab, một cửa sổ hoặc toàn bộ màn hình trong trình duyệt. Đối với một lỗi bạn cần tường thuật trong khi tái tạo, hãy ghi âm kèm theo lời giải thích và lời giải thích đó sẽ được đính kèm vào bằng chứng.
Hai công cụ liên quan đáng biết. Nếu bạn muốn các hình ảnh riêng lẻ thay vì một báo cáo, trình trích xuất khung video sẽ trích xuất các khung hình theo khoảng thời gian. Và nếu bản ghi dài và bạn muốn bản tường thuật bằng lời thành văn bản, trình tạo bản ghi sẽ biến lời tường thuật thành thứ có thể tìm kiếm được.
