Menu

Jak napsat dobrou zprávu o chybě? Tipy a triky

how write good bug report

Vyzkoušejte Náš Nástroj Pro Odstranění Problémů

Proč dobré hlášení o chybě?

Pokud je vaše hlášení o chybě účinné, pak je jeho šance na opravu vyšší. Oprava chyby tedy závisí na tom, jak efektivně ji nahlásíte. Nahlášení chyby není nic jiného než dovednost a já vám vysvětlím, jak této dovednosti dosáhnout.

„Smyslem psaní zprávy o problému (hlášení o chybě) je opravit chyby“ - Cem Kaner. Pokud tester nehlásí chybu správně, programátor tuto chybu s největší pravděpodobností odmítne a uvede ji jako nereprodukovatelnou.

Jak napsat dobrou zprávu o chybě

To může testerům ublížit morálně a někdy i egu. (Navrhuji neuchovávat žádný typ ega. Ego je jako „Nahlásil jsem chybu správně“, „Mohu ji reprodukovat“, „Proč chybu odmítl?“, „Není to moje chyba“ atd.) ,).

Co se naučíte:

Jaké jsou kvality dobrého hlášení o chybě softwaru?

Kdokoli může napsat zprávu o chybě. Ale ne každý může napsat efektivní zprávu o chybě.

Měli byste být schopni rozlišit mezi průměrným hlášením chyby a dobrým hlášením chyby. Jak rozlišovat mezi dobrým a špatným hlášením o chybě? Je to velmi jednoduché, nahlásit chybu pomocí následujících charakteristik a technik.

Mezi vlastnosti a techniky patří

# 1) Mít jasně určené číslo chyby: Každému hlášení o chybě vždy přiřaďte jedinečné číslo. To vám zase pomůže identifikovat záznam chyby. Pokud používáte jakýkoli automatizovaný nástroj pro hlášení chyb, bude toto jedinečné číslo vygenerováno automaticky pokaždé, když nahlásíte chybu.

Poznamenejte si číslo a stručný popis každé chyby, kterou jste nahlásili.

# 2) Reprodukovatelné: Pokud vaše chyba není reprodukovatelná, nebude nikdy opravena.

Měli byste jasně zmínit kroky k reprodukci chyby. Nepředpokládejte ani nepřeskočte žádný krok reprodukce. Chyba, která je popsána krok za krokem, se snadno reprodukuje a opravuje.

# 3) Buďte konkrétní: Nepište esej o problému.

Buďte konkrétní a k věci. Pokuste se problém shrnout do minimálních slov, přesto efektivním způsobem. Nekombinujte více problémů, i když se zdají být podobné. Pro každý problém napište různé zprávy.

Efektivní hlášení chyb

Hlášení chyb je důležitým aspektem testování softwaru. Efektivní hlášení o chybě dobře komunikuje s vývojovým týmem a nedochází k nejasnostem nebo nedorozumění.

Dobrá zpráva o chybě by měla být jasné a stručné bez chybějících klíčových bodů. Jakákoli nejasnost vede k nedorozumění a zpomaluje také vývojový proces. Zápis a hlášení vad je jednou z nejdůležitějších, ale opomíjených oblastí v životním cyklu testování.

Dobré psaní je velmi důležité pro nahlášení chyby. Nejdůležitějším bodem, na který by měl tester pamatovat, je nepoužívat rozkazovací tón ve zprávě. To narušuje morálku a vytváří nezdravý pracovní vztah. Použijte sugestivní tón.

Nepředpokládejte že vývojář udělal chybu, a proto můžete používat ostrá slova. Před nahlášením je stejně důležité zkontrolovat, zda byla nahlášena stejná chyba nebo ne.

Duplicitní chyba je zátěží v testovacím cyklu. Podívejte se na celý seznam známých chyb. Někdy vývojáři mohli problém znát a pro budoucí vydání jej ignorovat. Lze také použít nástroje jako Bugzilla, která automaticky vyhledává duplicitní chyby. Nejlepší je však ručně vyhledat jakoukoli duplicitní chybu.

Informace o importu, které musí hlášení o chybě sdělit, jsou 'Jak?' a kde?' Zpráva by měla jasně odpovědět na to, jak byla zkouška provedena a kde přesně došlo k závadě. Čtečka by měla chybu snadno reprodukovat a zjistit, kde se chyba nachází.

Mějte na paměti, že cíl psaní zprávy o chybě je umožnit vývojáři vizualizovat problém. Měl by jasně pochopit vadu ze zprávy o chybě. Nezapomeňte uvést všechny relevantní informace, které vývojář hledá.

Mějte také na paměti, že zpráva o chybě bude zachována pro budoucí použití a měla by být dobře napsána s požadovanými informacemi. Používejte smysluplné věty a jednoduchá slova popsat své chyby. Nepoužívejte matoucí výroky, které promarňují čas recenzenta.

Nahlaste každou chybu jako samostatný problém. V případě více problémů v jednom hlášení o chybě jej nemůžete zavřít, dokud nebudou všechny problémy vyřešeny.

Proto je nejlepší rozdělit problémy na samostatné chyby . Tím je zajištěno, že každou chybu lze zpracovat samostatně. Dobře napsaná zpráva o chybě pomáhá vývojáři reprodukovat chybu na svém terminálu. To jim také pomáhá diagnostikovat problém.

Jak nahlásit chybu?

Použijte následující jednoduchou šablonu hlášení chyb:

Toto je jednoduchý formát hlášení chyby. Může se lišit v závislosti na nástroji pro hlášení chyb, který používáte. Pokud píšete hlášení o chybě ručně, je třeba určit některá pole, například číslo chyby, které by mělo být přiděleno ručně.

Zpravodaj: Vaše jméno a e-mailová adresa.

Produkt: Ve kterém produktu jste tuto chybu našli.

Verze: Verze produktu, pokud existuje.

Komponent: Toto jsou hlavní dílčí moduly produktu.

Plošina: Uveďte hardwarovou platformu, kde jste tuto chybu našli. Různé platformy jako „PC“, „MAC“, „HP“, „Sun“ atd.

Operační systém: Uveďte všechny operační systémy, kde jste chybu našli. Operační systémy jako Windows, Linux, Unix, SunOS, Mac OS. Uveďte různé verze OS, jako je Windows NT, Windows 2000, Windows XP atd., Pokud existují.

Přednost: Kdy by měla být chyba opravena? Priorita se obecně nastavuje od P1 do P5. P1 jako „opravte chybu s nejvyšší prioritou“ a P5 jako „Opravte, když to čas dovolí“.

Vážnost: To popisuje dopad chyby.
Druhy závažnosti:

  • Blokátor: Nelze provádět žádné další testovací práce.
  • Kritické: Selhání aplikace, ztráta dat.
  • Hlavní, důležitý: Velká ztráta funkce.
  • Méně důležitý: Drobná ztráta funkce.
  • Triviální: Některá vylepšení uživatelského rozhraní.
  • Zvýšení: Žádost o novou funkci nebo nějaké vylepšení stávající.

Postavení: Když přihlašujete chybu do libovolného systému pro sledování chyb, bude ve výchozím nastavení stav chyby „Nový“.
Později chyba prochází různými fázemi, jako je opraveno, ověřeno, znovu otevřeno, nebude opraveno atd.

=> Klikněte zde číst více o podrobném životním cyklu chyb.

Přiřadit: Pokud víte, který vývojář je zodpovědný za konkrétní modul, ve kterém k chybě došlo, můžete zadat e-mailovou adresu tohoto vývojáře. Jinak ponechte toto pole prázdné, protože tím se chyba přiřadí vlastníkovi modulu, pokud ne, správce ji přidělí vývojáři. Možná přidejte e-mailovou adresu manažera do seznamu CC.

URL: URL stránky, na které došlo k chybě.

Souhrn: Stručné shrnutí chyby většinou do 60 slov nebo níže. Ujistěte se, že váš souhrn odráží to, v čem je problém a kde se nachází.

Popis: Podrobný popis chyby.

Pro pole popisu použijte následující pole:

  • Reprodukovat kroky: Jasně uveďte kroky k reprodukci chyby.
  • Očekávaný výsledek: Jak by se aplikace měla chovat ve výše uvedených krocích.
  • Skutečný výsledek: Jaký je skutečný výsledek spuštění výše uvedených kroků, tj. Chování chyby.

Toto jsou důležité kroky ve zprávě o chybě. Můžete také přidat „Typ zprávy“ jako další pole, které bude popisovat typ chyby.

Typy přehledů zahrnují:

1) Chyba kódování
2) Chyba designu
3) Nový návrh
4) Problém s dokumentací
5) Hardwarový problém

Důležité funkce ve vašem hlášení o chybě

Níže jsou uvedeny důležité funkce ve zprávě o chybě:

# 1) Číslo chyby / ID

Číslo chyby nebo identifikační číslo (například swb001) značně usnadňuje hlášení chyb a odkazování na chybu. Vývojář může snadno zkontrolovat, zda byla opravena konkrétní chyba. Celý testovací a testovací proces je tak plynulejší a jednodušší.

# 2) Název chyby

Název chyby se čte častěji než kterákoli jiná část zprávy o chybě. Mělo by se říci vše o tom, co je součástí chyby.

Název Bug by měl být dostatečně sugestivní, aby mu čtenář porozuměl. Jasný název chyby usnadňuje pochopení a čtenář může vědět, zda byla chyba nahlášena dříve nebo byla opravena.

# 3) Priorita

Na základě závažnosti chyby lze pro ni nastavit prioritu. Chyba může být blokátor, kritický, hlavní, menší, triviální nebo návrh. Prioritu chyby od P1 do P5 lze nastavit tak, aby se nejprve zobrazily ty důležité.

jak otevřít soubory .bin ve Windows 10

# 4) Platforma / prostředí

Konfigurace OS a prohlížeče je nezbytná pro jasné hlášení chyb. Je to nejlepší způsob, jak sdělit, jak lze chybu reprodukovat.

Bez přesné platformy nebo prostředí se aplikace může chovat odlišně a chyba na konci testeru se nemusí replikovat na konci vývojáře. Nejlepší je tedy jasně uvést prostředí, ve kterém byla chyba detekována.

# 5) Popis

Popis chyby pomáhá vývojáři pochopit chybu. Popisuje narazený problém. Špatný popis způsobí zmatek a také ztrácí čas vývojářům a testerům.

O účinku popisu je nutné jasně komunikovat. Vždy je užitečné používat úplné věty. Je dobrým zvykem popisovat každý problém zvlášť, místo toho, abyste jej úplně rozpadali. Nepoužívejte výrazy jako „Myslím“ nebo „Věřím“.

# 6) Kroky k reprodukci

Dobrá zpráva o chybě by měla jasně uvádět kroky k reprodukci. Kroky by měly zahrnovat akce, které způsobují chybu. Nedělejte obecná prohlášení. Buďte konkrétní v následujících krocích.

Dobrý příklad dobře napsaného postupu je uveden níže

Kroky:

  • Vyberte produkt Abc01.
  • Klikněte na Přidat do košíku.
  • Kliknutím na Odebrat odeberete produkt z košíku.

# 7) Očekávaný a skutečný výsledek

Popis chyby je neúplný bez očekávaných a skutečných výsledků. Je nutné nastínit, jaký je výsledek testu a co by měl uživatel očekávat. Čtenář by měl vědět, jaký je správný výsledek testu. Jasně uveďte, co se stalo během testu a jaký byl výsledek.

# 8) Screenshot

Obrázek má hodnotu tisíce slov. Proveďte snímek obrazovky případu selhání se správnými titulky, abyste zvýraznili vadu. Zvýrazněte neočekávané chybové zprávy světle červenou barvou. To upozorňuje na požadovanou oblast.

Několik bonusových tipů k napsání dobrého hlášení o chybě

Níže uvádíme několik dalších tipů, jak napsat dobrou zprávu o chybě:

# 1) Okamžitě nahlaste problém

Pokud při testování narazíte na nějakou chybu, nemusíte čekat, až později napíšete podrobnou zprávu o chybě. Místo toho ihned napište hlášení o chybě. Tím zajistíte dobrou a reprodukovatelnou zprávu o chybě. Pokud se rozhodnete zprávu o chybě napsat později, existuje velká šance, že ve svém hlášení nezmeškáte důležité kroky.

# 2) Před napsáním zprávy o chybě reprodukujte chybu třikrát

Vaše chyba by měla být reprodukovatelná. Ujistěte se, že jsou vaše kroky dostatečně robustní, aby chybu reprodukovaly bez nejasností. Pokud vaše chyba není reprodukovatelná pokaždé, můžete stále nahlásit chybu s uvedením periodické povahy chyby.

# 3) Otestujte výskyt stejné chyby na jiných podobných modulech

Někdy vývojář používá stejný kód pro různé podobné moduly. Existuje tedy větší šance, že se chyba v jednom modulu vyskytne i v dalších podobných modulech. Můžete se dokonce pokusit najít závažnější verzi nalezené chyby.

# 4) Napište dobrý souhrn chyb

Souhrn chyb pomůže vývojářům rychle analyzovat povahu chyby. Zpráva o nízké kvalitě zbytečně prodlouží dobu vývoje a testování. Dobře komunikujte se souhrnem hlášení o chybě. Mějte na paměti, že souhrn chyb se používá jako reference k hledání chyby v inventáři chyb.

# 5) Než stisknete tlačítko Odeslat, přečtěte si zprávu o chybě

Přečtěte si všechny věty, formulace a kroky použité v hlášení o chybě. Zjistěte, zda některá věta nevytváří dvojznačnost, která by mohla vést k nesprávné interpretaci. Abyste měli jasnou zprávu o chybě, měli byste se vyhnout zavádějícím slovům nebo větám.

# 6) Nepoužívejte hrubý jazyk

Je hezké, že jste odvedli dobrou práci a našli chybu, ale nepoužívejte tuto zásluhu ke kritice vývojáře nebo k útoku na jednotlivce.

Závěr

Není pochyb o tom, že vaše hlášení o chybě by mělo být vysoce kvalitním dokumentem.

Zaměřte se na psaní dobrých hlášení o chybách a věnujte tomuto úkolu nějaký čas, protože toto je hlavní komunikační bod mezi testerem, vývojářem a manažerem. Manažeři by měli vytvořit povědomí svého týmu o tom, že psaní dobrého hlášení o chybě je primární odpovědností každého testera.

Vaše úsilí o vypracování dobrého hlášení o chybě nejen ušetří zdroje společnosti, ale také vytvoří dobrý vztah mezi vámi a vývojáři.

Pro lepší produktivitu napište lepší zprávu o chybě.

Jste odborníkem na psaní zprávy o chybě? Neváhejte se podělit o své myšlenky v sekci komentáře níže.

Doporučené čtení

^