príklady

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Praktické ukážky: 3–5 reálnych support scenárov (z user story + akceptačné kritériá + špecifikácia + bugy → hotové support položky)

/

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

 

Reálny problém z praxe

Tím má:

  • user story
  • akceptačné kritériá
  • špecifikáciu
  • bugy

Support má:

  • otázky od používateľov

Medzi tým nie je prepojenie.

Výsledok:

  • support nevie, čo systém robí
  • nevie, čo je chyba
  • nevie, čo je očakávané správanie

Dokumentácia existuje, ale nie je napojená na realitu.…

Administrátorská príručka, Dokumentácia a používateľské príručky

Praktická ukážka ako napísať návod na 1 funkciu z user story + akceptačné kritériá + špecifikácie požiadavky

/

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

 

Reálny problém z praxe

Funkcionalita je implementovaná.

Existuje:

  • user story
  • špecifikácia
  • testy

Ale administrátorská príručka chýba alebo je neúplná.

Admin potom:

  • nevie, ako funkciu nastaviť
  • nevie, čo musí byť splnené, aby fungovala
  • nevie, čo skontrolovať, keď nefunguje

Výsledok:

Funkcionalita existuje.…

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

Praktická ukážka ako napísať používateľský návod na 1 funkciu z user story+akceptačné kritériá a špecifikácie požiadavky+testovacie prípady

/

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

Praktická ukážka

1. User story

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

 

2. Špecifikácia požiadavky

Popis funkcionality:

Systém umožňuje exportovať faktúry do XML súboru na základe zvoleného rozsahu dátumov.…

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, User story a akceptačné kritériá

Ako rozoznať dobré vs slabé user story a akceptačné kritériá (praktické ukážky)

/

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

Minimálny model riešenia

Najjednoduchší spôsob, ako zlepšiť kvalitu zadania, je porovnať slabé a dobré príklady.
Na prvý pohľad často vyzerajú podobne, ale rozdiel v zrozumiteľnosti pre tím je veľký.

Nižšie je niekoľko typických situácií z projektov.…

Návrat hore