Jak napsat zprávu o chybě s příklady

Co je hlášení o chybě? Proč potřebujete dobré hlášení o chybě?

Zpráva o chybě je důležitý dokument v STLC, který nabízí různé výhody testovacímu týmu. Sleduje všechny závady, vícenásobné chyby, chyby a další nesrovnalosti zjištěné během testování softwaru a hlásí je.

Účelem této dokumentace po testování je poskytnout příslušnému týmu profesionálů informace o úrovni chyb zjištěných během procesu testování.

váš inženýr vývoje softwaru lze pomocí tohoto typu zprávy upozornit na všechny závady a problémy přítomné v softwaru. Umožňuje vám také zjistit, co je s chybou špatně, takže můžete použít nejlepší metodu k její opravě. Pomáhá vám také ušetřit čas a peníze tím, že vám pomůže zachytit chyby a problémy.

Proč byste se měli starat o dobré vysvětlení chyb?

Zde je bod, který musíte vzít v úvahu při psaní dobré a podrobné zprávy o chybě softwaru:

• Funguje jako průvodce, který vám pomůže vyhnout se stejné chybě v budoucích verzích.
• Ušetřete čas na komunikaci (e-maily, hovory).
• Less pracovat pro vývojáře (udělají přesně to, co chcete).
• Budete mít méně úzkých míst v projektu; chyby budou opraveny rychleji a efektivněji.

Jak napsat hlášení o chybě (šablona hlášení o chybě)

Neexistuje žádná přesná šablona hlášení chyb, protože to závisí na vašem systému sledování chyb. Vaše šablona se může lišit.

Následující běžná pole jsou však vždy potřeba, když chcete napsat hlášení o chybě:

• ID chyby/název.
• Závažnost a priorita.
• Description
• životní prostředí
• Kroky k reprodukci.
• Očekávaný výsledek.
• Skutečný výsledek.
• Přílohy (snímky obrazovky, videa, text)

Podívejme se na všechny tyto komponenty pro odstraňování chyb jeden po druhém:

1) Název/ID chyby:

Každá chyba by měla mít jedinečné identifikační číslo. Nástroje pro hlášení chyb by měly být jedinečná čísla pro nově zjištěné chyby, abychom mohli chybu snadno identifikovat.

Příklady:

❌ Špatné: „Nevidím produkt, když ho znovu klepnu, ne.“

• Vágní
• Útočný
• Příliš rozvláčný

žádá o implementaci řešení.

✅ Dobré: „KOŠÍK – Nové položky přidané do košíku, které se nezobrazují“.

• Tento druh titulu okamžitě lokalizuje problém (KOŠÍK)
• Zaměřuje se na skutečný technický problém.

2) Závažnost chyby:

Závažnost chyby je velmi důležitým faktorem v hlášení o chybě. Popisuje vliv vady na výkon aplikace.

• Blokátory: Tato chyba způsobí selhání aplikace.
• Major: Kritická chyba označuje zásadní změnu v obchodní logice.
• Moll: Problém, který neovlivňuje funkčnost aplikace, ale ovlivňuje očekávané výsledky.
• Triviální: Nemá vliv na funkčnost ani provoz aplikace. Může se jednat o typografickou chybu.

3) Priorita chyby:

Následuje obecná gradace pro určení priority chyby:

• Vysoká: Zahrnuje vše, co ovlivňuje tok nebo blokuje použití aplikace.
• médium: To nepříznivě ovlivňuje uživatelský zážitek.
• Moll: Všechny ostatní chyby jako (překlepy, chybějící ikony, problémy s rozložením atd.).

4) Prostředí:

Chyba se může objevit ve specifickém prostředí a ne v jiných. Někdy se například při spuštění webu objeví chyba Firefoxnebo porucha aplikace pouze při spuštění na Android zařízení a funguje dobře na iPhone.

Tyto zprávy o chybách lze identifikovat pouze pomocí testování napříč prohlížeči nebo zařízeními. Takže při hlášení chyby by QA měli být schopni určit, zda by měla být chyba pozorována v jednom nebo více konkrétních prostředích.

5) Shrnutí:

Přidání pouze názvu do zprávy o chybě však nesplňuje účel. Pokud vám tedy váš název nestačí, můžete přidat krátké shrnutí zprávy.

Vaše shrnutí v co nejmenším počtu slov včetně toho, kdy a jak k chybě došlo. Váš název a popis chyby by měly být také použity při vyhledávání, takže se musíte ujistit, že máte pokrytá důležitá klíčová slova.

Příklady:

• špatný: "Snažil jsem se přidat věci do testu a nic se neukázalo, když jsem to udělal nebo kliknul na tlačítko."
• Dobrý: „Když jsem se pokusil přidat [PRODUKT] do nákupního košíku, ale po kliknutí na tlačítko „přidat“ na konkrétní webové stránce s přehledem produktu se nic nestalo.“

6) Kroky pro reprodukci:

Při hlášení chyby je důležité specifikovat kroky k její reprodukci. Měli byste také zahrnout akce, které mohou chybu způsobit. Zde nedělejte žádná obecná prohlášení.

Uveďte konkrétní kroky, které je třeba dodržet:

Zde je příklad dobře napsaného postupu:

Kroky:

1. Vyberte produkt X1.
2. Klikněte na Přidat do košíku.
3. Kliknutím na Odebrat odeberete produkt z košíku.

7) Očekávaný výsledek:

V hlášeních o chybách je důležitý popis očekávaného výsledku podle technického úkolu, návrhu výsledků testovacího případu nebo podle názoru testera. To vše pomáhá vývojářům soustředit se na rychlé vyhledání potřebných informací.

Například:

Povinná pole by měla být zvýrazněna červeně po kliknutí na tlačítko „Odeslat“.

8) Skutečný výsledek:

Jak název napovídá, toto pole popisuje skutečný účinek chyby. Je velmi důležité napsat jasný popis skutečného výsledku.

Například:

Povinná pole jsou po kliknutí na tlačítko „Odeslat“ zvýrazněna zelenou barvou.

9) Přílohy (snímky obrazovky a videa):

V hlášeních o chybách je osvědčeným postupem připojovat soubory k hlášením o chybách, což usnadňuje vnímání informací, když je potřebujete zobrazit vizuálně:

Například:

• Screenshot: Snímky obrazovky mohou snadno rozvést chyby v programu; je vhodné, když je chyba zvýrazněna konkrétní anotací, kruhem nebo obrázkem šipky).
• Video: Někdy je obtížné popsat chybu slovy, takže je lepší vytvořit video, aby vývojář mohl chybu v programu opravit).

10) Dotčená verze:

Chyba je hlášena ve verzi ovlivněného softwaru.

11) Opravená verze:

Je to verze softwaru, ve které je chyba vyřešena. Takže když QA, který nahlásil chybu, zkontroluje, zda je opravena, použije správnou verzi softwaru.

12) Target verze:

Cílová verze, ve které by měla být zacílena chyba, která má být opravena. Když tedy vývojový tým pracuje na opravě chyby, většinou se zaměřuje na konkrétní verzi aplikace.

13) Datum uzavření:

Je to datum, kdy je chyba uzavřena týmem pro testování softwaru. Odstranění chyby je zásadní a nedílnou součástí testování softwaru.

14) Stav:

Když je vytvořena nová chyba, její stav by měl být otevřený. Poté prochází fázemi jako In Progress, Fixed, Running, Reopen atd.

Tipy pro psaní chybových hlášení

Zde je několik důležitých tipů, které byste měli mít na paměti při psaní efektivní zprávy o chybě:

• Při vytváření zpráv o chybách buďte konkrétní. Ujistěte se, že neuvádíte žádná zbytečná nebo irelevantní fakta.
• Chybu musíte nahlásit okamžitě, jakmile bude zjištěna.
• Připravte zprávu podrobně, abyste umožnili vývojáři použít fakta a informace k odladění problému.
• Pro ověření byste měli otestovat stejný výskyt chyby na jiných podobných modulech.
• Revpřed odesláním si hlášení o chybě alespoň jednou prohlédněte.
• Měli byste se ujistit, že hlášení o chybě obsahuje popis pouze jedné chyby.
• A konečně, neměli byste se bát požádat o pomoc projektového manažera, pokud vám není něco jasné.

Nástroje pro hlášení chyb

Proces hlášení chyb, prováděný ručně, se nyní provádí pomocí různých nástrojů pro hlášení chyb dostupných na trhu.

• PROHLÍDKA
• Zoho Bug Tracker
• Bugzilla

Můžete se podívat na naši podrobnou recenzi nejlepší nástroj pro hlášení chyb.

Běžný problém a řešení při psaní hlášení o chybě:

Zde jsou některé běžné problémy a jejich řešení při psaní hlášení o chybě:

Příklad hlášení chyby	Problém
Při vynásobení 2 x 3 bude odpověď kladná.	Uveďte vzor, ​​nikoli příklad.
Aby se tomu zabránilo, seznam bude při přidávání nové položky seřazen abecedně.	Nepopisujte jen to, co je špatně
Například: Chcete-li být, budete muset otevřít prohlížeč a zadat adresu URL webu. První pole, 'uživatelské jméno', najdete špatně.	Vždy směřujte k věci (Nikdy nevyprávějte příběh!).
Jméno klienta v přehledu je špatně napsané. Priorita: vysoká, závažnost: vysoká	Nikdy nemíchejte prioritu a přísnost.
Vzorec pro výpočet daně je NESPRÁVNÝ !!??	Nepoužívá CAPS, červená písmena, červená kolečka, '!',
Nemyslím si, že domovská stránka Ul design je dobrá.	Nepoužívejte svůj úsudek.
Příklad nejasného popisu: O naší dnešní diskusi proveďte požadovanou akci pro tuto stránku.	Udělejte svůj popis srozumitelný pro každého.
Pozadí stránky by mělo být modré, oranžové nebo zelené, nebo jej můžete nastavit na černé nebo bílé. To není dobré, protože není jasné, co je potřeba od týmu pro vývoj a návrh webu	Minimalizujte možnosti
Vzorec pro výpočet daně někdy nefunguje podle očekávání.	Zlaté pravidlo: Nepoužívejte slovo 'Někdy'.

Příklad hlášení chyby

Zde je malý příklad hlášení o chybě:

[MŮJ ÚČET] Při najetí myší na tlačítko Aktualizovat se zobrazí podtržení.

Description: Musíme odstranit podtržení při přejetí myší na tlačítko Aktualizovat v sekci Můj účet.

Odkaz: http://test.com/mv-account/

Prohlížeč/OS: Chrome 25. OSX Yosemite 10.10.2

Kroky pro reprodukci:

1. Přejděte na www.test.com

2. Přihlaste se pomocí přihlašovacích údajů

3. Přejděte na Můj účet

4. Najeďte myší na tlačítko Aktualizovat

Skutečný výsledek: je tam podtržení.

Očekávaný výsledek: žádné podtržení.

Přihlašovací údaje: test@test.com / mysecretpass12

Je třeba se vyvarovat chyb při psaní hlášení o chybě

Zde je několik důležitých chyb, kterých byste se měli vyvarovat při psaní hlášení o chybě:

• Nepište o své nespokojenosti a nikdy neuvádějte své osobní pocity.
• Obtěžuje lidi, kteří se chtějí soustředit na úkol, když svůj příspěvek přetížíte mnoha emotikony.
• Nikdy nepřetěžujte svůj příspěvek vykřičníky; práci to neurychlí.
• Nikdo se nechce cítit uražen. Ničí motivaci a zpomaluje realizaci problému.