Meni

Kako napisati dobar izvještaj o greškama? Savjeti i trikovi

how write good bug report

Isprobajte Naš Instrument Za Uklanjanje Problema

Zašto dobar izvještaj o greškama?

Ako je vaše izvješće o greškama učinkovito, tada su veće šanse da se popravi. Dakle, ispravljanje programske pogreške ovisi o tome koliko učinkovito je prijavljujete. Prijavljivanje greške nije ništa drugo nego vještina i objasnit ću vam kako to postići.

„Smisao pisanja izvještaja o problemu (izvješća o bugovima) je popraviti greške“ - Autor Cem Kaner. Ako tester ne prijavljuje pogrešku ispravno, programer će najvjerojatnije odbiti tu pogrešku navodeći je kao nepodnošljivu.

Kako napisati dobar izvještaj o greškama

To može naštetiti testeralima, a ponekad i egu. (Predlažem da se ne zadržava bilo kakva vrsta ega. Ego je poput 'Ja sam ispravno prijavio grešku', 'Mogu je reproducirati', 'Zašto je on / ona odbacio grešku?', 'Nisam ja kriv' itd.) ,).

Što ćete naučiti:

Koje su osobine dobrog izvješća o softverskim greškama?

Svatko može napisati izvještaj o greškama. Ali ne može svatko napisati učinkovito izvješće o greškama.

Morali biste razlikovati prosječno izvješće o bugu i dobro izvješće o bugu. Kako razlikovati dobar i loš izvještaj o greškama? Vrlo je jednostavno, primijenite sljedeće karakteristike i tehnike za prijavljivanje pogreške.

Karakteristike i tehnike uključuju

# 1) Imati jasno naznačen broj greške: Uvijek dodijelite jedinstveni broj svakom izvješću o programskoj pogrešci. To će vam, pak, pomoći da identificirate zapis greške. Ako koristite bilo koji automatski alat za prijavljivanje pogrešaka, taj će se jedinstveni broj automatski generirati svaki put dok prijavljujete grešku.

Zabilježite broj i kratki opis svake pogreške koju ste prijavili.

# 2) Reproducibilno: Ako se vaša pogreška ne može ponoviti, tada se nikad neće popraviti.

Jasno biste trebali spomenuti korake za reprodukciju greške. Nemojte pretpostavljati niti preskakati bilo koji korak reprodukcije. Grešku koja je opisana korak po korak lako je reproducirati i popraviti.

# 3) Budite precizni: Ne pišite esej o problemu.

Budite precizni i jasni. Pokušajte sažeti problem u najmanje riječi, a na učinkovit način. Ne kombinirajte više problema, čak i ako se čini da su slični. Napišite različita izvješća za svaki problem.

Učinkovito izvještavanje o greškama

Izvještavanje o greškama važan je aspekt testiranja softvera. Učinkovito izvješće o programskim pogreškama dobro komunicira s razvojnim timom i izbjegava zabune ili pogrešne komunikacije.

Trebao bi biti dobar izvještaj o greškama jasan i sažet bez ikakvih nedostajućih ključnih točaka. Svaka nejasnoća dovodi do nesporazuma i usporava i razvojni proces. Pisanje i izvještavanje o nedostacima jedno je od najvažnijih, ali zanemarenih područja u životnom ciklusu testiranja.

Dobro prijavljivanje je vrlo važno za prijavu programske pogreške. Najvažnija stvar koju tester treba imati na umu je da se ne koristi zapovjednim tonom u izvještaju. To ruši moral i stvara nezdrav radni odnos. Upotrijebite sugestivni ton.

Ne pretpostavljajte da je programer pogriješio i stoga možete koristiti oštre riječi. Prije prijavljivanja, jednako je važno provjeriti je li prijavljena ista greška ili nije.

Dvostruka programska pogreška je teret u ciklusu ispitivanja. Pogledajte cijeli popis poznatih grešaka. Ponekad su programeri mogli znati problem i zanemariti ga za buduće izdanje. Također se mogu koristiti alati poput Bugzille koji automatski traži duplicirane greške. Međutim, najbolje je ručno tražiti bilo kakvu dupliciranu pogrešku.

Podaci o uvozu koje izvješće o programskoj pogrešci mora priopćiti jesu 'Kako?' i gdje?' Izvještaj treba jasno odgovoriti kako je izvedeno ispitivanje i gdje je točno došlo do kvara. Čitač bi trebao lako reproducirati grešku i pronaći gdje se ona nalazi.

Imajte na umu da cilj pisanja izvještaja o greškama je omogućiti programeru da vizualizira problem. Trebao bi jasno razumjeti kvar iz izvješća o greškama. Ne zaboravite dati sve relevantne informacije koje programer traži.

Također, imajte na umu da bi se izvještaj o greškama sačuvao za buduću upotrebu i trebao bi biti dobro napisan s potrebnim informacijama. Koristite smislene rečenice i jednostavne riječi da opišem vaše greške. Ne upotrebljavajte zbunjujuće izjave koje troše vrijeme recenzenta.

Svaki bug prijavite kao zaseban problem. U slučaju više poteškoća u jednom izvješću o greškama, ne možete ga zatvoriti ako se svi problemi ne riješe.

Stoga je najbolje da podijeliti probleme u zasebne greške . To osigurava da se svakom programskom pogreškom može rukovati zasebno. Dobro napisano izvješće o programskoj pogrešci pomaže programeru da reproducira grešku na njihovom terminalu. To im pomaže i da dijagnosticiraju problem.

Kako prijaviti grešku?

Upotrijebite sljedeći jednostavni predložak izvještaja o greškama:

Ovo je jednostavan format izvještaja o greškama. Može se razlikovati ovisno o alatu za prijavu grešaka koji koristite. Ako ručno pišete izvještaj o programskoj pogrešci, neka polja moraju biti posebno navedena, poput broja greške, koji bi trebao biti dodijeljen ručno.

Reporter: Vaše ime i adresa e-pošte.

Proizvod: U kojem ste proizvodu pronašli ovu grešku.

Verzija: Verzija proizvoda, ako postoji.

Komponenta: To su glavni podmoduli proizvoda.

Platforma: Spomenite hardversku platformu na kojoj ste pronašli ovu pogrešku. Razne platforme poput 'PC', 'MAC', 'HP', 'Sun' itd.

Operacijski sustav: Spomenite sve operativne sustave u kojima ste pronašli bug. Operativni sustavi poput Windows, Linux, Unix, SunOS, Mac OS. Navedite različite verzije OS-a, poput Windows NT, Windows 2000, Windows XP itd., Ako je primjenjivo.

Prioritet: Kada treba ispraviti grešku? Općenito se prioritet postavlja od P1 do P5. P1 kao 'ispraviti programsku pogrešku s najvišim prioritetom', a P5 kao 'Ispraviti kada vrijeme dopušta'

Ozbiljnost: Ovo opisuje utjecaj programske pogreške.
Vrste ozbiljnosti:

  • Bloker: Daljnje ispitivanje nije moguće.
  • Kritično: Otkazivanje aplikacije, gubitak podataka.
  • Major: Veliki gubitak funkcije.
  • Maloljetnik: Manji gubitak funkcije.
  • Trivijalno: Neka poboljšanja korisničkog sučelja.
  • Poboljšanje: Zahtjev za novom značajkom ili nekim poboljšanjem u postojećoj.

Status: Kada prijavljujete bug u bilo koji sustav za praćenje bugova, tada će status buga biti 'Novo'.
Kasnije bug prolazi kroz razne faze poput Fixed, Verified, Reopen, Won’t Fix, itd.

kako proslijediti niz kao parametar u javi

=> Kliknite ovdje kako biste pročitali više o detaljnom životnom ciklusu grešaka.

Dodijeli: Ako znate koji je programer odgovoran za taj određeni modul u kojem se dogodila pogreška, tada možete navesti e-adresu tog programera. U suprotnom neka ostane prazno jer će ovo dodijeliti bug vlasniku modula, ako ne, upravitelj će ga dodijeliti programeru. Možda dodajte upraviteljevu e-adresu na CC popis.

URL: URL stranice na kojoj se dogodila pogreška.

Sažetak: Kratki sažetak programske pogreške uglavnom u 60 riječi ili niže. Provjerite odražava li vaš sažetak problem i gdje je.

Opis: Detaljan opis greške.

Koristite sljedeća polja za polje opisa:

  • Koraci reprodukcije: Jasno, spomenite korake za reprodukciju greške.
  • Očekivani rezultat: Kako bi se aplikacija trebala ponašati na gore spomenutim koracima.
  • Stvarni rezultat: Koji je stvarni rezultat izvođenja gornjih koraka, tj. Ponašanje programske pogreške.

Ovo su važni koraci u izvješću o bugovima. Također možete dodati „Vrsta izvještaja“ kao još jedno polje koje će opisati vrstu greške.

Vrste izvještaja uključuju:

1) Pogreška kodiranja
2) Pogreška u dizajnu
3) Novi prijedlog
4) Pitanje dokumentacije
5) Hardverski problem

Važne značajke u vašem izvješću o greškama

Slijede važne značajke u izvješću o greškama:

# 1) Broj greške / id

Broj greške ili identifikacijski broj (poput swb001) olakšava prijavljivanje grešaka i upućivanje na grešku. Programer može lako provjeriti je li određena pogreška ispravljena ili nije. To čini cijeli postupak testiranja i ponovnog testiranja glatkijim i lakšim.

# 2) Naslov greške

Naslov greške čita se češće od bilo kojeg drugog dijela izvješća o greškama. Trebalo bi reći sve o tome što dolazi s programskom pogreškom.

Naslov Bug trebao bi biti dovoljno sugestivan da ga čitatelj može razumjeti. Jasan naslov programske pogreške olakšava razumijevanje, a čitatelj može znati je li pogreška ranije prijavljena ili je ispravljena.

# 3) Prioritet

Na temelju ozbiljnosti programske pogreške, može joj se postaviti prioritet. Bug može biti bloker, kritičan, glavni, manji, trivijalan ili prijedlog. Može se dati prioritet programske pogreške s P1 na P5 tako da se prvo pregledaju važni.

# 4) Platforma / Okoliš

Konfiguracija OS-a i preglednika potrebna je za jasno izvješće o programskim pogreškama. To je najbolji način za priopćavanje načina na koji se greška može reproducirati.

Bez točne platforme ili okruženja, aplikacija se može ponašati drugačije, a greška na kraju testera možda se neće replicirati na kraju programera. Stoga je najbolje jasno spomenuti okruženje u kojem je bug otkriven.

# 5) Opis

Opis greške pomaže programeru da razumije grešku. Opisuje naišli problem. Loš opis stvorit će zabunu i izgubiti vrijeme programera i testera.

Potrebno je jasno komunicirati o učinku opisa. Uvijek je korisno koristiti cjelovite rečenice. Dobra je praksa opisivati ​​svaki problem zasebno, umjesto da ih se u potpunosti ruši. Nemojte koristiti izraze poput 'mislim' ili 'vjerujem'.

# 6) Koraci za reprodukciju

U dobrom izvješću o greškama trebali bi se jasno spomenuti koraci za reprodukciju. Koraci bi trebali uključivati ​​radnje koje uzrokuju bug. Ne dajte generičke izjave. Budite precizni u koracima koje ćete slijediti.

Dobar primjer dobro napisanog postupka dan je u nastavku

Koraci:

  • Odaberite proizvod Abc01.
  • Kliknite Dodaj u košaricu.
  • Kliknite Ukloni da biste uklonili proizvod iz košarice.

# 7) Očekivani i stvarni rezultat

Opis greške je nepotpun bez očekivanih i stvarnih rezultata. Potrebno je naznačiti kakav je ishod testa i što korisnik treba očekivati. Čitatelj bi trebao znati koji je ispravan ishod testa. Jasno, spomenite što se dogodilo tijekom testa i kakav je bio ishod.

# 8) Snimka zaslona

Slika vrijedi tisuću riječi. Snimite snimak zaslona slučaja neuspjeha s odgovarajućim natpisima kako biste istaknuli nedostatak. Neočekivane poruke o pogreškama istaknite svijetlocrvenom bojom. To skreće pozornost na traženo područje.

Nekoliko bonus savjeta za pisanje dobrog izvještaja o greškama

Slijedi još nekoliko dodatnih savjeta za pisanje dobrog izvještaja o greškama:

# 1) Odmah prijavite problem

razlika između porta prema naprijed i okidača porta

Ako tijekom testiranja nađete bilo kakvu grešku, nemojte čekati da kasnije napišete detaljan izvještaj o grešci. Umjesto toga, odmah napišite izvještaj o grešci. To će osigurati dobro i ponovljivo izvješće o greškama. Ako odlučite kasnije napisati izvještaj o greškama, velike su šanse da ćete propustiti važne korake u svom izvješću.

# 2) Reproducirajte grešku tri puta prije pisanja izvještaja o grešci

Vaša greška trebala bi biti ponovljiva. Provjerite jesu li vaši koraci dovoljno robusni da reproduciraju pogrešku bez ikakvih dvosmislenosti. Ako se vaša pogreška ne može ponoviti svaki put, još uvijek možete prijaviti grešku spominjući periodičnu prirodu greške.

# 3) Testirajte istu pojavu greške na drugim sličnim modulima

Ponekad programer koristi isti kod za različite slične module. Dakle, veće su šanse da se bug u jednom modulu pojavi i na drugim sličnim modulima. Možete čak pokušati pronaći ozbiljniju verziju programske pogreške koju ste pronašli.

# 4) Napišite dobar sažetak greške

Sažetak grešaka pomoći će programerima da brzo analiziraju prirodu greške. Izvještaj loše kvalitete nepotrebno će povećati vrijeme izrade i testiranja. Dobro komunicirajte sa sažetkom izvješća o programskim pogreškama. Imajte na umu da se sažetak programske pogreške koristi kao referenca za pretraživanje greške u popisu bugova.

# 5) Pročitajte izvješće o greškama prije nego što pritisnete gumb Pošalji

Pročitajte sve rečenice, izraze i korake koji se koriste u izvješću o programskoj pogrešci. Pogledajte stvara li neka rečenica dvosmislenost koja može dovesti do pogrešnog tumačenja. Treba izbjegavati obmanjujuće riječi ili rečenice kako bi se dobio jasan izvještaj o programskoj pogrešci.

# 6) Ne koristite nasilni jezik

Lijepo je što ste dobro obavili posao i pronašli grešku, ali ne koristite ovu zaslugu za kritiziranje programera ili za napad na bilo kojeg pojedinca.

Zaključak

Nema sumnje da bi vaše izvješće o greškama trebalo biti visokokvalitetni dokument.

Usredotočite se na pisanje dobrih izvještaja o greškama i provedite malo vremena na ovom zadatku jer je ovo glavna točka komunikacije između ispitivača, programera i upravitelja. Menadžeri bi trebali stvoriti svijest o svom timu da je pisanje dobrog izvještaja o greškama primarna odgovornost bilo kojeg ispitivača.

Vaš trud oko pisanja dobrog izvještaja o greškama ne samo da će uštedjeti resurse tvrtke već će stvoriti dobar odnos između vas i programera.

Za bolju produktivnost napišite bolje izvješće o greškama.

Jeste li stručnjak za pisanje izvještaja o greškama? Slobodno podijelite svoje misli u odjeljku za komentare u nastavku.

Preporučena literatura

^