manuál

Dokumentácia a používateľské príručky, User story a akceptačné kritériá

Ako písať testovateľné akceptačné kritériá

Reálny problém z praxe

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

User story je často jedna veta. A akceptačné kritériá k nej buď nie sú vôbec, alebo sú tiež len „nejaké poznámky“.

Potom to dopadne vždy rovnako:

  • vývoj implementuje podľa svojho výkladu,
  • tester testuje podľa svojho výkladu,
  • dokumentácia sa píše podľa toho, čo sa „náhodou“ správa v systéme.
Dokumentácia a používateľské príručky, Úvod do dokumentácie

Ako presvedčiť tím, ktorý dokumentáciu systematicky ignoruje

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

V mnohých firmách existuje dokumentácia len na papieri.
Formálne je potrebná, ale v praxi ju nikto nepíše.

Keď sa otvorí téma dokumentácie, reakcie bývajú podobné:

„Nemáme na to čas.“
„Najprv treba dokončiť funkcionalitu.“
„To dopíšeme neskôr.“
„Veď to máme v kóde.“…

Dokumentácia a používateľské príručky, Úvod do dokumentácie

Ako má vyzerať workflow projektu (Feature → Test → Dokumentácia → Release)

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

V mnohých firmách vyzerá realita približne takto:

  • vývoj implementuje novú funkcionalitu
  • tester ju otestuje
  • verzia ide do produkcie

Dokumentácia?

Používateľská sa dopíše o niekoľko verzií neskôr, keď zákazník začne urgovať.
Administrátorská je často stará niekoľko rokov.
Technická dokumentácia nevzniká vôbec.…

Dokumentácia a používateľské príručky, Úvod do dokumentácie

Ako to robiť v praxi: vrstvy dokumentácie

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

V predchádzajúcich článkoch sme pomenovali dva problémy:

  • vo firmách často neexistuje dokumentácia,
  • alebo existuje, ale mieša rôzne typy informácií.

Najčastejšie sa miešajú tieto veci:

  • štandardné funkcionality produktu
  • klientské úpravy
  • interné poznámky tímu
  • historické výnimky

Výsledok je jeden veľký dokument, ktorý síce existuje, ale nikto sa v ňom nevie orientovať.…

Dokumentácia a používateľské príručky, Úvod do dokumentácie

Core vs Custom: najväčší tichý problém dokumentácie v produktových firmách

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

V predchádzajúcich článkoch sme si ukázali dve veci:

  • prečo manuál nie je univerzálny dokument,
  • a čo sa deje vo firmách, kde dokumentácia neexistuje.

Teraz sa pozrime na problém, ktorý je menej viditeľný – ale v produktových firmách veľmi častý.…

Dokumentácia a používateľské príručky, Úvod do dokumentácie

Nie je manuál ako manuál – pre koho vlastne píšeme dokumentáciu

(Web verzia – rozšírený článok do série „Dokumentácia ako súčasť kvality produktu“)

Reálny problém z praxe

Vo firme zaznie veta:

„Treba napísať manuál.“

Nikto sa nepýta:

  • Pre koho?
  • Na aký účel?
  • V akej situácii sa bude používať?

Výsledok?

Jeden dokument, ktorý obsahuje:

  • popis funkcionality,
  • screenshoty pre používateľa,
  • technické detaily o databáze,
  • interné poznámky pre support,
  • a na konci vetu „v prípade problému kontaktujte podporu“.
Návrat hore