software testing documentation guide
Počas svojej kariéry v testovaní softvéru som nikdy nepočul, že by sa ľudia veľa rozprávali o dokumentácii k testovaniu softvéru. Všeobecný názor na dokumentáciu o testovaní je taký, že ktokoľvek, kto má voľný čas, môže robiť dokumentáciu ako Testovací prípad, Testovací plán, správa o stave, Správa o chybe, návrh projektu atď.
Ani ja som sa nestaral o dokumentáciu viac, ale môžem povedať, že je mojím zvykom ukladať všetky údaje čiernobielo a tiež o tom aktualizovať ostatných.
Čo sa dozviete:
- Moje skúsenosti
- Dokumentácia k testu: Čo je to?
- 10 tipov, ktoré vám pomôžu dosiahnuť cieľ dokumentácie k testu
- Dôležité dokumenty na testovanie softvéru
- Záver
- Odporúčané čítanie
Moje skúsenosti
Chcem sa s vami podeliť o svoje skúsenosti:
Dodali sme projekt (s neznámym problémom) jednému z našich klientov (nahnevaný klient). A našli problém na strane klienta, čo bola pre nás veľmi zlá situácia a ako obvykle bola všetka vina na spoločnosti QA’s.
Problém bol v otázke kompatibility jednej webovej stránky. Keď to na mňa prišlo, mal som dôkaz, že som nedostal taký dokument s požiadavkami, v ktorom sa uvádza, že musím skontrolovať aj kompatibilitu webových stránok. Vďaka bohu, že som bol v bezpečí.
To bolo pre mňa poučenie, uvedomil som si dôležitosť dokumentácie a od toho dňa som začal pracovať na dokumentoch a vytvoril som testovacie dokumenty ako Testovací plán, Testovacie prípady, kontrolný zoznam na testovanie zdravého rozumu, správa o chybe a veľa ďalších.
„Atrament je lepší ako najlepšia pamäť“ - čínske príslovie
Dokumentácia k testu: Čo je to?
Všetci čítame rôzne články o testovacích technológiách a metódach, ale koľkí z nás videli články o dokumentácii? Niet pochýb o tom, že je málo. Je to tak, že dokumenty nie sú dôležité? Nie, ale je to preto, lebo sme si ešte neuvedomili dôležitosť dokumentov.
Ale ak pozorujeme, potom je pravda, projekty, ktoré majú všetky dokumenty, majú vysokú úroveň vyspelosti.
Väčšina spoločností neprikladá dokumentácii ani malý význam, rovnako ako procesu vývoja softvéru. Ak hľadáme na webe, môžeme nájsť rôzne šablóny, ako vytvárať rôzne typy dokumentov. Koľko z nich však organizácie alebo jednotlivci skutočne používajú?
Faktom je, že dôkladná dokumentácia môže ušetriť čas, úsilie a peniaze organizácie.
Pokiaľ ide o akýkoľvek typ certifikácie, prečo je na dokumentáciu kladený dôraz, je to len preto, lebo ukazuje dôležitosť klienta a procesov pre jednotlivca a organizáciu. Pokiaľ nie ste schopní vyrobiť dokument, ktorý je pohodlný pre používateľa bez ohľadu na to, aký dobrý je váš produkt, nikto ho neprijme.
Mám skúsenosti, že vlastníme jeden produkt, ktorý má trochu neprehľadnú funkčnosť.
Keď som na tom začal pracovať, požiadal som manažéra o nejaké dokumenty pomoci a dostal som odpoveď „Nie, nemáme žiadne dokumenty“. Potom som z toho urobil problém, pretože ako QA som vedel, nikto nevie pochopiť, ako produkt používať bez dokladov alebo školenia. A ak používateľ nie je spokojný, ako si na tomto produkte zarobíme?
„Nedostatok dokumentácie sa stáva problémom prijatia“ - Wietse Venema
To isté platí pre používateľské príručky. Vezmite si príklad spoločnosti Microsoft, ktorá uvádza na trh každý produkt so správnymi dokumentmi, dokonca aj pre balík Office 2007 máme také dokumenty, ktoré sú veľmi vysvetľujúce a ľahko pochopiteľné pre všetkých používateľov. Aj preto sú všetky ich produkty úspešné.
V malých spoločnostiach sme vždy počuli „odmietnutie projektu vo fáze návrhu alebo fázy zahájenia“, je to len preto, že v dokumentácii návrhu chýba výstižný a expresívny jazyk a aby sa preukázala schopnosť organizácie.
Nie je to tak, že malé spoločnosti nemôžu poskytovať kvalitné projekty, ale je to ich neschopnosť vyjadriť svoje schopnosti. (Ja tiež pracujem s malou organizáciou s 80 zamestnancami a počul som to mnohokrát)
Osobne mám pocit, že kvalita je jediným oddelením, ktoré to umožňuje. Sme jediné oddelenie, ktoré o tom môže polemizovať a môže poskytnúť úspešnú budúcnosť našim organizáciám.
najlepších 5 sťahovačov mp3 pre Android
Zorganizujme všetky diskusie v niekoľkých bodoch z hľadiska kvality:
- Objasniť kvalitatívny cieľ a metódy
- Zaistite jasnosť v úlohách a konzistentnosť výkonu
- Zabezpečiť vnútornú koordináciu pri práci s klientmi
- Poskytnite spätnú väzbu o preventívnych opatreniach
- Poskytnite spätnú väzbu pre svoj plánovací cyklus
- Vytvorte objektívne dôkazy o výkonnosti systému riadenia kvality
10 tipov, ktoré vám pomôžu dosiahnuť cieľ dokumentácie k testu
Ako som už spomenul v mojom staršom príspevku, pochopenie dokumentácie na testovanie softvéru je vo všeobecnosti „Môže to urobiť iba človek, ktorý má voľný čas“. Musíme zmeniť toto zmýšľanie a len my potom môžeme v našich projektoch využiť silu dokumentácie.
Nie je to tak, že nevieme, ako urobiť dokumentáciu správne. Len si nemyslíme, že je to dôležité.
Každý musí mať štandardné šablóny pre všetky druhy dokumentácie, počnúc testovacou stratégiou, testovacím plánom, testovacím prípadom a testovacími údajmi až po správu o chybe.
Jedná sa iba o dodržiavanie niektorých štandardov (CMMI, ISO atď.), Ale pokiaľ ide o skutočnú implementáciu, koľko z týchto dokumentov sa skutočne používa? Potrebujeme iba zosynchronizovať náš proces kvality s normami dokumentácie a iným procesom v organizácii.
Najjednoduchšie je sledovať všetky druhy dokumentácie je zapojiť do projektu od úvodnej fázy osobu, ktorá rozumie dynamike, doméne, cieľu a technológii projektu. A kto iný, ako osoba zodpovedná za zabezpečenie kvality (samozrejme sú tu prítomní technickí autori, ktorí to robia - ale vzhľadom na všeobecný scenár malých spoločností, kde technickí autori nie sú prítomní).
Na dosiahnutie tohto cieľa testovania a dokumentácie sa domnievam, že sa musíme zamerať na niektoré body.
Tu je 10 najdôležitejších tipov, ktoré vám pomôžu dosiahnuť cieľ dokumentácie k testu:
# 1) QA by mala zahŕňať úplne prvú fázu projektu, aby QA a dokumentácia fungovali ruka v ruke.
#dva) Proces definovaný QA by mal nasledovať technickými pracovníkmi, čo pomáha odstrániť väčšinu chýb vo veľmi počiatočnej fáze.
# 3) Iba vytváranie a udržiavanie Šablóny na testovanie softvéru nestačí, prinútte ľudí, aby ich používali.
# 4) Nevytvárajte a nenechávajte iba dokument, podľa potreby aktualizujte.
# 5) Požiadavka zmeny je dôležitou fázou projektu. Nezabudnite ich pridať do zoznamu.
# 6) Na všetko používajte riadenie verzií. To vám pomôže ľahko spravovať a sledovať vaše dokumenty.
# 7) Zjednodušte proces nápravy závady zdokumentovaním všetkých závad. Nezabudnite uviesť jasný popis chyby, pri zdokumentovaní akejkoľvek chyby zopakujte kroky, postihnutú oblasť a podrobnosti o autorovi.
# 8) Pokúste sa zdokumentovať, čo je potrebné na to, aby ste pochopili svoju prácu, a to, čo budete musieť predložiť svojim zainteresovaným stranám, kedykoľvek to bude potrebné.
# 9) Na dokumentáciu použite štandardnú šablónu. Rovnako ako všetky šablóny hárkov programu Excel alebo šablóny súborov doc a držte sa ich podľa potreby všetkých svojich dokumentov.
# 10) Zdieľajte všetky dokumenty súvisiace s projektom na jednom mieste, ktoré je prístupné každému členovi tímu ako referencia a v prípade potreby ho môžete kedykoľvek aktualizovať.
Nehovorím, že uplatnením krokov získate náhle výsledky. Viem, že táto zmena nenastane za deň alebo dva, ale aspoň môžeme začať, aby sa tieto zmeny začali odohrávať pomaly.
Nakoniec „dokumentácia vyžaduje dokumentáciu“. Nie?
V životnom cykle vývoja a testovania softvéru sa používajú stovky dokumentov.
Dôležité dokumenty na testovanie softvéru
Uvádzam niekoľko dôležitých dokumentov na testovanie softvéru, ktoré musíme pravidelne používať a udržiavať:
1) Testovací plán
2) Skúšobný dizajn a Špecifikácia testovacieho prípadu
3) Testovacia stratégia
4) Súhrnné správy o teste
5) Týždenná správa o stave
6) Používateľské dokumenty / príručky
7) Správa o prijatí používateľa
8) Posúdenie rizík
9) Testovací protokol
10) Hlásenia chýb
jedenásť) Skúšobné údaje
12) Analýza testu
Softwaroví testeri musia pravidelne odkazovať na nasledujúce dokumenty:
1) Špecifikácie softvérových požiadaviek
2) Funkčné dokumenty
Záver
Dokumenty o testovaní softvéru vždy hrajú dôležitú úlohu vo fáze vývoja / testovania projektu. Takže vždy, keď je to možné, majte veci zdokumentované. Nespoliehajte sa na verbálnu komunikáciu. Buďte vždy na bezpečnej strane.
Dokumentácia vás nielen ušetrí, ale tiež pomôže organizácii z dlhodobého hľadiska ušetriť tisíce dolárov za školenie a čo je dôležitejšie pri riešení problémov spôsobených nedostatkom vývojových a testovacích dokumentov.
Nezdokumentujte iba preto, aby ste na seba neukazovali prstom, ale zvyk dokumentácie určite prinesie systematický prístup k vášmu procesu testovania a zanechá testovanie ad hoc za sebou.
O autorovi: Tento článok je napísaný členom tímu STH Tejaswini. Pracuje ako manažérka QA v organizácii.
Aké ďalšie dokumenty uchovávate pri svojich každodenných testovacích činnostiach?
Odporúčané čítanie
- Ako písať týždenné správy o testovaní softvéru
- Najlepšie nástroje na testovanie softvéru 2021 (QA Test Automation Tools)
- Úloha pomocníka QA pri testovaní softvéru
- Kurz testovania softvéru: Do ktorého inštitútu pre testovanie softvéru by som sa mal pripojiť?
- Ako svoju kariéru si zvolíte testovanie softvéru
- Práca na voľnej nohe pre spisovateľa technického obsahu, ktorý testuje softvér
- Najlepšie služby na testovanie softvéru QA od spoločnosti SoftwareTestingHelp
- Typy testovania softvéru: Rôzne typy testovania s podrobnosťami