วิธีเขียนรายงานข้อผิดพลาดพร้อมตัวอย่าง

รายงานข้อผิดพลาดคืออะไร? ทำไมคุณจึงต้องมีรายงานข้อผิดพลาดที่ดี?

Bug Report เป็นเอกสารสำคัญใน STLC ที่ให้ข้อดีหลายประการแก่ทีมทดสอบ ติดตามข้อบกพร่อง ข้อบกพร่อง ข้อผิดพลาด และความคลาดเคลื่อนอื่นๆ ทั้งหมดที่พบในระหว่างการทดสอบซอฟต์แวร์และรายงานสิ่งเหล่านั้น

วัตถุประสงค์ของเอกสารหลังการทดสอบนี้คือเพื่อให้ข้อมูลแก่ทีมงานมืออาชีพที่เกี่ยวข้องเกี่ยวกับระดับของจุดบกพร่องที่พบในระหว่างขั้นตอนการทดสอบ

ของคุณ วิศวกรพัฒนาซอฟต์แวร์ สามารถทราบถึงข้อบกพร่องและปัญหาทั้งหมดที่มีอยู่ในซอฟต์แวร์ได้โดยใช้รายงานประเภทนี้ นอกจากนี้ยังช่วยให้คุณทราบว่ามีอะไรผิดปกติกับจุดบกพร่อง เพื่อให้คุณสามารถใช้วิธีที่ดีที่สุดในการแก้ไขได้ นอกจากนี้ยังช่วยให้คุณประหยัดเวลาและเงินด้วยการช่วยตรวจจับจุดบกพร่องและปัญหาต่างๆ

เหตุใดคุณจึงควรสนใจคำอธิบายข้อบกพร่องที่ดี

นี่คือจุดที่คุณต้องพิจารณาในการเขียนรายงานข้อบกพร่องของซอฟต์แวร์ที่ดีและมีรายละเอียด:

• โดยจะทำหน้าที่เป็นแนวทางในการช่วยหลีกเลี่ยงข้อผิดพลาดเดียวกันนี้ในการเผยแพร่ในอนาคต
• ประหยัดเวลาสำหรับการสื่อสาร (อีเมล์, โทรศัพท์)
• Less ทำงานให้กับนักพัฒนา (พวกเขาจะทำสิ่งที่คุณต้องการอย่างแน่นอน)
• คุณจะมีปัญหาคอขวดน้อยลงในโครงการ ข้อบกพร่องจะได้รับการแก้ไขเร็วขึ้นและมีประสิทธิภาพมากขึ้น

วิธีเขียนรายงานข้อผิดพลาด (เทมเพลตรายงานข้อผิดพลาด)

ไม่มีเทมเพลตรายงานข้อบกพร่องที่แน่นอน เนื่องจากขึ้นอยู่กับระบบติดตามข้อบกพร่องของคุณ เทมเพลตของคุณอาจแตกต่างกัน

อย่างไรก็ตาม จำเป็นต้องมีฟิลด์ทั่วไปต่อไปนี้เมื่อคุณต้องการเขียนรายงานจุดบกพร่อง:

• รหัสข้อผิดพลาด/ชื่อเรื่อง
• ความรุนแรงและลำดับความสำคัญ
• Descriptไอออน
• สภาพสิ่งแวดล้อม
• ขั้นตอนการสืบพันธุ์.
• ผลที่คาดหวัง.
• ผลลัพธ์ที่แท้จริง
• ไฟล์แนบ (ภาพหน้าจอ วิดีโอ ข้อความ)

มาดูส่วนประกอบในการดักจับจุดบกพร่องเหล่านี้ทีละรายการ:

1) ชื่อ/รหัสข้อผิดพลาด:

ข้อบกพร่องแต่ละข้อควรมีหมายเลขประจำตัวที่ไม่ซ้ำกัน เครื่องมือรายงานข้อบกพร่องควรมีหมายเลขเฉพาะสำหรับข้อบกพร่องที่เพิ่งเกิดขึ้น เพื่อให้เราสามารถระบุข้อบกพร่องได้อย่างง่ายดาย

ตัวอย่าง:

❌ แย่: “ฉันไม่เห็นสินค้าอีกแล้ว พิมพ์ผิด”

• คลุมเครือ
• ก้าวร้าว
• ใช้คำมากเกินไป

ขอแนวทางแก้ไขที่จะนำไปปฏิบัติ

✅ ดี: “รถเข็น – เพิ่มรายการใหม่ลงในรถเข็นที่ไม่ปรากฏ”

• ชื่อประเภทนี้ค้นหาปัญหาได้ทันที (CART)
• โดยเน้นที่ปัญหาทางเทคนิคที่เกิดขึ้นจริง

2) ความรุนแรงของข้อผิดพลาด:

ความรุนแรงของข้อบกพร่องเป็นปัจจัยที่สำคัญมากในรายงานข้อบกพร่อง โดยจะอธิบายผลกระทบของข้อบกพร่องที่มีต่อประสิทธิภาพของแอปพลิเคชัน

• บล็อคเกอร์: ข้อผิดพลาดนี้ทำให้แอปล้มเหลว
• สาขา: ข้อผิดพลาดร้ายแรงบ่งชี้ถึงการเปลี่ยนแปลงที่สำคัญในตรรกะทางธุรกิจ
• ผู้เยาว์: ปัญหาที่ไม่ส่งผลกระทบต่อการทำงานของแอปพลิเคชัน แต่จะส่งผลต่อผลลัพธ์ที่คาดหวัง
• จิ๊บจ๊อย: ไม่ส่งผลกระทบต่อการใช้งานหรือการทำงานของแอป อาจเป็นข้อผิดพลาดด้านการพิมพ์

3) ลำดับความสำคัญของข้อผิดพลาด:

ต่อไปนี้เป็นการไล่ระดับโดยทั่วไปเพื่อตัดสินลำดับความสำคัญของจุดบกพร่อง:

• สูง: ครอบคลุมทุกสิ่งที่ส่งผลต่อโฟลว์หรือบล็อกการใช้งานแอป
• ประเภทภาพ: มันส่งผลเสียต่อประสบการณ์ผู้ใช้
• ผู้เยาว์: ข้อผิดพลาดอื่นๆ ทั้งหมด เช่น (การพิมพ์ผิด ไอคอนหายไป ปัญหาเค้าโครง ฯลฯ)

4) สิ่งแวดล้อม:

จุดบกพร่องอาจปรากฏในสภาพแวดล้อมเฉพาะ ไม่ใช่ที่อื่น ตัวอย่างเช่น บางครั้งข้อผิดพลาดปรากฏขึ้นเมื่อใช้งานเว็บไซต์ Firefoxหรือแอปทำงานผิดปกติเฉพาะเมื่อทำงานบน Android อุปกรณ์และทำงานได้ดีบน iPhone

รายงานข้อบกพร่องเหล่านี้สามารถระบุได้ด้วยการทดสอบข้ามเบราว์เซอร์หรือข้ามอุปกรณ์เท่านั้น ดังนั้น เมื่อรายงานจุดบกพร่อง QA ควรจะสามารถระบุได้ว่าควรสังเกตจุดบกพร่องในสภาพแวดล้อมที่เฉพาะเจาะจงตั้งแต่หนึ่งรายการขึ้นไป

5) สรุป:

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

ข้อมูลสรุปของคุณโดยใช้คำเพียงไม่กี่คำเท่าที่เป็นไปได้ รวมถึงเวลาและวิธีที่จุดบกพร่องเกิดขึ้น ชื่อและคำอธิบายข้อบกพร่องของคุณควรใช้ในการค้นหา ดังนั้นคุณต้องแน่ใจว่าคุณได้ครอบคลุมคำหลักที่สำคัญแล้ว

ตัวอย่าง:

• แย่: “ฉันกำลังพยายามเพิ่มสิ่งต่าง ๆ เข้าไปในการทดสอบ และไม่มีอะไรปรากฏขึ้นเมื่อฉันทำอย่างนั้นหรือคลิกที่ปุ่ม”
• ดี: “เมื่อฉันลองเพิ่ม [ผลิตภัณฑ์] ลงในตะกร้าสินค้า แต่ไม่มีอะไรเกิดขึ้นเมื่อฉันคลิกปุ่ม 'เพิ่ม' บนหน้าเว็บภาพรวมผลิตภัณฑ์นั้นๆ”

6) ขั้นตอนในการทำซ้ำ:

เมื่อรายงานจุดบกพร่อง สิ่งสำคัญคือต้องระบุขั้นตอนในการทำซ้ำ คุณควรรวมการกระทำที่อาจทำให้เกิดข้อบกพร่องด้วย ในที่นี้ อย่าใช้ถ้อยคำทั่วไปใดๆ

โปรดระบุขั้นตอนต่อไปนี้ให้ชัดเจน:

นี่คือตัวอย่างขั้นตอนที่เขียนไว้อย่างดี:

ขั้นตอน:

1. เลือกผลิตภัณฑ์ X1
2. คลิกที่เพิ่มลงตะกร้า
3. คลิกลบเพื่อลบสินค้าออกจากตะกร้า

7) ผลลัพธ์ที่คาดหวัง:

ในรายงานข้อผิดพลาด การอธิบายผลลัพธ์ที่คาดหวังต่องานทางเทคนิค การออกแบบผลลัพธ์ของกรณีทดสอบ หรือตามความคิดเห็นของผู้ทดสอบเป็นสิ่งสำคัญ ทั้งหมดนี้ช่วยให้นักพัฒนามุ่งเน้นไปที่การค้นหาข้อมูลที่จำเป็นได้อย่างรวดเร็ว

ตัวอย่างเช่น:

ช่องที่ต้องกรอกควรเน้นด้วยสีแดงหลังจากคลิกปุ่ม "ส่ง"

8) ผลลัพธ์ที่แท้จริง:

ตามที่ชื่อแนะนำ ฟิลด์นี้จะอธิบายผลกระทบที่แท้จริงของจุดบกพร่อง การเขียนคำอธิบายที่ชัดเจนเกี่ยวกับผลลัพธ์ที่แท้จริงเป็นสิ่งสำคัญมาก

ตัวอย่างเช่น:

ช่องที่ต้องกรอกจะถูกเน้นด้วยสีเขียวหลังจากคลิกปุ่ม "ส่ง"

9) ไฟล์แนบ (ภาพหน้าจอและวิดีโอ):

ในรายงานข้อบกพร่อง แนวทางปฏิบัติที่ดีที่สุดคือการแนบไฟล์ไปกับรายงานข้อบกพร่อง ซึ่งจะทำให้ง่ายต่อการรับรู้ข้อมูลเมื่อคุณต้องการแสดงข้อมูลด้วยภาพ:

ตัวอย่างเช่น:

• ภาพหน้าจอ: ภาพหน้าจอสามารถอธิบายข้อผิดพลาดในโปรแกรมได้อย่างง่ายดาย สะดวกเมื่อจุดบกพร่องถูกเน้นด้วยคำอธิบายประกอบ วงกลม หรือรูปภาพลูกศรที่เฉพาะเจาะจง)
• Video: บางครั้งการอธิบายจุดบกพร่องด้วยคำพูดเป็นเรื่องยาก ดังนั้นจึงควรสร้างวิดีโอเพื่อให้นักพัฒนาแก้ไขข้อบกพร่องในโปรแกรมได้ดีกว่า)

10) เวอร์ชันที่ได้รับผลกระทบ:

เป็นเวอร์ชันซอฟต์แวร์ที่ได้รับผลกระทบซึ่งมีการรายงานจุดบกพร่อง

11) แก้ไขเวอร์ชัน:

เป็นเวอร์ชันซอฟต์แวร์ที่แก้ไขข้อบกพร่องแล้ว ดังนั้นเมื่อ QA ที่รายงานจุดบกพร่องตรวจสอบว่าได้รับการแก้ไขแล้วหรือไม่ เขาจึงใช้ซอฟต์แวร์เวอร์ชันที่ถูกต้อง

12) Target รุ่น:

เวอร์ชันเป้าหมายที่ควรกำหนดเป้าหมายข้อบกพร่องเพื่อแก้ไข ดังนั้นเมื่อทีมพัฒนาทำงานเพื่อแก้ไขข้อบกพร่อง พวกเขาจะกำหนดเป้าหมายไปที่เวอร์ชันแอปพลิเคชันเฉพาะเป็นส่วนใหญ่

13) วันที่ปิด:

เป็นวันที่ทีมทดสอบซอฟต์แวร์ปิดจุดบกพร่อง การปิดจุดบกพร่องถือเป็นส่วนสำคัญและสำคัญของการทดสอบซอฟต์แวร์

14) สถานะ:

เมื่อมีการสร้างจุดบกพร่องใหม่ สถานะของจุดบกพร่องควรเปิดอยู่ หลังจากนั้นจะผ่านขั้นตอนต่างๆ เช่น อยู่ระหว่างดำเนินการ แก้ไขแล้ว กำลังทำงาน เปิดใหม่ ฯลฯ

เคล็ดลับสำหรับการเขียนรายงานข้อผิดพลาด

ต่อไปนี้เป็นเคล็ดลับสำคัญที่คุณควรจำไว้ขณะเขียนรายงานข้อผิดพลาดที่มีประสิทธิภาพ:

• มีความเฉพาะเจาะจงเมื่อสร้างรายงานข้อบกพร่อง ตรวจสอบให้แน่ใจว่าคุณไม่ได้ใส่ข้อเท็จจริงที่ไร้ประโยชน์หรือไม่เกี่ยวข้องใดๆ
• คุณต้องรายงานจุดบกพร่องทันทีที่ตรวจพบ
• เตรียมรายงานโดยละเอียดเพื่อให้นักพัฒนาสามารถใช้ข้อเท็จจริงและข้อมูลในการแก้ไขปัญหาได้
• คุณควรทดสอบข้อผิดพลาดเดียวกันนี้ในโมดูลอื่นๆ ที่คล้ายกันเพื่อตรวจสอบความถูกต้อง
• Revดูรายงานข้อผิดพลาดอย่างน้อยหนึ่งครั้งก่อนที่จะส่ง
• คุณควรตรวจสอบให้แน่ใจว่ารายงานข้อบกพร่องมีคำอธิบายข้อผิดพลาดเพียงข้อเดียวเท่านั้น
• สุดท้ายนี้ คุณไม่ควรกลัวที่จะขอความช่วยเหลือจากผู้จัดการโครงการหากคุณรู้สึกไม่ชัดเจนเกี่ยวกับบางสิ่งบางอย่าง

เครื่องมือรายงานข้อผิดพลาด

ขณะนี้กระบวนการรายงานจุดบกพร่องซึ่งดำเนินการด้วยตนเอง กำลังดำเนินการด้วยเครื่องมือรายงานจุดบกพร่องต่างๆ ที่มีอยู่ในตลาด

• จิระ
• ตัวติดตามข้อบกพร่องของ Zoho
• Bugzilla

คุณสามารถตรวจสอบการตรวจสอบโดยละเอียดของเราได้ เครื่องมือรายงานข้อผิดพลาดที่ดีที่สุด

ปัญหาและแนวทางแก้ไขทั่วไปขณะเขียนรายงานข้อผิดพลาด:

ต่อไปนี้เป็นปัญหาทั่วไปและแนวทางแก้ไขขณะเขียนรายงานข้อบกพร่อง:

ตัวอย่างรายงานข้อผิดพลาด	ปัญหา
เมื่อคูณ 2 ด้วย 3 คำตอบจะเป็นค่าบวก	รายงานรูปแบบ ไม่ใช่ตัวอย่าง
รายการจะเรียงลำดับตามตัวอักษรเมื่อเพิ่มรายการใหม่เพื่อหลีกเลี่ยงปัญหานี้	อย่าเพียงแต่อธิบายว่ามีอะไรผิดปกติ
ตัวอย่างเช่น: คุณจะต้องเปิดเบราว์เซอร์และพิมพ์ URL ของเว็บไซต์ คุณจะพบช่องแรก 'ชื่อผู้ใช้' ที่สะกดผิด	ตรงประเด็นเสมอ (อย่าเล่าเรื่อง!)
ชื่อของลูกค้าในรายงานสะกดผิด ลำดับความสำคัญ: สูง, ระดับความรุนแรง: สูง	อย่าผสมลำดับความสำคัญและความรุนแรง
สูตรคำนวณภาษีไม่ถูกต้อง !!??	ไม่ใช้ CAPS ตัวอักษรสีแดง วงกลมสีแดง '!',
ฉันไม่คิดว่าการออกแบบหน้าแรกของ Ul นั้นไม่ดี	อย่าใช้วิจารณญาณของคุณ
ตัวอย่างคำอธิบายที่ไม่ชัดเจน: เกี่ยวกับการสนทนาของเราในวันนี้ โปรดดำเนินการที่จำเป็นสำหรับหน้านี้	ทำให้คำอธิบายของคุณเข้าใจได้สำหรับทุกคน
พื้นหลังของหน้าควรเป็นสีน้ำเงิน สีส้ม หรือสีเขียว หรือคุณสามารถทำให้เป็นสีดำหรือสีขาวก็ได้ สิ่งนี้ไม่ดีเนื่องจากไม่มีความชัดเจนว่าทีมพัฒนาและออกแบบเว็บไซต์ต้องการอะไร	ลดตัวเลือกให้เหลือน้อยที่สุด
บางครั้งสูตรการคำนวณภาษีไม่ทำงานตามที่คาดไว้	กฎทอง: อย่าใช้คำว่า 'บางครั้ง'

ตัวอย่างรายงานข้อผิดพลาด

นี่เป็นตัวอย่างเล็กๆ น้อยๆ ของรายงานข้อผิดพลาด:

[บัญชีของฉัน] จะปรากฏขีดเส้นใต้เมื่อนำเมาส์ไปวางเหนือปุ่มอัปเดต

Descriptไอออน: เราจำเป็นต้องลบการขีดเส้นใต้ออกเมื่อวางเมาส์เหนือปุ่มอัปเดตในส่วนบัญชีของฉัน

Link: http://test.com/mv-account/

เบราว์เซอร์/ระบบปฏิบัติการ: Chrome 25 OSX โยเซมิตี 10.10.2

ขั้นตอนในการทำซ้ำ:

1. ไปที่ www.test.com

2. เข้าสู่ระบบผ่านข้อมูลรับรองการเข้าสู่ระบบ

3. ไปที่บัญชีของฉัน

4. วางเมาส์เหนือปุ่มอัปเดต

ผลลัพธ์ที่แท้จริง: มีการขีดเส้นใต้

ผลลัพธ์ที่คาดหวัง: ไม่มีการขีดเส้นใต้

ข้อมูลการเข้าสู่ระบบ: test@test.com / mysecretpass12

ต้องหลีกเลี่ยงข้อผิดพลาดในการเขียนรายงานข้อผิดพลาด

นี่คือข้อผิดพลาดที่สำคัญบางประการที่คุณควรหลีกเลี่ยงในขณะที่เขียนรายงานข้อผิดพลาด:

• อย่าเขียนเกี่ยวกับความไม่พอใจของคุณและอย่ารวมความรู้สึกส่วนตัวของคุณด้วย
• มันสร้างความรำคาญให้กับผู้คนที่ต้องการมุ่งความสนใจไปที่งานเมื่อคุณโพสต์อีโมติคอนมากเกินไปในโพสต์ของคุณ
• อย่าโพสต์ของคุณมากเกินไปด้วยเครื่องหมายอัศเจรีย์ มันไม่ทำให้งานเร็วขึ้น
• ไม่มีใครอยากรู้สึกขุ่นเคือง มันทำลายแรงจูงใจและทำให้การตระหนักถึงปัญหาช้าลง