Tesztdokumentáció a szoftvertesztelésben (példa)

Mi az a tesztdokumentáció?

A tesztdokumentáció a szoftverek tesztelése előtt vagy alatt létrehozott műtermékek dokumentációja. Segít a tesztelőcsapatnak a szükséges erőfeszítések becslésében, az erőforrások és a haladás nyomon követésében, valamint a megfelelő tesztlefedettség biztosításában. A teszt feljegyzései és jelentései a dokumentumok teljes gyűjteményét alkotják, amelyek lehetővé teszik a teszttervezés, a teszttervezés, a teszt végrehajtásának és a tesztelési tevékenységből származó teszteredmények leírását és dokumentálását.

👉 Regisztrálj ingyenes élő szoftvertesztelési projektre

Miért van szükség a vizsgák formalitására?

Egy kezdő számára könnyű azt feltételezni, hogy a tesztelés a kód különböző szakaszainak eseti végrehajtását és az eredmények ellenőrzését jelenti. A való világban azonban a tesztelés egy nagyon formális tevékenység, amelyet részletesen dokumentálnak. A tesztdokumentáció megkönnyíti és ellenőrizhetővé teszi a tesztelés tervezését, áttekintését és végrehajtását.

A vizsga formalitásának mértéke a következőktől függ:

• A tesztelés alatt álló alkalmazás (AUT) típusa.
• A szervezet által követett szabványok.
• A fejlesztési folyamat érettsége.

A tesztelési tevékenységek jellemzően a következő időtartamig tartanak: 30% és 50% a teljes szoftverfejlesztési erőfeszítésből. A dokumentációk segítenek azonosítani a tesztelési folyamat fejlesztéseit, amelyek alkalmazhatók a jövőbeli projektekben.

Milyen típusú tesztdokumentációk léteznek?

Íme a tesztdokumentáció fontosabb típusai:

„A gyakorlatban ezek a dokumentumok különböző szakaszokban készülnek – a korai tervezéstől (tesztelési irányelvek, stratégia) a végrehajtáson és lezáráson át (hiba- és összefoglaló jelentések).”

A vizsgálati dokumentumok típusai	Leírás
Teszt házirend	Ez egy magas szintű dokumentum, amely leírja az elveket, módszereket és a szervezet összes fontos tesztelési célját.
Tesztstratégia	Egy magas szintű dokumentum, amely meghatározza a projekthez végrehajtandó tesztszinteket (típusokat).
Teszt terv	A tesztterv egy teljes tervezési dokumentum, amely tartalmazza a tesztelési tevékenységek hatókörét, megközelítését, erőforrásait, ütemtervét stb.
Követelmények Nyomon követhetőségi mátrix	Ez egy olyan dokumentum, amely összekapcsolja a követelményeket a tesztesetekkel.
Teszt forgatókönyv	Teszt forgatókönyv egy szoftverrendszer egy eleme vagy eseménye, amelyet egy vagy több tesztesettel lehet ellenőrizni.
Teszt eset	Ez bemeneti értékek, végrehajtási előfeltételek, várható végrehajtási utófeltételek és eredmények csoportja. Tesztforgatókönyvhöz fejlesztették ki.
Teszt adat	A tesztadatok olyan adatok, amelyek már a teszt végrehajtása előtt léteznek. Ezeket használják a teszteset végrehajtására.
Hibajelentés	A hibajelentés egy dokumentált jelentés egy szoftverrendszerben található hibáról, amely nem képes ellátni a várt funkcióját.
Teszt összefoglaló jelentés	A teszt összefoglaló jelentés egy magas szintű dokumentum, amely összefoglalja az elvégzett tesztelési tevékenységeket, valamint a teszteredményeket.

Melyek a tesztdokumentáció elérésének legjobb gyakorlatai?

Ebben a részben megismerkedünk a tesztdokumentáció elkészítését segítő legjobb gyakorlatokkal, példákkal a jobb megértés érdekében:

• A minőségbiztosítást (QA) már a projekt korai szakaszában be kell vonni: Vonja be a minőségbiztosítási csapatot a projekt kezdetétől fogva, hogy a tesztdokumentáció a terméktervezéssel és a követelményekkel párhuzamosan fejlődjön.
  Példa: A QA a sprinttervezés során együttműködik a felhasználói történetek alapján kidolgozott kezdeti tesztesetek kidolgozásában.
• Tartsa naprakészen a dokumentumokat: Ne csak úgy hozz létre tesztdokumentumokat, majd felejtsd el őket – frissítsd őket, amikor a követelmények vagy a funkciók megváltoznak.
  Példa: Amikor egy bejelentkezési API megváltozik, azonnal frissítse a kapcsolódó teszteseteket és az eredményeket.
• Verzióvezérlés használata: A tesztdokumentumok összes módosításának kezelése és nyomon követése verziókövető rendszereken keresztül a zavar és az adatvesztés elkerülése érdekében.
  Példa: A tesztterveket a GitHub-on tárolhatod a verzióelőzmények és a visszagörgetési lehetőségek átláthatósága érdekében.
• Dokumentum az érthetőség és a cél érdekében: Csak azt rögzítse, ami segít Önnek és érdekelt feleinek megérteni a tesztelés előrehaladását és a várható eredményeket.
  Példa: Mellékeljen tesztösszefoglaló jelentéseket, amelyek kiemelik a sikeres, sikertelen és blokkolt teszteseteket a vezetőség felülvizsgálata érdekében.
• Használjon szabványos sablonokat: Használjon egységes formátumot – például Excel- vagy Word-sablonokat – a dokumentáció egyszerűbb létrehozása és áttekintése érdekében.
  Példa: Használjon egy szabványos „Teszteset sablont” az azonosító, a leírás, az előfeltételek és a várható eredmények mezőivel.
• Központosított dokumentumtárolás: Tartsa az összes projekttel kapcsolatos dokumentumot egy könnyen hozzáférhető helyen, hogy a csapattagok könnyen hozzáférhessenek vagy frissíthessék azokat.
  Példa: Tárolja a tesztösszetevőket megosztott helyen Google Drive a teljes minőségbiztosítási és fejlesztői csapat számára elérhető mappa.
• Elegendő részlet megadása: Kerüld a homályos vagy hiányos információkat; a részletes dokumentáció javítja a megértést és csökkenti a hibákat a tesztek végrehajtása során.
  Példa: A „Bejelentkezés ellenőrzése” helyett írja be: „A felhasználó bejelentkezésének ellenőrzése érvényes hitelesítő adatokkal sikeresen átirányítja az irányítópultra.”

Mikor kell tesztdokumentációt készíteni szoftverteszteléshez?

Íme néhány kulcsfontosságú szempont, amikor szoftvertesztelési dokumentációt kell készíteni:

• Tervezési szakasz: A tesztek végrehajtásának megkezdése előtt világosan meg kell határozni a hatókört, a célokat és a tesztelési stratégiát.
• A teszt előkészítése: A teszttervezés során hatékonyan meg kell határozni az ütemterveket, az erőforrásokat és a környezeti követelményeket.
• Követelmény-elemzés: A követelményelemzés után a funkcionális és nem funkcionális specifikációk teljes körű lefedettségének biztosítása.
• Tervezési szabványosítás: A tesztesetek megtervezése előtt szabványosítani kell a formátumokat és fenntartani a nyomon követhetőséget az összes dokumentumban.
• Forgatókönyv dokumentáció: A teszttervezés során dokumentálni kell a forgatókönyveket, a bemeneteket, a várható kimeneteket és a tesztadatok részleteit.
• Végrehajtási készenlét: A teszt végrehajtása előtt ellenőrizni kell a tesztkörnyezet, az eszközök és a dokumentáció pontosságának alkalmasságát.
• Utóértékelés: Tesztelés után az eredmények, hibák és a folyamatfejlesztés céljából levont tanulságok rögzítése.

Milyen típusú sablonok szükségesek a tesztdokumentációhoz?

Íme néhány sablon, amelyre szükséged van a szoftvertesztelési dokumentációhoz:

Sablonnév	Eszközök
Tesztterv sablon	Microsoft Word, Google Docs, vagy Confluence a közös szerkesztéshez és verziókövetéshez
Teszteset sablon	TestRail, Zephyr (JIRA-ban), Xray vagy Excel/Google Táblázatok a strukturált tesztkezeléshez
Teszt forgatókönyv sablon	JIRA, TestLink vagy Google Táblázatok a magas szintű tesztelési feltételek dokumentálásához
Követelménykövetési mátrix (RTM) sablon	Excel, Google Táblázatok vagy TestRail a követelmények tesztesetekhez való leképezéséhez
Hibajelentési sablon	JIRA, Bugzilla vagy Azure DevOps a hibák naplózásához és nyomon követéséhez
Teszt-összefoglaló jelentéssablon	Összefolyás, Google Docs, vagy TestRail a teszteredmények összeállításához és elemzéséhez

A tesztdokumentáció előnyei és hátrányai

Érvek

• A tesztdokumentáció létrehozásának fő célja a tesztelési tevékenységekkel kapcsolatos bizonytalanságok csökkentése vagy kiküszöbölése. Segít megszüntetni a kétértelműséget, amely gyakran felmerül a feladatok elosztása során.
• A dokumentáció nemcsak szisztematikus megközelítést kínál szoftver tesztelés, de egyben képzési anyagként is szolgál a kezdőknek a szoftvertesztelési folyamatban.
• Jó marketing- és értékesítési stratégiaként szolgál a tesztdokumentációk bemutatása egy érett tesztelési folyamat bemutatása érdekében.
• A tesztdokumentáció segít abban, hogy minőségi terméket kínálj az ügyfélnek a megadott határidőkön belül.
• In SzoftverfejlesztésA tesztdokumentáció a konfigurációs dokumentumon és a felhasználói kézikönyveken keresztül segít a program konfigurálásában vagy beállításában is.
• A tesztdokumentáció segít javítani az átláthatóságot az ügyféllel.

Hátrányok

• A dokumentáció költsége meghaladhatja annak értékét, mivel nagyon időigényes.
• Sokszor olyanok írják, akik nem tudnak jól írni, vagy nem ismerik az anyagot.
• Az ügyfél által kért változtatások nyomon követése és a megfelelő dokumentumok frissítése fárasztó.
• A rossz dokumentáció közvetlenül tükrözi a termék minőségét, mivel félreértés adódhat az ügyfél és a szervezet között.

Gyakori hibák, amelyeket el kell kerülni a tesztdokumentációban

Íme a leggyakoribb hibák, amelyeket el kell kerülni egy tesztdokumentációban:

1. Kerüld a homályos vagy félreérthető teszteset-leírások írását.
2. Ne hagyd ki a teszt előfeltételeinek és függőségeinek dokumentálását.
3. Soha ne felejtsd el feltüntetni az egyes tesztek várható eredményeit.
4. Kerüld az inkonzisztens formázást a különböző tesztdokumentumokban.
5. Ne használjon homályos vagy nem mérhető tesztcélokat.
6. Soha ne hagyd ki a verziókövetést a tesztdokumentáció frissítéseinél.
7. Kerülje az információk ismétlődését több tesztműtermék között.
8. Ne hanyagolja el a dokumentáció ellenőrzését a pontosság és a teljesség szempontjából.

GYIK