praktické ukážky

Dokumentácia a používateľské príručky, Používateľské manuály

Ako písať používateľské manuály – príklady z praxe (čo funguje a čo nie)

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Manuál existoval.
Bol „dobre napísaný“.

A aj tak:

  • používatelia volali support
  • tester sa pýtal na základné veci
  • nový kolega sa nevedel zorientovať

Keď som sa na to pozrela bližšie, problém nebol v tom, že by tam informácie neboli.…

Dokumentácia a používateľské príručky, Špecifikácia požiadaviek

Najčastejšie chyby v špecifikáciách a ich dopad na projekt (praktické ukážky)

Séria: Ako písať dokumentáciu a manuály v IT projekte

Reálny problém z praxe

Tester otvorí špecifikáciu.

„Používateľ môže upraviť objednávku.“

Bez ďalších detailov.

Tester sa pýta:

  • Kedy ju môže upraviť?
  • Ktoré polia?
  • Čo ak je už zaplatená?
  • Čo ak ide o klientskú výnimku?

Odpovede:

  • „To je jasné.“
Návrat hore