Testovací dokumentace v testování softwaru (příklad)

Co je testovací dokumentace?

Dokumentace testů je dokumentace artefaktů vytvořených před testováním softwaru nebo během něj. Pomáhá testovacímu týmu odhadnout požadované úsilí, sledovat zdroje a průběh a zajistit dostatečné pokrytí testy. Záznamy a zprávy o testu představují kompletní sadu dokumentů, které vám umožňují popsat a zdokumentovat plánování testů, návrh testů, provedení testů a výsledky testů, které jsou z testovací aktivity vyvozeny.

👉 Zaregistrujte se do projektu bezplatného živého testování softwaru

Proč je potřeba formálního testování?

Pro nováčka je snadné předpokládat, že testování je spočívá v ad-hoc provádění různých částí kódu a ověřování výsledků. V reálném světě je však testování velmi formální činností a je podrobně dokumentováno. Dokumentace testů usnadňuje a zároveň usnadňuje plánování, kontrolu a provádění testování.

Stupeň formality testu závisí na:

• Typ testované aplikace (AUT).
• Standardy dodržované vaší organizací.
• Vyspělost vývojového procesu.

Testovací aktivity obvykle zaberou mezi 30% a 50% celkového úsilí při vývoji softwaru. Dokumentace pomáhá identifikovat vylepšení testovacího procesu, která lze aplikovat v budoucích projektech.

Jaké jsou typy testovací dokumentace?

Zde jsou důležité typy testovací dokumentace:

„V praxi se tyto dokumenty vytvářejí v různých fázích – od raného plánování (zásady testování, strategie) až po provedení a uzavření (zprávy o závadách a souhrnné zprávy).“

Typy zkušebních dokumentů	Description
Zásady testování	Jedná se o dokument na vysoké úrovni, který popisuje principy, metody a všechny důležité cíle testování dané organizace.
Testovací strategie	Dokument na vysoké úrovni, který identifikuje úrovně (typy) testů, které mají být pro projekt provedeny.
Testovací plán	Testovací plán je kompletní plánovací dokument, který obsahuje rozsah, přístup, zdroje, harmonogram atd. testovacích aktivit.
Matice sledovatelnosti požadavků	Toto je dokument, který propojuje požadavky s testovacími případy.
Scénář testu	Scénář testu je položka nebo událost softwarového systému, kterou lze ověřit jedním nebo více testovacími případy.
Testovací případ	Jedná se o skupinu vstupních hodnot, předpokladů provedení, očekávaných následných podmínek provedení a výsledků. Je vyvinuta pro testovací scénář.
Testovací data	Testovací data jsou data, která existují před provedením testu. Používají se k provedení testovacího případu.
Hlášení závady	Zpráva o závadě je zdokumentovaná zpráva o jakékoli chybě v softwarovém systému, která neplní očekávanou funkci.
Souhrnná zpráva o testu	Souhrnná zpráva o testu je dokument na vysoké úrovni, který shrnuje provedené testovací činnosti a také výsledky testů.

Jaké jsou osvědčené postupy pro dosažení testovací dokumentace?

V této části se seznámíme s osvědčenými postupy, které pomáhají dosáhnout testovací dokumentace, s příklady, které vám pomohou ji lépe pochopit:

• Zapojte QA do projektu již v rané fázi: Zapojte tým QA od samého začátku projektu, aby se testovací dokumentace vyvíjela společně s návrhem produktu a požadavky.
  Příklad: QA spolupracuje během plánování sprintu na tvorbě počátečních testovacích případů na základě uživatelských příběhů.
• Udržujte dokumenty aktuální: Nevytvářejte testovací dokumenty a nezapomeňte na ně – aktualizujte je vždy, když se změní požadavky nebo funkce.
  Příklad: Když se změní přihlašovací API, okamžitě aktualizujte související testovací případy a výsledky.
• Použít kontrolu verzí: Spravujte a sledujte všechny změny v testovacích dokumentech prostřednictvím systémů pro správu verzí, abyste předešli nejasnostem a ztrátě dat.
  Příklad: Uložte si testovací plány na GitHub, abyste měli přehled o historii verzí a možnostech vrácení zpět.
• Dokument pro srozumitelnost a účel: Zaznamenávejte pouze to, co vám a vašim zúčastněným stranám pomůže pochopit průběh testování a jeho výstupy.
  Příklad: Zahrňte souhrnné zprávy o testech s uvedením úspěšných, neúspěšných a blokovaných testovacích případů pro kontrolu managementem.
• Použijte standardní šablony: Dodržujte konzistentní formát – například šablony Excelu nebo Wordu – aby se dokumentace snáze vytvářela a kontrolovala.
  Příklad: Použijte standardní „šablonu testovacího případu“ s poli pro ID, popis, předběžné podmínky a očekávané výsledky.
• Centralizujte ukládání dokumentů: Uchovávejte všechny dokumenty související s projektem na jednom přístupném místě, aby k nim členové týmu mohli snadno odkazovat nebo je aktualizovat.
  Příklad: Ukládejte artefakty testů ve sdíleném Google Drive složka přístupná celému týmu QA a vývojářů.
• Uveďte dostatek podrobností: Vyhněte se vágním nebo neúplným informacím; podrobná dokumentace zlepšuje porozumění a snižuje počet chyb během provádění testu.
  Příklad: Místo „Zkontrolovat přihlášení“ napište „Ověření přihlášení uživatele s platnými přihlašovacími údaji úspěšně přesměruje na dashboard.“

Kdy byste měli vytvořit testovací dokumentaci pro testování softwaru?

Zde jsou některé klíčové body, kdy byste měli vytvářet testovací dokumentaci pro testování softwaru:

• Fáze plánování: Před zahájením provádění testů je třeba jasně definovat rozsah, cíle a strategii testování.
• Příprava testu: Během plánování testování efektivně stanovit časové harmonogramy, zdroje a požadavky na prostředí.
• Analýza požadavků: Po analýze požadavků zajistit úplné pokrytí funkčních i nefunkčních specifikací.
• Standardizace designu: Před návrhem testovacích případů standardizovat formáty a zachovat sledovatelnost napříč všemi dokumenty.
• Dokumentace scénářů: Během návrhu testů dokumentovat scénáře, vstupy, očekávané výstupy a podrobnosti o testovacích datech.
• Připravenost k provedení: Před provedením testu ověřit připravenost testovacího prostředí, nástrojů a přesnost dokumentace.
• Hodnocení po: Po testování zaznamenat výsledky, závady a získané poznatky pro zlepšení procesu.

Jaké typy šablon jsou vyžadovány pro testovací dokumentaci?

Zde jsou některé šablony, které potřebujete pro testovací dokumentaci v testování softwaru:

Název šablony	Tools
Šablona zkušebního plánu	Microsoft Word, Google Docs nebo Confluence pro kolaborativní úpravy a správu verzí
Šablona testovacího případu	TestRail, Zephyr (v JIRA), Xray nebo Excel/Google Sheets pro strukturovanou správu testů
Šablona testovacího scénáře	JIRA, TestLink nebo Google Sheets pro dokumentaci testovacích podmínek na vysoké úrovni
Šablona matice sledovatelnosti požadavků (RTM)	Excel, Google Sheets nebo TestRail pro mapování požadavků na testovací případy
Šablona zprávy o závadách	JIRA, Bugzilla nebo Azure DevOps pro protokolování a sledování defektů
Šablona souhrnné zprávy o testu	Soutok, Google Docs nebo TestRail pro sestavování výsledků testů a analýzu

Výhody a nevýhody testovací dokumentace

Klady

• Hlavním důvodem pro vytváření testovací dokumentace je buď snížení, nebo odstranění jakýchkoli nejistot ohledně testovacích aktivit. Pomáhá odstranit nejednoznačnost, která často vzniká při přidělování úkolů.
• Dokumentace nenabízí pouze systematický přístup testování softwaru, ale také slouží jako školicí materiál pro začátečníky v procesu testování softwaru.
• Slouží jako dobrá marketingová a prodejní strategie k prezentaci testovací dokumentace a demonstraci vyspělého testovacího procesu.
• Testovací dokumentace vám pomůže nabídnout klientovi kvalitní produkt v rámci stanovených časových limitů.
• In Softwarové inženýrstvíDokumentace k testům také pomáhá s konfigurací nebo nastavením programu prostřednictvím konfigurační dokumentace a uživatelských manuálů.
• Testovací dokumentace vám pomůže zlepšit transparentnost s klientem.

Nevýhody

• Náklady na dokumentaci mohou převýšit její hodnotu, protože je velmi časově náročná.
• Mnohokrát ji píší lidé, kteří neumějí psát dobře nebo neznají látku.
• Sledovat změny požadované klientem a aktualizovat odpovídající dokumenty je únavné.
• Špatná dokumentace přímo odráží kvalitu produktu, protože může dojít k nedorozumění mezi klientem a organizací.

Časté chyby, kterým je třeba se vyhnout v testovací dokumentaci

Zde jsou nejčastější chyby, kterým byste se měli v testovací dokumentaci vyhnout:

1. Vyhněte se psaní nejasných nebo nejednoznačných popisů testovacích případů.
2. Nevynechávejte dokumentaci předběžných podmínek a závislostí testů.
3. Nikdy nezapomeňte u každého testu uvést očekávané výsledky.
4. Vyhněte se nekonzistentnímu formátování v různých testovacích dokumentech.
5. Nepoužívejte vágní nebo neměřitelné cíle testů.
6. Nikdy nevynechávejte správu verzí pro aktualizace testovací dokumentace.
7. Vyhněte se duplicitě informací napříč více testovacími artefakty.
8. Nezanedbávejte kontrolu dokumentace z hlediska její přesnosti a úplnosti.

Nejčastější dotazy