Príklad
Predstav si redakčný systém, kde autor napíše článok a odošle ho na schválenie. Editor ho upraví a nastaví publikovanie.
Na prvý pohľad všetko funguje.
Lenže:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Názov: Export faktúr do XML
User story:
Ako účtovník
chcem exportovať faktúry do XML
aby som ich mohol importovať do účtovného systému
Popis funkcionality:
Systém umožňuje exportovať faktúry do XML súboru na základe zvoleného rozsahu dátumov.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Manuál existoval.
Bol „hotový“.
Bol odovzdaný.
Bol schválený.
A aj tak:
Keď som sa na to pozrela, nebol problém v tom, že by manuál chýbal.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Manuál bol jeden.
Používali ho:
Výsledok:
Obaja mali pravdu.
Manuál nebol zlý.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Manuál bol plný obrázkov.
Každý krok mal screenshot.
Šípky, krúžky, zvýraznenia.
Používateľ aj tak volal support:
„Ja to tam nemám.“
Ukázalo sa:
Používateľ nehľadal funkciu.…
Príklad
Predstav si redaktora, ktorý pripraví článok, uloží ho ako draft a plánuje publikovanie na ráno.
Ráno sa článok zobrazí na webe — ale bez obrázkov, so starou verziou textu a bez SEO titulku.
Výsledok:
CMS nie je len „editor textu“.…
Príklad
Používateľ si predplatí film v online platforme. Film sa prehrá bez problémov, ale zároveň si otvorí vývojársku konzolu v prehliadači a skúsi nájsť URL na video súbor.
Ak sa mu podarí súbor stiahnuť priamo, systém síce funguje pre bežného používateľa, ale z pohľadu bezpečnosti zlyhal.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Tím napíše manuál.
Pri prvej zmene funkcionality ho upraví.
Pri druhom klientovi ho rozšíri.
Pri treťom klientovi doplní výnimky.
Po čase:
A keď príde nový kolega:
„Platí toto pre všetkých?“…
Príklad
Používateľ si stiahne film v mobilnej aplikácii počas Wi-Fi pripojenia, aby si ho pozrel neskôr offline. Počas cesty bez internetu film prehrá bez problémov.
Po opätovnom pripojení sa však zistí, že systém nezaznamenal prehranie, nesprávne vyhodnotil licenciu a používateľovi zablokoval ďalší obsah.
Offline režim nie je len „funguje / nefunguje“ – je to kombinácia lokálnych dát, cache, práv a následnej synchronizácie.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Používateľ si otvorí manuál.
Nájde funkcionalitu, ktorú v systéme nemá.
Volá support:
„Prečo to u mňa nefunguje?“
Support zisťuje:
„To máme len u klienta XY.“
Tester si myslí, že je to bug.
Vývojár tvrdí, že je to custom.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Manuál existoval.
Bol „dobre napísaný“.
A aj tak:
Keď som sa na to pozrela bližšie, problém nebol v tom, že by tam informácie neboli.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Vyšla nová verzia systému.
Funkcionalita sa nezmenila zásadne.
Len:
Manuál bol zrazu nepoužiteľný.
Používateľ postupoval podľa neho a zasekol sa na kroku:
„Kliknite na tlačidlo Export vpravo hore.“…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Manuál existoval. Mal 60 strán.
Používateľ zavolal support a pýtal sa:
„Kde nájdem export?“
Odpoveď bola na strane 42.
Lenže:
Používateľ ten manuál nečítal.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Tester otvorí špecifikáciu.
„Používateľ môže upraviť objednávku.“
Bez ďalších detailov.
Tester sa pýta:
Odpovede:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Na projekte vznikne funkcionalita.
User story existuje.
Vývoj ju implementuje.
Tester ju otestuje.
A potom:
Používateľ nevie, že existuje.
Manuál ju opisuje inak.
Release notes ju spomenú neurčito.
Support nevie, ako sa správa.…
Príklad
Používateľ si kúpi prístup k filmu na 48 hodín. Film si večer pozrie na mobile, ráno chce pokračovať na notebooku – ale systém mu zobrazí hlášku „prístup vypršal“, aj keď ešte nemal.
Naopak, iný používateľ má obsah dostupný aj po 3 dňoch, pretože expirácia sa nesprávne počítala podľa lokálneho času zariadenia.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Na projekte sa rieši nová funkcionalita.
User story je zapísaná.
Špecifikácia vznikne.
Vývoj implementuje.
Po čase sa tester pýta:
„Prečo to funguje len u klienta XY?“
„Je to bug alebo feature?“
„Platí to pre všetkých alebo len pre jedného zákazníka?“…
Príklad
Používateľ si kúpi prístup k filmu na streamingovej službe alebo e-knihu v online knižnici.
Po zaplatení očakáva, že obsah bude dostupný – ale len za podmienok licencie.
Licencia môže napríklad určovať:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Na projekte sa objaví nová funkcionalita.
Analytik pripraví user story a krátku špecifikáciu.
Vývoj začne implementovať.
Tester pripraví test cases až keď je funkcionalita hotová.
A vtedy sa objavia otázky:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Na projekte sa objaví nové zadanie.
User story má tri vety.
Akceptačné kritériá sú dve odrážky.
„Treba pridať export údajov.“
Vývojár sa opýta analytika, ako to má fungovať.
Tester sa opýta vývojára, čo vlastne implementoval.…
