Špecifikácia požiadaviek

Ďalší základ pre dokumentáciu a príručky

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

Špecifikácia bez UI návrhu nie je kompletná

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

 

Reálny problém z praxe

Na projekte sa pripraví špecifikácia.

Obsahuje:

  • vstupy
  • výstupy
  • chybové stavy
  • základné scenáre

Vývoj začne implementovať.

Po čase sa objavia otázky:

  • Kde je tlačidlo na spustenie akcie?
  • Ako sa zobrazí výsledok?
  • Čo používateľ uvidí pri chybe?
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é.“
Dokumentácia a používateľské príručky, Špecifikácia požiadaviek

Prepojenie user case → špecifikácia → test case → manuál → release notes

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

Reálny problém z praxe

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

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

Core vs Custom už na úrovni špecifikácie

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

Reálny problém z praxe

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

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

Špecifikácia je prvá dokumentácia

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

 

Reálny problém z praxe

V projekte sa začne vyvíjať nová funkcionalita.

Analytik napíše krátky popis do úlohy v Jire.
Vývojár si ho vysvetlí jedným spôsobom.
Tester iným.
A zákazník očakáva ešte niečo tretie.

Keď príde čas písať dokumentáciu, objaví sa zvláštna situácia:
nikto vlastne presne nevie, ako má funkcionalita fungovať.…

Návrat hore