Ako písať manuály pre technickú podporu
Séria: Ako písať dokumentáciu a manuály v IT projekte
Tím má:
Support má:
Medzi tým nie je prepojenie.
Výsledok:
Dokumentácia existuje, ale nie je napojená na realitu.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Firma má interné manuály.
Support ich otvorí.
Ale:
A ide sa pýtať kolegu.
Dokumentácia existuje.
Ale nepoužíva sa.
Chyba nie je jedna.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Firma má support dokumentáciu.
Má desiatky článkov.
Možno stovky.
Nikto však nevie:
Dokumentácia existuje.
Ale jej hodnota je len pocit.
Dokumentácia sa nemeria.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Firma chce nasadiť AI asistenta pre support.
Má k dispozícii:
AI začne odpovedať.
Výsledok:
Tím je sklamaný:
„AI nefunguje.“…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support otvorí dokumentáciu.
Nájde riešenie.
Postupuje podľa neho.
Nefunguje.
Po chvíli zisťuje:
A ide sa pýtať kolegu.
Dokumentácia existuje.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dokumentácia existuje.
Každý ju píše po svojom:
Výsledok:
A hlavne:
rovnaké problémy sa riešia rôznymi spôsobmi.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support má dokumentáciu.
Obsahuje desiatky, neskôr stovky položiek:
Keď príde problém:
„Používateľ sa nevie prihlásiť“
Support začne hľadať.
Výsledok:
A ide sa pýtať kolegu.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
V produkcii vznikne problém:
„Export padá pri veľkom objeme dát.“
Riešenie zatiaľ neexistuje.
Vývoj pripraví workaround:
Support to začne používať.
Klientom to funguje.
O pár mesiacov:
Workaround vznikol správne.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dostane otázku:
„Prečo u nás funguje export inak ako u iného klienta?“
Support nevie odpovedať.
Začne zisťovať:
Nakoniec sa ukáže:
Ale táto informácia:
Dokumentácia nerozlišuje:
Všetko je zmiešané.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dostane ticket:
„Používateľovi sa nevytvára faktúra.“
Bez jasného postupu sa deje toto:
Riešenie trvalo 2 minúty.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dostane ticket:
„Export nefunguje.“
Support skúša:
Nič.
Nakoniec ide za vývojárom:
„Nevieš sa na to pozrieť?“
Vývojár otvorí logy.
Za pár minút vie, kde je problém.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support rieši problém:
„Export padá pri väčšom objeme dát.“
V Jire existuje bug:
Bug sa opraví.
Ticket sa uzavrie.
A tým to končí.
O pár dní príde rovnaký problém na support.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Tím rieši incident:
Ticket sa uzavrie.
O pár dní príde rovnaký problém.
A nikto nevie, že už bol vyriešený.
Support dokumentácia existuje, ale:
Problém nie je v tom, že tím nevie písať dokumentáciu.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
V produkcii vznikne incident:
„Používateľom sa nevytvárajú faktúry.“
Support to rieši:
Problém sa vyrieši.
O týždeň príde rovnaký incident.
A rieši sa znova.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dostane otázku:
„Prečo sa mi nevytvorila faktúra?“
Otvorí dokumentáciu a nájde:
„Modul Fakturácia umožňuje vytvárať, upravovať a exportovať faktúry…“
To je síce pravda.
Ale nepomáha to vyriešiť problém.
Support nevie:
A ide sa pýtať seniora.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support dostane ticket:
„Používateľ sa nevie prihlásiť.“
Začne sa klasické kolečko:
Každý rieši rovnaké otázky stále dokola.
A dokumentácia?
Buď neexistuje, alebo obsahuje kapitolu:
„Prihlásenie do systému umožňuje…“
To supportu nepomôže.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Používateľ napíše na support:
„Nejde mi export faktúry.“
Support otvorí dokumentáciu. Nájde kapitolu:
„Export faktúr umožňuje exportovať dáta do XML formátu…“
Žiadna zmienka o chybe.
Žiadny postup, čo skontrolovať.
Žiadne príklady chýb.…
