dokumentasi<Sebelum | Contents [show] | Seterusnya>
Perkara yang Perlu Diletakkan dalam Laporan Pepijat
Arahan untuk Menghasilkan Semula Masalah Untuk dapat menghasilkan semula isu tersebut, pembangun perlu mengetahui perkara yang anda gunakan, dari mana anda mendapatkannya dan cara anda memasangnya.
Anda harus memberikan arahan langkah demi langkah yang tepat yang menerangkan cara menghasilkan semula masalah. Jika anda perlu menggunakan beberapa data untuk menghasilkan semula masalah, lampirkan fail yang sepadan pada laporan pepijat. Cuba dapatkan set arahan minimum yang diperlukan untuk menghasilkan semula pepijat.
Berikan Beberapa Konteks dan Tetapkan Jangkaan Anda Terangkan apa yang anda cuba lakukan dan bagaimana anda menjangkakan program itu akan bertindak.
Dalam sesetengah kes, pepijat hanya dicetuskan kerana anda menggunakan program dengan cara ia tidak direka bentuk untuk beroperasi oleh pembangun. Dengan menerangkan perkara yang anda cuba capai, anda akan membenarkan pembangun melihat dengan jelas apabila ini berlaku.
Dalam sesetengah kes lain, tingkah laku yang anda gambarkan sebagai pepijat mungkin sebenarnya adalah tingkah laku biasa. Jelas tentang perkara yang anda jangkakan program itu lakukan. Ini akan menjelaskan keadaan bagi pemaju. Mereka mungkin sama ada memperbaiki tingkah laku atau menambah baik dokumentasi, tetapi sekurang-kurangnya mereka tahu bahawa tingkah laku program mereka mengelirukan sesetengah pengguna!
Be Specific Sertakan nombor versi perisian yang anda gunakan, mungkin dengan nombor versi kebergantungan mereka. Apabila anda merujuk kepada sesuatu yang anda muat turun, sertakan URL lengkapnya.
Apabila anda mendapat mesej ralat, sebutkan ia betul-betul seperti yang anda lihat. Jika boleh, sertakan salinan output skrin anda atau tangkapan skrin. Sertakan salinan mana-mana fail log yang berkaitan, memastikan anda mengalih keluar sebarang data sensitif terlebih dahulu.
Sebutkan Kemungkinan Pembetulan atau Penyelesaian Sebelum memfailkan laporan pepijat, anda mungkin cuba menyelesaikan semula masalah tersebut. Terangkan apa yang anda cuba dan hasil yang anda terima. Jadi sangat jelas tentang apa itu fakta dan apa yang hanya hipotesis di pihak anda.
Jika anda membuat carian Internet dan menemui beberapa penjelasan tentang masalah yang sama, anda boleh menyebutnya, khususnya apabila anda menemui laporan pepijat lain yang serupa dalam penjejak pepijat Debian atau penjejak pepijat huluan.
Jika anda menemui cara untuk mencapai hasil yang diingini tanpa mencetuskan pepijat, sila dokumen itu juga. Ini akan membantu pengguna lain yang dilanda isu yang sama.
Laporan Pepijat Panjang Baik Laporan pepijat dua baris tidak mencukupi; menyediakan semua maklumat yang diperlukan biasanya memerlukan beberapa perenggan (atau kadangkala halaman) teks.
Bekalkan semua maklumat yang anda boleh. Cuba berpegang pada perkara yang relevan, tetapi jika anda tidak pasti, terlalu banyak adalah lebih baik daripada terlalu sedikit.
Jika laporan pepijat anda benar-benar panjang, luangkan sedikit masa untuk menstruktur kandungan dan berikan ringkasan ringkas pada permulaan.