štruktúra

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

Štruktúra release notes (čo má obsahovať jeden release)

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

Reálny problém z praxe

Firma vydá novú verziu systému.

Release notes vyzerajú takto:

  • oprava bugov
  • optimalizácia výkonu
  • drobné úpravy UI
  • vylepšenia systému

Používateľ nevie:

  • čo sa zmenilo
  • či sa ho to týka
  • či musí niečo robiť inak

Support nevie:

  • na čo sa pripraviť
  • ktoré incidenty môžu pribudnúť
  • ktoré staré workaroundy už neplatia

Tester nevie:

  • ktoré zmeny sa nakoniec dostali do release
  • čo bolo odložené
  • čo je breaking change

Release notes existujú.…

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

Ako štruktúrovať support znalostnú bázu (tagy, názvy, vyhľadateľnosť)

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

 

Reálny problém z praxe

Support má dokumentáciu.

Obsahuje desiatky, neskôr stovky položiek:

  • incidenty
  • bugy
  • riešenia

Keď príde problém:

„Používateľ sa nevie prihlásiť“

Support začne hľadať.

Výsledok:

  • nenájde nič
  • alebo nájde 10 podobných článkov
  • alebo nájde nesúvisiaci výsledok

A ide sa pýtať kolegu.…

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

Štruktúra administrátorskej príručky (pre rôzne typy adminov)

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

 

Reálny problém z praxe

Nový admin dostal „admin manuál“.
Mal podľa neho nastaviť systém.

Po chvíli sa začal pýtať:

  • Toto mám robiť ja alebo dodávateľ?
  • Toto je technická konfigurácia alebo biznis nastavenie?
  • Prečo je tu polovica vecí, ktoré sa nás netýkajú?
Návrat hore