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
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?“…
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.…
