workflow

Dokumentácia a používateľské príručky, Release Notes

Odkiaľ release notes vznikajú (workflow: user story → task → bug → release)

/

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

Reálny problém z praxe

Vo firme sa blíži release.

Projektový manažér napíše:
„Pošlite mi zmeny do release notes.“

A začne chaos:

  • tester prehľadáva Jiru
  • vývojár si spomína, čo vlastne robil
  • support sa pýta, čo má komunikovať klientom
  • niekto kopíruje názvy taskov
  • niekto ručne píše zoznam bugov

Nakoniec vznikne dokument typu:

  • Oprava exportu
  • Zlepšenie výkonu
  • Úpravy workflow
  • Oprava validácie

Bez kontextu.…

Ako testovať..., CMS (Content Management System), Konkrétne oblasti

Ako testovať workflow redakcie (autor → editor → publikovanie)

/

Príklad

Predstav si redakčný systém, kde autor napíše článok a odošle ho na schválenie. Editor ho upraví a nastaví publikovanie.
Na prvý pohľad všetko funguje.

Lenže:

  • článok sa omylom publikuje bez schválenia,
  • editor prepíše text autora bez histórie zmien,
  • publikovanie sa spustí skôr kvôli zlej časovej zóne,
  • alebo sa článok „zasekne“ v stave pending a nikto nevie prečo.
…
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, User story a akceptačné kritériá

Ako z user story a akceptačných kritérií vznikajú testy, dokumentácia a release notes (Epic → Story → Task → Bug v Jire)

/

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

Reálny problém z praxe

V projekte pribudne nová funkcionalita.

V Jire existuje Epic, niekoľko user story a pár taskov. Vývoj prebehne, tester pripraví testy a funkcionalita sa nasadí do produkcie.

Potom príde moment, keď treba pripraviť:

  • text do používateľského manuálu
  • informáciu pre support
  • release notes k novej verzii

A tím začne hľadať, kde vlastne je napísané:

  • čo mala funkcionalita robiť
  • pre koho bola určená
  • aké sú výnimky
  • čo sa v systéme zmenilo

Časť informácií je v user story.…

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

Ako testovať..., Bankové a platobné procesy, Konkrétne oblasti

Ako testovať schvaľovanie úverov a workflow procesov

/

Príklad
Predstav si klienta, ktorý požiada o spotrebný úver. Systém má presne nastavené workflow – od zadania žiadosti, cez kontrolu bonity, scoring, schválenie, až po podpis zmluvy a uvoľnenie peňazí. Ak sa niekde proces zasekne (napr. scoring sa nespustí, alebo dokumenty čakajú v schvaľovaní u nesprávneho pracovníka), klient čaká zbytočne a banka prichádza o dôveru aj príjem.…

Návrat hore