how write good bug report
Prečo dobré hlásenie chyby?
Ak je vaše hlásenie o chybe účinné, jeho šance na opravu sú väčšie. Oprava chyby teda závisí od toho, ako efektívne ju nahlásite. Nahlásenie chyby nie je nič iné ako zručnosť a ja vám vysvetlím, ako túto zručnosť dosiahnuť.
„Cieľom správy o chybe (správy o chybe) je opraviť chyby.“ - Autor: Cem Kaner. Ak tester nenahlási chybu správne, programátor túto chybu s najväčšou pravdepodobnosťou odmietne a uvedie ju ako nereprodukovateľnú.
To môže testerom ublížiť morálne a niekedy aj ego. (Navrhujem, aby ste si nenechali žiadny typ ega. Ego je ako „Správne som nahlásil chybu“, „Môžem ju reprodukovať“, „Prečo chybu odmietol?“, „Nie je to moja chyba“ atď.) ,).
Čo sa dozviete:
- Aké sú kvality dobrého hlásenia o chybe softvéru?
- Efektívne hlásenie chýb
- Ako nahlásiť chybu?
- Dôležité funkcie vo vašom hlásení o chybe
- Niekoľko bonusových tipov na napísanie dobrého hlásenia o chybe
- Záver
- Odporúčané čítanie
Aké sú kvality dobrého hlásenia o chybe softvéru?
Ktokoľvek môže napísať správu o chybe. Ale nie každý môže napísať efektívnu správu o chybe.
Mali by ste byť schopní rozlišovať medzi priemerným hlásením chyby a dobrým hlásením chyby. Ako rozlišovať medzi dobrým a zlým hlásením chyby? Je to veľmi jednoduché, na nahlásenie chyby použite nasledujúce charakteristiky a techniky.
Medzi vlastnosti a techniky patrí
# 1) Mať jasne určené číslo chyby: Každému hláseniu chyby vždy priraďte jedinečné číslo. To vám zase pomôže identifikovať záznam chyby. Ak používate akýkoľvek automatizovaný nástroj na hlásenie chýb, toto jedinečné číslo sa vygeneruje automaticky pri každom hlásení chyby.
Poznačte si počet a stručný popis každej chyby, ktorú ste nahlásili.
# 2) Reprodukovateľné: Ak vaša chyba nie je reprodukovateľná, nikdy sa neopraví.
Mali by ste jasne spomenúť kroky na reprodukciu chyby. Nepredpokladajte ani nepreskočte žiadny krok reprodukcie. Chyba, ktorá je popísaná krok za krokom, sa dá ľahko reprodukovať a opraviť.
# 3) Buďte konkrétni: Nepíšte esej o probléme.
Buďte konkrétni a k veci. Pokúste sa problém zhrnúť do minimálnych slov, ale efektívne. Nekombinujte viac problémov, aj keď sa zdajú byť podobné. Pre každý problém napíšte rôzne správy.
Efektívne hlásenie chýb
Hlásenie chýb je dôležitým aspektom testovania softvéru. Efektívna správa o chybe dobre komunikuje s vývojovým tímom a nedochádza k nejasnostiam alebo nesprávnej komunikácii.
Dobrá správa o chybe by mala byť jasné a výstižné bez akýchkoľvek chýbajúcich kľúčových bodov. Nejasnosti vedú k nedorozumeniam a spomaľujú tiež vývojový proces. Písanie chýb a hlásenie chýb je jednou z najdôležitejších, ale zanedbávaných oblastí v životnom cykle testovania.
Pre napísanie chyby je veľmi dôležité dobré písanie. Najdôležitejší bod, na ktorý by mal tester pamätať, je nepoužívať rozkazovací tón v správe. To naruší morálku a vytvorí nezdravý pracovný vzťah. Použite sugestívny tón.
Nepredpokladajte že vývojár urobil chybu, a preto môžete použiť tvrdé slová. Pred nahlásením je rovnako dôležité skontrolovať, či bola nahlásená rovnaká chyba alebo nie.
Duplicitná chyba je záťažou v testovacom cykle. Skontrolujte celý zoznam známych chýb. Vývojári niekedy mohli problém poznať a pre budúce vydanie ignorovať. Môžu sa tiež použiť nástroje ako Bugzilla, ktorá automaticky vyhľadáva duplicitné chyby. Najlepšie je však každú duplicitnú chybu vyhľadať manuálne.
pokojné webové služby, otázky a odpovede
Informácie o importe, ktoré musí hlásiť chyba, sú 'Ako?' a kde?' Správa by mala jasne odpovedať na to, ako sa test vykonal a kde sa presne vyskytla chyba. Čitateľ by mal chybu ľahko reprodukovať a zistiť, kde sa chyba nachádza.
Majte na pamäti, že cieľ napísania správy o chybe je umožniť vývojárovi vizualizovať problém. Mal by jasne rozumieť závade zo správy o chybe. Nezabudnite uviesť všetky príslušné informácie, ktoré vývojár hľadá.
Majte tiež na pamäti, že správa o chybe by sa zachovala pre budúce použitie a mala by byť dobre napísaná s požadovanými informáciami. Používajte zmysluplné vety a jednoduché slová opísať svoje chyby. Nepoužívajte mätúce výroky, ktoré strácajú čas recenzenta.
Každú chybu nahláste ako samostatný problém. V prípade viacerých problémov v jednom hlásení o chybe ho nemôžete zavrieť, pokiaľ nebudú vyriešené všetky problémy.
Preto je najlepšie rozdeliť problémy na samostatné chyby . To zaisťuje, že s každou chybou je možné zaobchádzať osobitne. Dobre napísaná správa o chybe pomáha vývojárovi reprodukovať chybu na svojom termináli. To im pomáha tiež diagnostikovať problém.
Ako nahlásiť chybu?
Použite nasledujúcu jednoduchú šablónu hlásenia chyby:
Toto je jednoduchý formát správy o chybe. Môže sa líšiť v závislosti od nástroja na hlásenie chýb, ktorý používate. Ak píšete hlásenie o chybe ručne, potom je potrebné spomenúť niektoré polia, konkrétne číslo chyby, ktoré by malo byť priradené ručne.
Reportér: Vaše meno a e-mailová adresa.
Produkt: V ktorom produkte ste našli túto chybu.
Verzia: Verzia produktu, ak existuje.
Zložka: Toto sú hlavné podmoduly produktu.
Plošina: Uveďte hardvérovú platformu, na ktorej ste našli túto chybu. Rôzne platformy ako „PC“, „MAC“, „HP“, „Sun“ atď.
Operačný systém: Uveďte všetky operačné systémy, v ktorých ste chybu našli. Operačné systémy ako Windows, Linux, Unix, SunOS, Mac OS. Uveďte rôzne verzie OS, ako napríklad Windows NT, Windows 2000, Windows XP atď., Ak existujú.
Priorita: Kedy by sa mala chyba opraviť? Priorita sa zvyčajne nastavuje od P1 do P5. P1 ako „opraviť chybu s najvyššou prioritou“ a P5 ako „opraviť, keď to čas dovolí“.
Závažnosť: Toto popisuje dopad chyby.
Typy závažnosti:
ako napísať regresné testovacie prípady
- Blokátor: Nie je možné vykonať žiadne ďalšie testovacie práce.
- Kritické: Zlyhanie aplikácie, strata dát.
- Major: Veľká strata funkcie.
- Menšie: Drobná strata funkcie.
- Triviálne: Niektoré vylepšenia používateľského rozhrania.
- Vylepšenie: Žiadosť o novú funkciu alebo vylepšenie existujúcej.
Postavenie: Keď prihlasujete chybu do ľubovoľného systému na sledovanie chýb, bude štandardne stav chyby „Nový“.
Neskôr chyba prejde rôznymi fázami, ako sú Opravené, Overené, Opätovné otvorenie, Neupravené atď.
=> Kliknite tu Ak sa chcete dozvedieť viac podrobného životného cyklu chyby, prečítajte si viac.
Priradiť: Ak viete, ktorý vývojár je zodpovedný za konkrétny modul, v ktorom sa vyskytla chyba, môžete určiť jeho e-mailovú adresu. Ak to neurobíte inak, bude to priradiť chybu vlastníkovi modulu, pokiaľ nie, Správca bude túto chybu priradiť vývojárovi. Prípadne pridajte e-mailovú adresu manažéra do zoznamu CC.
URL: Adresa URL stránky, na ktorej sa vyskytla chyba.
Zhrnutie: Stručné zhrnutie chyby, ktoré má väčšinou 60 slov alebo menej. Uistite sa, že súhrn odráža to, v čom je problém a kde sa nachádza.
Popis: Podrobný popis chyby.
Pre pole popisu použite nasledujúce polia:
- Reprodukcia krokov: Jednoznačne uveďte kroky na reprodukciu chyby.
- Ocakavane vysledky: Ako by sa aplikácia mala správať pri vyššie uvedených krokoch.
- Aktuálny výsledok: Aký je skutočný výsledok vykonania vyššie uvedených krokov, tj. Správanie chyby.
Toto sú dôležité kroky v hlásení o chybe. Môžete tiež pridať „Typ správy“ ako ďalšie pole, ktoré bude popisovať typ chyby.
Typy prehľadov:
1) Chyba kódovania
2) Chyba dizajnu
3) Nový návrh
4) Vydanie dokumentácie
5) Problém s hardvérom
Dôležité funkcie vo vašom hlásení o chybe
Ďalej sú uvedené dôležité funkcie v správe o chybách:
# 1) Číslo chyby / ID
Číslo chyby alebo identifikačné číslo (napríklad swb001) výrazne uľahčuje hlásenie chyby a odkaz na chybu. Vývojár môže ľahko skontrolovať, či bola opravená konkrétna chyba. Celý proces testovania a opätovného testovania je tak plynulejší a ľahší.
# 2) Názov chyby
Názov chyby sa číta častejšie ako ktorákoľvek iná časť správy o chybe. Malo by hovoriť o všetkom, čo chyba obsahuje.
Názov Bug by mal byť dostatočne sugestívny, aby mu čitateľ porozumel. Jasný názov chyby uľahčuje pochopenie a čitateľ môže vedieť, či bola chyba nahlásená skôr alebo bola opravená.
# 3) Priorita
Na základe závažnosti chyby je možné pre ňu nastaviť prioritu. Chyba môže byť blokujúca, kritická, veľká, menšia, malicherná alebo návrh. Môže sa dať priorita chyby od P1 do P5, aby sa najskôr zobrazili dôležité.
# 4) Platforma / prostredie
Pre prehľadné hlásenie chyby je nevyhnutná konfigurácia OS a prehľadávača. Je to najlepší spôsob, ako oznámiť, ako sa dá chyba reprodukovať.
Bez presnej platformy alebo prostredia sa aplikácia môže správať inak a chyba na konci testera sa nemusí replikovať na konci vývojára. Najlepšie je teda jednoznačne spomenúť prostredie, v ktorom bola chyba zistená.
# 5) Popis
Popis chyby pomáha vývojárovi pochopiť chybu. Opisuje problém, na ktorý narazil. Zlý popis spôsobí zmätok a stratí čas aj vývojárom a testerom.
O účinku opisu je potrebné jasne komunikovať. Vždy je užitočné používať celé vety. Osvedčeným postupom je opísať každý problém osobitne, namiesto toho, aby ste ich úplne rozpadali. Nepoužívajte výrazy ako „Myslím“ alebo „Verím“.
# 6) Kroky na reprodukciu
Dobrá správa o chybe by mala jasne obsahovať kroky na reprodukciu. Kroky by mali zahŕňať akcie, ktoré spôsobujú chybu. Nerobte všeobecné vyhlásenia. Buďte konkrétni v nasledujúcich krokoch.
Dobrý príklad dobre napísaného postupu je uvedený nižšie
Kroky:
- Vyberte produkt Abc01.
- Kliknite na Pridať do košíka.
- Kliknutím na Odstrániť odstráňte produkt z košíka.
# 7) Očakávané a skutočný výsledok
Popis chyby je neúplný bez očakávaných a skutočných výsledkov. Je potrebné načrtnúť, aký je výsledok testu a čo by mal užívateľ očakávať. Čitateľ by mal vedieť, aký je správny výsledok testu. Jednoznačne uveďte, čo sa stalo počas testu a aký bol jeho výsledok.
# 8) Screenshot
Obrázok má hodnotu tisíc slov. Na zvýraznenie defektu urobte snímku obrazovky s príkladom zlyhania so správnymi titulkami. Zvýraznite neočakávané chybové správy svetločervenou farbou. To upriamuje pozornosť na požadovanú oblasť.
Niekoľko bonusových tipov na napísanie dobrého hlásenia o chybe
Nižšie uvádzame niekoľko ďalších tipov, ako napísať dobrú správu o chybe:
# 1) Okamžite nahláste problém
Ak pri testovaní nájdete chybu, nemusíte čakať na neskoršie napísanie podrobnej správy o chybe. Namiesto toho okamžite napíšte správu o chybe. Zaistíte tak dobrú a reprodukovateľnú správu o chybe. Ak sa rozhodnete správu o chybe napísať neskôr, existuje veľká šanca, že zmeškáte dôležité kroky v správe.
# 2) Pred napísaním správy o chybe chybu trikrát zopakujte
Vaša chyba by mala byť reprodukovateľná. Zaistite, aby boli vaše kroky dostatočne robustné na to, aby chybu reprodukovali bez akýchkoľvek nejasností. Ak vaša chyba nie je reprodukovateľná zakaždým, stále môžete nahlásiť chybu s uvedením periodickej povahy chyby.
# 3) Vyskúšajte výskyt rovnakej chyby na iných podobných moduloch
Niekedy vývojár používa rovnaký kód pre rôzne podobné moduly. Existuje teda vyššia šanca, že sa chyba v jednom module vyskytne aj v ďalších podobných moduloch. Môžete sa dokonca pokúsiť nájsť závažnejšiu verziu chyby, ktorú ste našli.
# 4) Napíšte dobrý súhrn chýb
Súhrn chýb pomôže vývojárom rýchlo analyzovať povahu chyby. Nekvalitná správa zbytočne predĺži čas potrebný na vývoj a testovanie. Dobre komunikujte so súhrnom hlásenia chyby. Nezabudnite, že súhrn chýb sa používa ako referencia na hľadanie chyby v inventári chýb.
# 5) Pred stlačením tlačidla Odoslať si prečítajte správu o chybe
Prečítajte si všetky vety, formulácie a kroky, ktoré sa používajú v hlásení o chybe. Zistite, či niektorá veta nevytvára dvojznačnosť, ktorá môže viesť k nesprávnej interpretácii. Mali by ste sa vyhnúť zavádzajúcim slovám alebo vetám, aby ste mali jasnú správu o chybe.
c náhodné číslo medzi 0 a 1
# 6) Nepoužívajte hrubý jazyk
Je pekné, že ste odviedli dobrú prácu a našli chybu, ale túto zásluhu nepoužívajte na kritiku vývojára alebo na útok na ktorúkoľvek osobu.
Záver
Niet pochýb o tom, že vaše hlásenie o chybe by malo byť kvalitným dokumentom.
Zamerajte sa na písanie dobrých správ o chybách a venujte tejto úlohe nejaký čas, pretože toto je hlavný komunikačný bod medzi testerom, vývojárom a manažérom. Manažéri by mali vytvárať povedomie svojho tímu o tom, že vypracovanie dobrého protokolu o chybe je primárnou zodpovednosťou každého testera.
Vaše úsilie o vypracovanie dobrého záznamu o chybe nielen ušetrí zdroje spoločnosti, ale vytvorí aj dobrý vzťah medzi vami a vývojármi.
Pre lepšiu produktivitu napíšte lepšiu správu o chybe.
Ste odborníkom na písanie správy o chybe? Neváhajte a podeľte sa o svoje myšlienky v sekcii komentárov nižšie.
Odporúčané čítanie
- Ukážka hlásenia o chybe
- Ako nájsť chybu v aplikácii? Tipy a triky
- Ako písať týždenné správy o testovaní softvéru
- Čo je životný cyklus chyby / chyby v testovaní softvéru? Výukový program pre poruchu životného cyklu
- Ako dosiahnuť vyriešenie všetkých chýb bez štítku „Neplatná chyba“?
- Ukážka hlásenia chyby pre webové a produktové aplikácie
- Ako napísať efektívnu súhrnnú správu o teste (stiahnutie vzorovej správy)
- Prečo je hlásenie chyby umenie, ktoré by sa mal naučiť každý tester?