Ako písať release notes/poznámky k vydaniu programu
Séria: Ako písať dokumentáciu a manuály v IT projekte
Nový tester dostane úlohu overiť funkcionalitu.
Otvorí dokumentáciu a nájde:
Séria: Ako písať dokumentáciu a manuály v IT projekte
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?
Séria: Ako písať dokumentáciu a manuály v IT projekte
Release vyšiel večer.
Ráno začali prichádzať incidenty.
Vývoj pritom tvrdil:
„Veď to bolo v release notes.“
A v release notes bola jedna veta:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Používateľ otvorí release notes a prečíta si:
Lenže nikto nevie:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Firma vydá novú verziu systému.
Release notes vyzerajú takto:
Používateľ nevie:
Support nevie:
Tester nevie:
Release notes existujú.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Vo firme sa blíži release.
Projektový manažér napíše:
„Pošlite mi zmeny do release notes.“
A začne chaos:
Nakoniec vznikne dokument typu:
Bez kontextu.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Firma vydá novú verziu.
Na webe sa objaví krátky text:
„Zlepšili sme výkon a opravili chyby.“
Support však rieši desiatky otázok:
Séria: Ako písať dokumentáciu a manuály v IT projekte
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.…
