เอกสาร

ขั้นตอนรายงานบัก

สร้างรายงานบักที่ทำซ้ำได้พร้อมภาพที่ชัดเจน ขั้นตอน และการบันทึกเสริมสำหรับ macOS/Windows

เป้าหมาย

สร้างรายงานบักที่นักพัฒนาสามารถทำซ้ำได้ในครั้งแรก

ชุดเอาต์พุต

  • สกรีนช็อตที่มาร์กอัปแล้ว 1 ภาพ
  • รายการขั้นตอนการทำซ้ำสั้น 1 รายการ
  • การบันทึก 10-30 วินาทีเสริม (เฉพาะ macOS/Windows; ข้ามบน Linux beta)

เวิร์กโฟลว์

1. ทำซ้ำครั้งหนึ่งและหยุดในสถานะนั้น

  • ทำซ้ำปัญหา
  • หยุดตรงสถานะที่เสียหายพอดี
  • หากต้องการเปรียบเทียบกับพฤติกรรมที่คาดหวัง ให้จับภาพและปักหมุดทั้งสองสถานะ

2. จับภาพหลักฐาน

  1. กด F2 เพื่อจับภาพ
  2. รักษาบริบทโดยรอบ (แถบเครื่องมือ ชื่อแท็บ พื้นที่สถานะ)
  3. หลีกเลี่ยงการตัดมากเกินไป รวมเบาะแสที่จำเป็นสำหรับการทำซ้ำ

3. มาร์กอัปเพื่อการวินิจฉัย

  1. ใช้ Step Badge เพื่อทำเครื่องหมายลำดับ (1, 2, 3)
  2. ใช้ Arrow เพื่อชี้ไปยังตำแหน่งที่เสียหาย
  3. ใช้ Text สำหรับข้อเท็จจริงสั้นๆ: รหัสข้อผิดพลาด ค่าที่ไม่คาดคิด หรือ timestamp
  4. ใช้ Mosaic สำหรับ token ส่วนตัวหรือข้อมูลผู้ใช้

4. ส่งออกและตั้งชื่ออย่างชัดเจน

บันทึกด้วยชื่อที่มีโครงสร้าง เช่น:

bug-login-timeout-win10-2026-02-24.png

5. เสริม: บันทึกวิดีโอหลักฐานสั้น

หากปัญหาขึ้นอยู่กับจังหวะเวลาหรือแอนิเมชัน บันทึกบน macOS/Windows เท่านั้น Linux beta ไม่รวมการบันทึก ให้ข้ามขั้นตอนนี้บนแพลตฟอร์มนั้น

  1. เริ่มการบันทึกเต็มหน้าจอจากเมนูถาดระบบหรือรัน snaptray record start
  2. บันทึก 10-30 วินาที
  3. หยุดและส่งออกเป็น MP4

เทมเพลตรายงานบัก

Title: [Platform] สรุปปัญหาสั้น

Environment:
- App version:
- OS:

Steps to reproduce:
1. ...
2. ...
3. ...

Expected:
Actual:

Attachments:
- screenshot.png
- recording.mp4 (เสริม เฉพาะ macOS/Windows)

รายการตรวจสอบคุณภาพ

  • ขั้นตอนการทำซ้ำเป็นแบบกำหนดได้
  • สกรีนช็อตรวมทั้งปัญหาและบริบท
  • มาร์กอัปอธิบายลำดับและผลกระทบ
  • ข้อมูลส่วนตัวถูกปิดบัง

บทช่วยสอนถัดไป

ใช้ อ้างอิงสดด้วยการปักหมุด เพื่อเก็บสเปกหรือสกรีนช็อตบักให้มองเห็นบนหน้าจอขณะแก้ไข