เขียน Bug Report อย่างไรให้ Dev แก้ได้เร็ว พร้อมตัวอย่าง
โครงสร้าง Bug Report, Steps to Reproduce, Expected/Actual, Severity และตัวอย่างรายการที่คัดลอกไปใช้ได้
Bug Report ที่ดีไม่ใช่รายงานที่ยาวที่สุด แต่เป็นรายงานที่คนไม่เคยเจอปัญหามาก่อนสามารถทำซ้ำและตรวจสอบได้โดยไม่ต้องถามกลับหลายรอบ เนื้อหาควรยืนยัน เกิดอะไรขึ้น ที่ไหน ภายใต้เงื่อนไขใด และควรเป็นอย่างไร
1. โครงสร้างที่ควรมี
| หัวข้อ | ต้องเขียนอะไร |
|---|---|
| Title | [Module] อาการหลัก + ผลกระทบ |
| Environment | UAT / PROD, URL, Browser, OS, Build |
| Precondition | Role, Data Setup และสถานะก่อนเริ่ม |
| Steps to Reproduce | ขั้นตอนเรียงลำดับที่ทำซ้ำได้ |
| Expected Result | สิ่งที่ควรเกิดตาม Requirement |
| Actual Result | ผลที่เกิดจริงพร้อม Error/ภาพประกอบ |
| Evidence | Screenshot, Video, HAR/Console Log โดยลบข้อมูลอ่อนไหว |
| Severity / Priority | ผลกระทบและความเร่งด่วนแยกกัน |
2. ตัวอย่าง Bug Report สำหรับระบบ Upload
[Upload] รูปแนวตั้งถูกหมุนผิดทิศหลังบันทึก
Environment: UAT / Chrome Android / Build 1.2.3
Precondition: Login ด้วย Role Editor
Steps:
1) เปิดหน้าโปรไฟล์
2) อัปโหลด JPEG แนวตั้งที่มี EXIF Orientation
3) กดบันทึกและเปิดหน้าเดิมอีกครั้ง
Expected: แสดงภาพแนวตั้งถูกทิศ ไม่บิดสัดส่วน
Actual: ภาพหมุน 90 องศาเมื่อเปิดหน้าซ้ำ
Frequency: 3/3 ครั้ง
Evidence: Screenshot + Test file ที่ไม่ใช่ข้อมูลจริง
3. Severity กับ Priority ต่างกันอย่างไร
Severity คือระดับผลกระทบ เช่น ระบบชำระเงินใช้งานไม่ได้ ส่วน Priority คือความเร่งด่วนของทีมในการแก้ไข ซึ่งอาจขึ้นกับวันเปิดตัว จำนวนผู้ใช้ และทางแก้ชั่วคราวได้ จึงไม่จำเป็นต้องมีระดับเท่ากัน
4. ทำให้ Developer ทำซ้ำได้เร็วขึ้น
- ระบุ Test Data ที่ใช้แบบไม่เปิดเผยความลับ
- แนบเวลาและ Timezone หากเกี่ยวข้องกับ API หรือ Scheduled Job
- บอกว่าพบทุกครั้งหรือเป็นบางครั้ง พร้อมจำนวนครั้งที่ทดสอบ
- ถ้าคาดว่าเป็น Regression ให้ระบุเวอร์ชันก่อนหน้าที่เคยผ่าน
- หลังแก้แล้วทำ Retest และบันทึกหลักฐานใน Ticket เดิม
5. Checklist ก่อนกด Create Bug
- Title อ่านแล้วรู้จุดที่เสียและอาการ
- มี URL / Module / Role / Version
- Steps ทำซ้ำได้และไม่ขาด Precondition
- Expected และ Actual ไม่เขียนปนกัน
- มีหลักฐานพร้อมระบุสถานะ Retest หลังแก้
ลองใช้ ภาพทดสอบสำหรับแนบ Bug บน SoomHaiNa →
อ่านต่อ: วาง Regression Test หลัง Bug Fix