Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
Tester hlási:
„Objednávka sa uložila, ale neobjavila sa vo výpise.“
Vývojár skontroluje databázu.
Dáta tam sú.
Frontend ich neukazuje.
API ich vracia.
Nakoniec sa zistí, že objednávka má stav, ktorý frontend neberie do úvahy.
Dáta existujú.
Len nikto nevedel, v akom stave majú byť.
Čo sa tu vlastne pokazilo (analýza systému)
Problém nie je v jednej chybe.
Problém je, že nikto nepozná životný cyklus dát.
V dokumentácii chýba:
- kde dáta vznikajú
- ako sa menia
- kde sa ukladajú
- kto ich používa
- kedy sa považujú za „platné“
Systém nie je len o funkcionalitách.
Je to tok dát medzi komponentmi.
Ak tento tok nie je popísaný, každý pracuje s inou predstavou reality.
Skutočné náklady (čas, chaos, riziko)
Keď nie je jasný tok dát:
- tester nevie, čo má overiť
- vývojár rieši symptómy, nie príčinu
- support nevie vysvetliť správanie systému
- vznikajú „záhadné“ bugy
Typická situácia:
dáta existujú
ale správajú sa inak, než tím očakáva
Minimálny model riešenia
Stačí základný popis životného cyklu dát.
- Vznik dát
- kde dáta vznikajú
- kto ich vytvára (používateľ, systém, integrácia)
- Spracovanie
- aké validácie prechádzajú
- aké pravidlá sa aplikujú
- čo sa deje pri chybe
- Uloženie
- kde sa ukladajú (databáza, cache, externý systém)
- v akej štruktúre
- Zmeny stavu
- aké stavy existujú
- ako medzi nimi prechádzajú
- čo tieto zmeny spúšťa
- Použitie
- kde sa dáta zobrazujú
- kto ich číta
- ktoré systémy ich používajú
Príklad
Objednávka:
Bez dokumentácie:
„Objednávka sa uloží.“
S dokumentáciou:
- vznik: používateľ vytvorí objednávku
- spracovanie: validácia údajov
- uloženie: databáza
- stav: „nová“ → „spracovaná“ → „odoslaná“
- použitie: zobrazenie vo výpise, export, notifikácia
Zrazu je jasné:
prečo sa niečo nezobrazuje
kde môže vzniknúť chyba
čo testovať
Mini checklist
Je jasné, kde dáta vznikajú?
Je popísané, ako sa menia?
Sú definované stavy a prechody?
Je jasné, kde sa ukladajú?
Je popísané, kto ich používa?
Ak nie, tok dát nie je zdokumentovaný.
Prepojenie na kvalitu a workflow
Tok dát je pre testera kľúčový.
Bez neho:
- testovanie ostáva na úrovni UI
- chyby sa hľadajú naslepo
- vznikajú falošné bugy
Životný cyklus dát prepája:
špecifikáciu
implementáciu
testovanie
dokumentáciu
Ak nie je jasný, celý reťazec sa rozpadá.
Krátke zhrnutie
Systém nie je len o funkcionalitách.
Je o dátach.
Ak nevieš:
kde vznikajú
ako sa menia
kde končia
nerozumieš systému.
A bez toho sa nedá robiť kvalitné testovanie ani dokumentácia.