Cara Menulis Laporan Bug dengan Contoh

Oleh: Lucas Bennett Lucas Bennett
Hours Updated

Apa itu Laporan Bug? Mengapa Anda memerlukan laporan bug yang bagus?

Bug Report merupakan dokumen penting dalam STLC yang menawarkan berbagai keuntungan bagi tim pengujian. Itu melacak semua cacat, banyak bug, kesalahan, dan perbedaan lain yang ditemukan selama pengujian perangkat lunak dan melaporkannya.

Tujuan dari dokumentasi pasca pengujian ini adalah untuk memberikan informasi kepada tim profesional terkait tentang tingkat bug yang ditemui selama proses pengujian.

Anda insinyur pengembangan perangkat lunak dapat mengetahui semua cacat dan masalah yang ada dalam perangkat lunak menggunakan jenis laporan ini. Ini juga memungkinkan Anda mengetahui apa yang salah pada suatu bug, sehingga Anda dapat menggunakan metode terbaik untuk memperbaikinya. Ini juga membantu Anda menghemat waktu dan uang dengan membantu Anda mendeteksi bug dan masalah.

Mengapa Anda harus peduli dengan penjelasan bug yang bagus?

Penjelasan Bug yang Bagus

Inilah hal yang perlu Anda pertimbangkan untuk menulis laporan bug perangkat lunak yang baik dan terperinci:

  • Ini bertindak sebagai panduan untuk membantu menghindari bug yang sama di rilis mendatang.
  • Hemat waktu untuk komunikasi (e-mail, panggilan).
  • Less bekerja untuk pengembang (mereka akan melakukan apa yang Anda inginkan).
  • Anda akan memiliki lebih sedikit hambatan dalam proyek ini; bug akan diperbaiki dengan cara yang lebih cepat dan efisien.

Cara Menulis Laporan Bug (Templat Laporan Bug)

Tidak ada templat laporan bug yang pasti, karena ini bergantung pada sistem pelacakan bug Anda. Templat Anda mungkin berbeda.

Namun, bidang umum berikut selalu diperlukan saat Anda ingin menulis laporan bug:

  • ID bug/Judul.
  • Keparahan dan Prioritas.
  • Description
  • Lingkungan Hidup
  • Langkah-langkah untuk mereproduksi.
  • Hasil yang diharapkan.
  • Hasil sebenarnya.
  • Lampiran (tangkapan layar, video, teks)

Mari kita lihat semua komponen penanggulangan bug ini satu per satu:

1) Judul/ID Bug:

Setiap bug harus diberi nomor identifikasi unik. Alat pelaporan bug harus berupa nomor unik untuk bug yang baru muncul sehingga kami dapat dengan mudah mengidentifikasi bug tersebut.

contoh:

❌ Buruk: “Saya tidak dapat melihat produknya saat saya melihatnya lagi, salahnya tidak.”

  • Samar
  • Agresif
  • Terlalu bertele-tele

meminta solusi untuk diterapkan.

✅ Bagus: “CART – Item baru yang ditambahkan ke keranjang tidak muncul”.

  • Judul semacam ini langsung menemukan masalahnya (CART)
  • Ini berfokus pada masalah teknis yang sebenarnya.

2) Tingkat Keparahan Bug:

Tingkat keparahan bug merupakan faktor yang sangat penting dalam laporan bug. Ini menjelaskan dampak cacat pada kinerja aplikasi.

  • Pemblokir: Kesalahan ini menyebabkan aplikasi gagal.
  • Utama: Kesalahan kritis menunjukkan perubahan besar dalam logika bisnis.
  • Minor: Masalah yang tidak mempengaruhi fungsionalitas aplikasi namun mempengaruhi hasil yang diharapkan.
  • Remeh: Ini tidak mempengaruhi fungsionalitas atau pengoperasian aplikasi. Ini mungkin kesalahan ketik.

3) Prioritas Bug:

Berikut ini adalah gradasi umum untuk menentukan prioritas bug:

  • Tinggi: Ini mencakup segala hal yang memengaruhi alur atau memblokir penggunaan aplikasi.
  • Sedang: Ini berdampak buruk pada pengalaman pengguna.
  • Minor: Semua kesalahan lainnya seperti (kesalahan ketik, ikon hilang, masalah tata letak, dll.).

4) Lingkungan:

Bug dapat muncul di lingkungan tertentu dan bukan di lingkungan lain. Misalnya, terkadang muncul bug saat menjalankan website Firefox, atau aplikasi tidak berfungsi hanya saat dijalankan di Android perangkat dan berfungsi dengan baik di iPhone.

Laporan bug ini hanya dapat diidentifikasi dengan pengujian lintas browser atau lintas perangkat. Jadi, saat melaporkan bug, QA harus dapat menentukan apakah bug tersebut harus diamati di satu atau lebih lingkungan tertentu.

5) Ringkasan:

Namun, menambahkan hanya Judul dalam laporan bug tidak memenuhi tujuan tersebut. Jadi, jika Judul Anda belum cukup, Anda bisa menambahkan ringkasan laporan singkat.

Ringkasan Anda dalam kata-kata sesedikit mungkin termasuk kapan dan bagaimana bug terjadi. Judul dan deskripsi bug Anda juga harus digunakan dalam pencarian, jadi Anda harus memastikan bahwa Anda telah mencakup kata kunci yang penting.

contoh:

  • Buruk: “Saya mencoba menambahkan sesuatu ke dalam tes, dan tidak ada yang muncul ketika saya melakukannya atau mengklik tombolnya.”
  • Baik: “Saat saya mencoba menambahkan [PRODUK] ke keranjang belanja, namun tidak terjadi apa-apa saat saya mengklik tombol 'tambah' di halaman web ikhtisar produk tertentu.”

6) Langkah-langkah untuk memperbanyak:

Saat melaporkan bug, penting untuk menentukan langkah-langkah untuk mereproduksinya. Anda juga harus menyertakan tindakan yang dapat menyebabkan bug. Di sini, jangan membuat pernyataan umum apa pun.

Jelaskan secara spesifik langkah-langkah yang harus diikuti:

Berikut adalah contoh prosedur yang ditulis dengan baik:

Tangga:

  1. Pilih produk X1.
  2. Klik Tambahkan ke troli.
  3. Klik Hapus untuk mengeluarkan produk dari keranjang.

7) Hasil yang diharapkan:

Dalam laporan bug, penting untuk menjelaskan hasil yang diharapkan per tugas teknis, desain hasil kasus uji, atau menurut pendapat penguji. Semua ini membantu pengembang untuk fokus dalam menemukan informasi yang dibutuhkan dengan cepat.

Sebagai contoh:

Bidang yang wajib diisi harus disorot dengan warna merah setelah mengklik tombol “Kirim”.

8) Hasil sebenarnya:

Seperti namanya, bidang ini menjelaskan efek bug yang sebenarnya. Sangat penting untuk menulis gambaran yang jelas tentang hasil sebenarnya.

Sebagai contoh:

Bidang yang wajib diisi disorot dengan warna hijau setelah mengklik tombol “Kirim”.

9) Lampiran (tangkapan layar dan video):

Dalam laporan bug, praktik terbaiknya adalah melampirkan file ke laporan bug yang membuatnya lebih mudah untuk melihat informasi saat Anda perlu menampilkannya secara visual:

Sebagai contoh:

  • Screenshot: Tangkapan layar dapat dengan mudah menguraikan kesalahan dalam program; Ini nyaman ketika bug disorot dengan anotasi, lingkaran, atau gambar panah tertentu).
  • Video: Terkadang, sulit untuk menggambarkan bug dengan kata-kata, jadi lebih baik membuat video agar pengembang dapat memperbaiki cacat pada program).

10) Versi yang Terkena Dampak:

Ini adalah versi perangkat lunak yang terpengaruh tempat bug dilaporkan.

11) Perbaiki Versi:

Ini adalah versi perangkat lunak yang mengatasi bug. Jadi ketika QA yang melaporkan bug tersebut, memeriksa apakah bug tersebut telah diperbaiki, dia menggunakan versi perangkat lunak yang benar.

12) Target versi:

Versi target dimana bug harus ditargetkan untuk diperbaiki. Jadi, ketika tim pengembangan berupaya memperbaiki bug, mereka kebanyakan menargetkan versi aplikasi tertentu.

13) Tanggal Ditutup:

Ini adalah tanggal ketika bug ditutup oleh tim pengujian perangkat lunak. Menutup bug adalah bagian penting dan integral dari pengujian perangkat lunak.

14) Keadaan:

Ketika bug baru dibuat, statusnya harus terbuka. Setelah itu melalui tahapan seperti In Progress, Fixed, Running, Reopen, dll.

ARTIKEL TERKAIT

Tips Penulisan Laporan Bug

Berikut beberapa tip penting yang harus Anda ingat saat menulis laporan bug yang efektif:

  • Bersikaplah spesifik saat membuat laporan bug. Pastikan Anda tidak menyertakan fakta yang tidak berguna atau tidak relevan.
  • Anda harus segera melaporkan bug tersebut segera setelah terdeteksi.
  • Siapkan laporan secara detail untuk memberdayakan pengembang dalam menggunakan fakta dan informasi untuk men-debug masalah.
  • Anda harus menguji kejadian bug yang sama pada modul serupa lainnya untuk validasi.
  • Revmelihat laporan bug setidaknya sekali sebelum mengirimkannya.
  • Anda harus memastikan bahwa laporan bug berisi deskripsi hanya satu kesalahan.
  • Terakhir, Anda tidak perlu takut untuk meminta bantuan Project Manager jika Anda merasa kurang jelas tentang suatu hal.

Alat Pelaporan Bug

Proses pelaporan bug yang dilakukan secara manual, kini dilakukan dengan berbagai alat pelaporan bug yang tersedia di pasar.

Anda dapat memeriksa ulasan rinci kami tentang alat pelaporan bug terbaik.

Masalah Umum dan Solusi saat Menulis laporan bug:

Berikut beberapa masalah umum dan solusinya saat menulis laporan bug:

Contoh Laporan Bug Masalah
Saat mengalikan 2 dengan 3, jawabannya positif. Laporkan polanya, bukan contohnya.
Daftar akan diurutkan berdasarkan abjad saat menambahkan item baru untuk menghindari hal ini. Jangan hanya menjelaskan apa yang salah
Sebagai contoh:
Untuk melakukannya, Anda perlu membuka browser Anda dan mengetikkan URL situs. Anda akan menemukan kolom pertama, 'nama pengguna', salah eja.		 Selalu langsung pada intinya (Jangan pernah menceritakan kisahnya!).
Nama klien dalam laporan salah eja. Prioritas: Tinggi, Keparahan: Tinggi Jangan pernah mencampurkan prioritas dan tingkat keparahan.
Rumus perhitungan pajak SALAH!!?? Tidak menggunakan CAPS, huruf merah, lingkaran merah, '!',
Menurut saya, desain halaman beranda Ul tidak bagus. Jangan gunakan penilaian Anda.
Contoh deskripsi yang tidak jelas: Tentang diskusi kita hari ini, silakan lakukan tindakan yang diperlukan untuk halaman ini. Buat deskripsi Anda dapat dimengerti oleh semua orang.
Latar belakang halaman harus berwarna biru, oranye, atau hijau, atau Anda dapat membuatnya menjadi hitam atau putih.

Ini tidak baik karena tidak jelas apa yang dibutuhkan dari tim pengembangan dan desain web

 Minimalkan pilihan
Rumus penghitungan pajak terkadang tidak berjalan sesuai harapan. Aturan emasnya: Jangan gunakan kata 'Kadang-kadang'.

Contoh Laporan Bug

Berikut ini contoh kecil laporan bug:

[AKUN SAYA] Garis bawah ditampilkan ketika mouse diarahkan pada tombol Perbarui.

Description: Kita perlu menghilangkan garis bawah ketika mengarahkan mouse pada tombol Update di bagian Akun Saya.

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

Peramban/OS: Chrome 25.OSX Yosemite 10.10.2

Langkah-langkah untuk mereproduksi:

1. Kunjungi www.test.com

2. Masuk melalui kredensial login

3. Navigasikan ke Akun Saya

4. Arahkan mouse pada tombol Perbarui

Hasil sebenarnya: ada garis bawah.

Hasil yang diharapkan: tidak ada garis bawah.

Data Login: test@test.com / mysecretpass12

Harus menghindari kesalahan dalam penulisan laporan bug

Berikut beberapa kesalahan penting yang harus Anda hindari saat menulis laporan bug:

  • Jangan menulis tentang ketidakpuasan Anda, dan jangan pernah memasukkan perasaan pribadi Anda.
  • Ini mengganggu orang yang ingin fokus pada tugas ketika Anda membebani postingan Anda dengan banyak emotikon.
  • Jangan pernah membebani postingan Anda dengan tanda seru; itu tidak mempercepat pekerjaan.
  • Tidak seorang pun ingin merasa tersinggung. Hal ini menghancurkan motivasi dan memperlambat realisasi permasalahan.

Anda mungkin ingin: