Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
Tester dostane dokumentáciu k API:
„Endpoint vytvorí objednávku.“
V dokumentácii je:
- URL
- názov endpointu
Tester napíše test:
- pošle request
- dostane odpoveď
- test prejde
O pár dní príde incident:
„Objednávky sa nevytvárajú správne.“
Testy prešli.
Systém nefunguje.
Čo sa tu vlastne pokazilo (analýza systému)
Problém nie je v teste.
Problém je, že tester overil existenciu, nie správanie.
Dokumentácia bola čítaná povrchne:
- čo endpoint robí
- ale nie ako sa správa
Chýbalo:
- pochopenie dát
- pochopenie stavov
- pochopenie chýb
Testovanie sa zmenilo na:
„funguje / nefunguje“
Namiesto:
„správa sa to správne vo všetkých scenároch?“
Skutočné náklady (čas, chaos, riziko)
Keď sa dokumentácia neoveruje:
- chyby sa dostanú do produkcie
- testy dávajú falošný pocit istoty
- incidenty sa riešia spätne
- tester stráca dôveru
Najhorší stav:
testy prešli
ale systém nefunguje
Minimálny model riešenia
Dokumentáciu treba čítať aktívne.
A overovať ju testovaním.
- Čo dokumentácia tvrdí
Najprv si vytiahni tvrdenia:
- čo endpoint robí
- aké má vstupy
- aké má výstupy
- aké sú pravidlá
- Prelož to do otázok
Každé tvrdenie zmeň na otázku:
- čo sa stane pri správnych dátach?
- čo sa stane pri nesprávnych dátach?
- čo sa stane pri chýbajúcom poli?
- čo sa stane pri duplicite?
- Over správanie
Testuj:
- happy path
- chybové stavy
- hraničné hodnoty
- nepodporované kombinácie
Tu sa ukáže realita.
- Porovnaj dokumentáciu vs systém
- správa sa systém podľa dokumentácie?
- chýba niečo v dokumentácii?
- je dokumentácia nepresná?
- Aktualizuj alebo nahlás rozdiel
Výstup testovania nie je len bug.
Je to aj:
- chyba v dokumentácii
- chýbajúci scenár
- nejasné pravidlo
Príklad
Dokumentácia:
„Endpoint vytvorí objednávku.“
Tester overí:
- vytvorenie objednávky → OK
- chýbajúce pole → chyba 400
- duplicita → chyba 409
- neplatné dáta → validácia
Zrazu má:
- reálne správanie
- pokryté scenáre
- potvrdenú dokumentáciu
Mini checklist
Rozumieš, čo dokumentácia tvrdí?
Vieš to preložiť do testovacích otázok?
Otestoval si aj chybové scenáre?
Porovnal si výsledok s dokumentáciou?
Nahlásil si rozdiel?
Ak nie, dokumentácia nebola overená.
Prepojenie na kvalitu a workflow
Testovanie nie je len kontrola systému.
Je to aj kontrola dokumentácie.
Ak tester:
- len vykonáva kroky
- bez pochopenia
dokumentácia zostáva neoverená.
Ak tester:
- premýšľa
- overuje správanie
dokumentácia sa stáva presnejšou.
Krátke zhrnutie
Technickú dokumentáciu nestačí čítať.
Treba ju:
- pochopiť
- spochybniť
- overiť
Každé tvrdenie = test.
Ak to robíš:
- odhalíš chyby skôr
- zlepšíš dokumentáciu
- zvýšiš kvalitu systému
A to je skutočná práca testera.