Meni

Kako napisati dobro poročilo o napaki? Namigi in triki

how write good bug report

Preizkusite Naš Instrument Za Odpravo Težav

Zakaj dobro poročilo o napakah?

Če je vaše poročilo o napakah učinkovito, so možnosti za njegovo odpravo večje. Torej je odprava napake odvisna od tega, kako učinkovito jo prijavite. Prijava napake ni nič drugega kot spretnost in razložil bom, kako jo doseči.

'Bistvo pisanja poročila o težavah (poročilo o napaki) je odpravljanje napak' - avtor Cem Kaner. Če preizkuševalec napake ne prijavi pravilno, jo bo programer najverjetneje zavrnil in jo označil kot neponovljivo.

Kako napisati dobro poročilo o napaki

To lahko preizkuševalce prizadene moralno in včasih tudi ego. (Predlagam, da ne obdržite nobene vrste ega. Ego je na primer »Napako sem prijavil napako«, »Lahko jo reproduciram«, »Zakaj je napako zavrnil?«, »Nisem kriv jaz« itd.) ,).

Kaj se boste naučili:

Kakšne so lastnosti dobrega poročila o programski napaki?

Vsakdo lahko napiše poročilo o napaki. Ne more pa vsak napisati učinkovitega poročila o napakah.

Morali bi razlikovati med povprečnim poročilom o napaki in dobrim poročilom o napaki. Kako razlikovati med dobrim in slabim poročilom o napakah? Zelo preprosto je, če za prijavo napake uporabite naslednje značilnosti in tehnike.

Značilnosti in tehnike vključujejo

# 1) z jasno določeno številko napake: Vsakemu poročilu o napakah vedno dodelite enolično številko. To pa vam bo pomagalo prepoznati zapis napak. Če uporabljate avtomatizirano orodje za poročanje o napakah, bo ta enolična številka samodejno ustvarjena vsakič, ko prijavite napako.

Upoštevajte številko in kratek opis vsake napake, o kateri ste poročali.

# 2) Ponovljivo: Če vaše napake ni mogoče ponoviti, je ne bo mogoče popraviti.

Jasno morate omeniti korake za reprodukcijo napake. Ne predpostavljajte ali preskakujte nobenega koraka reprodukcije. Napako, ki je opisana korak za korakom, je enostavno reproducirati in odpraviti.

# 3) Bodite natančni: Ne pišite eseja o težavi.

Bodite natančni in natančni. Poskusite težavo strniti z najmanj besedami, vendar na učinkovit način. Ne kombinirajte več težav, tudi če se zdi, da so si podobne. Za vsako težavo napišite različna poročila.

Učinkovito poročanje o napakah

Poročanje o napakah je pomemben vidik preskušanja programske opreme. Učinkovito poročilo o napakah dobro komunicira z razvojno skupino in preprečuje zmedo ali napačne komunikacije.

Dobro poročilo o napakah bi moralo biti jasno in jedrnato brez manjkajočih ključnih točk. Vsaka nejasnost vodi v nerazumevanje in upočasnjuje tudi razvojni proces. Pisanje in poročanje o napakah je eno najpomembnejših, a zapostavljenih področij v življenjskem ciklu testiranja.

Dobro pisanje je zelo pomembno za prijavo napake. Najpomembnejša točka, ki jo mora tester upoštevati, je ne uporabljajte ukaznega tona v poročilu. To poruši moralo in ustvari nezdravo delovno razmerje. Uporabite sugestivni ton.

Ne domnevajte da je razvijalec storil napako in zato lahko uporabite ostre besede. Pred poročanjem je enako pomembno, da preverite, ali je bila prijavljena ista napaka ali ne.

Podvojena napaka je breme v preskusnem ciklu. Preverite celoten seznam znanih napak. Včasih so razvijalci morda poznali težavo in jih za prihodnjo izdajo prezrli. Uporabite lahko tudi orodja, kot je Bugzilla, ki samodejno išče podvojene napake. Vendar je najbolje, da podvojene napake poiščete ročno.

Informacije o uvozu, ki jih mora sporočiti poročilo o napaki, so 'Kako?' in kje?' Poročilo mora jasno odgovoriti, kako je bil test izveden in kje je natančno prišlo do napake. Bralec bi moral enostavno reproducirati napako in najti, kje je napaka.

Upoštevajte, da cilj pisanja poročila o napakah je razvijalcu omogočiti vizualizacijo težave. Jasno bi moral razumeti napako iz poročila o napaki. Ne pozabite navesti vseh ustreznih informacij, ki jih išče razvijalec.

Upoštevajte tudi, da bi bilo poročilo o napaki shranjeno za prihodnjo uporabo in bi moralo biti dobro napisano z zahtevanimi informacijami. Uporabite pomenljive stavke in preproste besede za opis vaših napak. Ne uporabljajte zmedenih izjav, ki zapravljajo čas pregledovalca.

Vsako napako prijavite kot ločeno težavo. V primeru več težav v enem poročilu o napakah ga ne morete zapreti, če ne odpravite vseh težav.

Zato je najbolje, da razdelite težave na ločene napake . To zagotavlja, da je vsako napako mogoče obravnavati ločeno. Dobro napisano poročilo o napaki razvijalcu pomaga, da napako reproducira na svojem terminalu. To jim pomaga tudi pri diagnosticiranju težave.

Kako prijaviti napako?

Uporabite naslednjo preprosto predlogo poročila o napakah:

To je preprosta oblika poročila o napakah. Lahko se razlikuje glede na orodje za poročanje o napakah, ki ga uporabljate. Če poročilo o napaki pišete ročno, je treba posebej omeniti nekatera polja, na primer številko napake, ki jo je treba dodeliti ročno.

Poročevalec: Vaše ime in e-poštni naslov.

Izdelek: V katerem izdelku ste našli to napako.

Različica: Različica izdelka, če obstaja.

najboljši brezplačni DVD ripper Windows 10

Komponenta: To so glavni podmoduli izdelka.

Platforma: Omenite strojno platformo, kjer ste našli to napako. Različne platforme, kot so 'PC', 'MAC', 'HP', 'Sun' itd.

Operacijski sistem: Omenite vse operacijske sisteme, v katerih ste našli napako. Operacijski sistemi, kot so Windows, Linux, Unix, SunOS, Mac OS. Omenite tudi različne različice OS, kot so Windows NT, Windows 2000, Windows XP itd., Če je primerno.

Prednost: Kdaj je treba odpraviti napako? Prednost je običajno nastavljena od P1 do P5. P1 kot »odpravi napako z najvišjo prioriteto«, P5 pa kot »Popravi, ko čas dopušča«.

Resnost: Ta opisuje vpliv napake.
Vrste resnosti:

  • Bloker: Nadaljnjih del testiranja ni mogoče opraviti.
  • Kritično: Zrušitev aplikacije, izguba podatkov.
  • Major: Večja izguba funkcije.
  • Minor: Manjša izguba funkcije.
  • Trivialno: Nekaj ​​izboljšav uporabniškega vmesnika.
  • Izboljšava: Zahtevajte novo funkcijo ali nekaj izboljšav obstoječe.

Stanje: Ko hrošča prijavite v kateri koli sistem za sledenje napakam, bo privzeto stanje napake »Novo«.
Kasneje gre napaka skozi različne faze, kot so Fixed, Verified, Reopen, Won’t Fix itd.

=> Klikni tukaj če želite prebrati več o podrobnem življenjskem ciklu Bug.

Dodeli: Če veste, kateri razvijalec je odgovoren za določen modul, v katerem je prišlo do napake, lahko določite njegov e-poštni naslov. V nasprotnem primeru naj bo prazno, saj bo to napako dodelilo lastniku modula, v nasprotnem primeru bo skrbnik napako dodelil razvijalcu. Na seznam CC lahko dodate upraviteljev e-poštni naslov.

URL: URL strani, na kateri je prišlo do napake.

Povzetek: Kratek povzetek napake, večinoma v 60 besedah ​​ali manj. Prepričajte se, da povzetek odraža, v čem je težava in kje je.

Opis: Podroben opis napake.

Za opisno polje uporabite naslednja polja:

  • Koraki ponovitve: Jasno je, da omenite korake za reprodukcijo napake.
  • Pričakovani rezultati: Kako naj se aplikacija obnaša v zgoraj omenjenih korakih.
  • Dejanski rezultat: Kakšen je dejanski rezultat izvajanja zgornjih korakov, tj. Vedenje napak.

To so pomembni koraki v poročilu o napakah. Dodate lahko tudi »Vrsta poročila« kot še eno polje, ki opisuje vrsto napake.

Vrste poročil vključujejo:

1) Napaka pri kodiranju
2) Napaka pri načrtovanju
3) Nov predlog
4) Izdaja dokumentacije
5) Težava s strojno opremo

Pomembne lastnosti v poročilu o napakah

Spodaj so pomembne značilnosti poročila o napakah:

# 1) Številka napake / id

Številka napake ali identifikacijska številka (na primer swb001) olajša poročanje o napakah in sklicevanje na napako. Razvijalec lahko enostavno preveri, ali je bila določena napaka odpravljena ali ne. Omogoča lažji in lažji celoten postopek testiranja in ponovnega testiranja.

# 2) Naslov napake

Naslov napake se bere pogosteje kot kateri koli drug del poročila o napaki. Vse bi moralo povedati o tem, kaj prihaja v hrošču.

Naslov napake mora biti dovolj sugestiven, da ga lahko bralec razume. Jasen naslov napake omogoča enostavno razumevanje in bralec lahko ve, ali je bila napaka že prijavljena ali je bila odpravljena.

# 3) Prednost

Glede na resnost napake lahko zanjo določimo prioriteto. Napaka je lahko blokator, kritičen, glavni, manjši, nepomemben ali predlog. Prednost napake od P1 do P5 je lahko dana tako, da so najprej pomembne.

# 4) Platforma / Okolje

Za jasno poročilo o napakah je potrebna konfiguracija operacijskega sistema in brskalnika. To je najboljši način za sporočanje, kako je napako mogoče reproducirati.

Brez natančne platforme ali okolja se aplikacija lahko obnaša drugače in napaka na koncu preizkuševalca se ne more ponoviti na koncu razvijalca. Zato je najbolje, da jasno omenimo okolje, v katerem je bila napaka odkrita.

# 5) Opis

Opis napake razvijalcu pomaga razumeti napako. Opisuje nastalo težavo. Slab opis bo ustvaril zmedo in zapravil čas razvijalcev in preizkuševalcev.

Jasno je treba sporočiti učinek opisa. Vedno je koristno uporabiti celotne stavke. Dobra praksa je, da vsak problem opišemo ločeno, namesto da bi ga popolnoma sesuli. Ne uporabljajte izrazov, kot sta »mislim« ali »verjamem«.

# 6) Koraki za reprodukcijo

Dobro poročilo o napakah mora jasno navajati korake za reprodukcijo. Koraki morajo vključevati dejanja, ki povzročajo napako. Ne dajajte splošnih izjav. V naslednjih korakih bodite natančni.

Dober primer dobro napisanega postopka je naveden spodaj

Koraki:

  • Izberite izdelek Abc01.
  • Kliknite Dodaj v košarico.
  • Kliknite Odstrani, če želite izdelek odstraniti iz košarice.

# 7) Pričakovani in dejanski rezultat

Opis napake je nepopoln brez pričakovanih in dejanskih rezultatov. Treba je opisati, kakšen je rezultat testa in kaj naj uporabnik pričakuje. Bralec bi moral vedeti, kakšen je pravilen rezultat testa. Jasno omenite, kaj se je zgodilo med testom in kakšen je bil rezultat.

# 8) Posnetek zaslona

Slika je vredna tisoč besed. Posnemite posnetek zaslona primera okvare z ustreznimi napisi, da poudarite napako. Nepričakovana sporočila o napakah označite s svetlo rdečo barvo. To opozarja na zahtevano območje.

Nekaj ​​bonus nasvetov za pisanje dobrega poročila o napakah

Spodaj je nekaj dodatnih nasvetov za pisanje dobrega poročila o napakah:

# 1) Takoj prijavite težavo

kako nastaviti junit v mrk

Če med preskušanjem najdete kakršno koli napako, vam ni treba čakati, da kasneje napišete podrobno poročilo o napaki. Namesto tega takoj napišite poročilo o napaki. To bo zagotovilo dobro in ponovljivo poročilo o napakah. Če se kasneje odločite za poročilo o napakah, obstaja velika verjetnost, da boste zamudili pomembne korake v poročilu.

# 2) Pred pisanjem poročila o napaki trikrat ponovite napako

Vaša napaka mora biti ponovljiva. Prepričajte se, da so vaši koraki dovolj robustni, da lahko napako reproducirajo brez dvoumnosti. Če vaše napake ni mogoče ponoviti vsakič, lahko še vedno vložite napako, ki omenja periodično naravo napake.

# 3) Preizkusite isto pojavljanje napak na drugih podobnih modulih

Včasih razvijalec uporablja isto kodo za različne podobne module. Torej obstajajo večje možnosti, da se napaka v enem modulu pojavi tudi v drugih podobnih modulih. Lahko celo poskusite najti hujšo različico napake, ki ste jo našli.

# 4) Napišite dober povzetek napak

Povzetek napak bo razvijalcem pomagal pri hitri analizi narave napak. Poročilo o slabi kakovosti bo po nepotrebnem povečalo čas za razvoj in testiranje. Dobro komunicirajte s povzetkom poročila o napakah. Upoštevajte, da se povzetek napake uporablja kot referenca za iskanje napake v inventarju napak.

# 5) Preberite poročilo o napaki, preden pritisnete gumb Pošlji

Preberite vse stavke, besedila in korake, ki so uporabljeni v poročilu o napakah. Preverite, ali kateri stavek ustvarja dvoumnost, ki lahko vodi do napačne razlage. Da bi imeli jasno poročilo o napaki, se je treba izogibati zavajajočim besedam ali stavkom.

# 6) Ne uporabljajte žaljivega jezika

Lepo je, da ste dobro opravili in našli napako, vendar te zasluge ne uporabljate za kritiziranje razvijalca ali za napad na posameznika.

Zaključek

Brez dvoma bi moralo biti vaše poročilo o napakah visokokakovosten dokument.

Osredotočite se na pisanje dobrih poročil o napakah in porabite nekaj časa za to nalogo, ker je to glavna točka komunikacije med preizkuševalcem, razvijalcem in upraviteljem. Vodje bi se morali zavedati svoje ekipe, da je pisanje dobrega poročila o napakah glavna odgovornost vsakega preizkuševalca.

Vaš trud za pisanje dobrega poročila o napakah ne bo samo prihranil virov podjetja, ampak bo ustvaril tudi dobre odnose med vami in razvijalci.

Za boljšo produktivnost napišite boljše poročilo o napakah.

Ali ste strokovnjak za pisanje poročila o napakah? Svoje misli lahko delite v spodnjem oddelku za komentarje.

Priporočeno branje

^