Bỏ qua tới nội dung

Hướng dẫn báo lỗi

Cách báo lỗi Deplao hiệu quả trên GitHub - tái hiện lỗi, chụp ảnh, lấy nhật ký trong app, ghi thông tin môi trường và những điều nên tránh.

Tìm thấy lỗi? Báo cáo chi tiết giúp nhóm phát triển xác định và sửa lỗi nhanh hơn. Báo cáo có bước tái hiện, ảnh chụp và nhật ký lỗi rõ ràng sẽ được ưu tiên xử lý trước.

Trong app, mở nhanh hướng dẫn báo lỗi bằng nút ⋯ trên thanh tiêu đề → Báo lỗi.

Quy trình báo lỗi: 5 bước

  1. Tái hiện lỗi: lặp lại thao tác và ghi từng bước (VD: "Mở CRM → Chiến dịch → Tạo chiến dịch mới → Lỗi"). Ghi rõ lỗi xảy ra mỗi lần hay chỉ thỉnh thoảng. Cập nhật lên bản mới nhất rồi thử lại: khi có bản mới, cạnh số phiên bản trên thanh tiêu đề hiện nút "New v…".
  2. Chụp ảnh / quay video minh hoạ: chụp màn hình khi lỗi xuất hiện (Windows: PrtScn / Snipping Tool; macOS: Cmd+Shift+4). Lỗi qua nhiều bước: quay video ngắn 10-30 giây (Windows: Win+G; macOS: Cmd+Shift+5). Khoanh hoặc đánh dấu chỗ bị lỗi trên ảnh.
  3. Lấy nhật ký lỗi: ngay sau khi lỗi xảy ra (trước khi tắt app): Cài đặt → Nhật ký → chọn "LỖI" (hoặc "CẢNH BÁO"), gõ từ khoá vào ô "Tìm trong log..." nếu cần → bấm Copy để dán vào issue, hoặc Xuất file để đính kèm file .txt.
  4. Ghi thông tin môi trường: phiên bản Deplao (cạnh chữ Deplao ở góc trên bên trái, hoặc Cài đặt → Log phiên bản); hệ điều hành (Windows 10/11, macOS Intel / Apple Silicon, Linux); kênh và loại tài khoản gặp lỗi (Zalo cá nhân / Business, Facebook, Telegram, Telegram Bot); dùng trên máy Boss, máy nhân viên hay dùng một mình; tính năng liên quan.
  5. Tạo issue trên GitHub và theo dõi: tiêu đề ngắn gọn; "Mô tả lỗi" 1-2 câu; "Bước tái hiện" đánh số; "Kết quả mong đợi" và "Kết quả thực tế"; đính kèm ảnh / video / nhật ký; "Thông tin môi trường". Gửi xong, theo dõi email thông báo, trả lời sớm khi nhóm hỏi thêm và xác nhận lại sau khi cập nhật bản sửa.

Về Nhật ký (Cài đặt → Nhật ký)

  • Ghi lại hoạt động và lỗi của app theo thời gian thực (gửi tin, kết nối tài khoản, đồng bộ, workflow…), lọc theo mức: Tất cả, LỖI, CẢNH BÁO, INFO, LOG, DEBUG.
  • Chỉ giữ khoảng 2.000 dòng gần nhất của lần mở app hiện tại: tắt / mở lại app là mất, nên lấy nhật ký ngay khi vừa gặp lỗi.
  • App tự che phần lớn mật khẩu, token, cookie trong nhật ký; vẫn nên đọc lại và xoá tên, số điện thoại hay nội dung tin nhắn của khách trước khi gửi.
  • Lỗi liên quan nhân viên: lấy nhật ký ở cả máy Boss và máy nhân viên.

Ví dụ: báo cáo lỗi chất lượng cao

[bug] Chiến dịch CRM: Không gửi được tin khi chọn hơn 100 liên hệ

Mô tả: Khi chạy chiến dịch gửi tin với hơn 100 người nhận, bấm "Bắt đầu" không có phản hồi. Nhật ký (lọc LỖI) có dòng báo timeout.

Bước tái hiện:

  1. Mở CRM → Chiến dịch → Tạo chiến dịch mới
  2. Thêm liên hệ: tất cả liên hệ có nhãn "Khách hàng" (khoảng 150 người)
  3. Nhập nội dung tin nhắn → Tạo chiến dịch → bấm "Bắt đầu"
  4. → Trạng thái không đổi, không có tin nào được gửi

Môi trường: Deplao v26.10.3, Windows 11, Zalo cá nhân, dùng một mình (không có nhân viên). Đã thử 50 người (bình thường), 100 người (bình thường), 150 người (lỗi). Đính kèm: ảnh chụp + file nhật ký.

Mẹo

Báo cáo trên có đủ: bước tái hiện chính xác, so sánh kết quả, nhật ký lỗi và thông tin môi trường để xác định lỗi.

Các loại lỗi thường gặp

Loại lỗi Nên ghi lại
Lỗi crash / treo app Ghi thao tác cuối trước khi lỗi, chụp màn hình. Nếu app còn mở được: Cài đặt → Nhật ký → Xuất file.
Lỗi giao diện / hiển thị Ảnh chụp hiện tại và mong đợi. Ghi giao diện Sáng / Tối, hệ điều hành, độ phân giải, cỡ chữ (nút ⋯ → Cỡ chữ).
Lỗi kết nối / đồng bộ tài khoản Ghi kênh (Zalo, Facebook, Telegram) và tài khoản bị lỗi, thời điểm, trạng thái trên Dashboard. Thử kết nối / đăng nhập lại, kiểm tra Proxy nếu có gắn.
Lỗi kết nối nhân viên Ghi LAN hay Internet, loại địa chỉ (tạm / cố định), trạng thái trên thanh tiêu đề máy nhân viên và tab Cài đặt → Nhân viên → Kết nối của máy Boss.
Lỗi tích hợp bên thứ 3 Ghi rõ tích hợp nào (POS, vận chuyển, thanh toán…), thao tác, kết quả mong đợi và thực tế. Không dán API key vào issue.
Lỗi Workflow không chạy Chụp sơ đồ workflow, ghi trigger + action; mở "Lịch sử chạy" trong trình sửa workflow để xem bước bị lỗi.
Hiệu năng chậm / lag Ghi quy mô dữ liệu (số tài khoản, hội thoại, nhóm), thao tác bị chậm, so sánh với phiên bản trước.

Những điều KHÔNG nên làm

  • Gửi issue chỉ ghi "app bị lỗi" mà không có mô tả chi tiết.
  • Gửi nhiều issue trùng lặp: tìm trong danh sách Issues trước.
  • Đính kèm thông tin nhạy cảm: mã OTP, mật khẩu, API key / token, cookie, số điện thoại hay tin nhắn của khách.
  • Dùng issue để hỏi cách sử dụng: hãy đọc tài liệu hướng dẫn này (trong app: Cài đặt → Giới thiệu) trước, hoặc hỏi qua nút ⋯ → Hỗ trợ trên thanh tiêu đề. Xem thêm Câu hỏi thường gặp.
  • Gộp nhiều lỗi khác nhau vào một issue: mỗi issue một lỗi để dễ theo dõi và xác nhận khi đã sửa.
  • Gộp đề xuất tính năng vào báo lỗi: tạo issue riêng cho đề xuất.

Chưa tìm thấy câu trả lời?

Nhắn hỗ trợ qua Telegram