release notes

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

Prepojenie release notes s dokumentáciou

/

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

Reálny problém z praxe

Release vyšiel.
Release notes boli pripravené.
Používateľský manuál ostal starý.
Support manuál neobsahoval novú funkcionalitu.
Admin dokumentácia neobsahovala nové nastavenie.

A výsledok?

  • Support odpovedal podľa starej verzie systému.
  • Tester nevedel, čo má retestovať.
…
Dokumentácia a používateľské príručky, Release Notes

Breaking changes a ich komunikácia

/

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

Reálny problém z praxe

Release vyšiel večer.
Ráno začali prichádzať incidenty.

  • Integrácia prestala fungovať.
  • Import odmietal staré dáta.
  • Používatelia sa nevedeli prihlásiť.
  • Support nevedel, čo sa deje.

Vývoj pritom tvrdil:

„Veď to bolo v release notes.“

A v release notes bola jedna veta:

  • „Aktualizované API.“
…
Dokumentácia a používateľské príručky, Release Notes

Ako písať zmeny bez marketingovej vaty

/

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

Reálny problém z praxe

Používateľ otvorí release notes a prečíta si:

  • „Vylepšili sme používateľský zážitok.“
  • „Optimalizovali sme systém.“
  • „Pridali sme nové možnosti práce s dátami.“
  • „Zvýšili sme stabilitu aplikácie.“

Lenže nikto nevie:

  • čo sa reálne zmenilo,
  • koho sa zmena týka,
  • či musí niečo upraviť,
  • či sa zmenilo správanie systému,
  • či hrozí problém po upgrade.
…
Dokumentácia a používateľské príručky, Release Notes

Čo sú release notes a pre koho sú určené

/

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

Reálny problém z praxe

Release je nasadený, úlohy sú zatvorené, bugy opravené. A potom príde otázka:

„Čo sa vlastne v tejto verzii zmenilo?“

Vývoj vie svoje. Tester si pamätá testované scenáre. Support zachytí prvé otázky používateľov. Obchodník povie klientovi niečo z hlavy.…

Návrat hore