Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
V produkcii vznikne incident:
„Používateľom sa nevytvárajú faktúry.“
Support to rieši:
- preverí dáta
- skontroluje logy
- kontaktuje vývoj
- nájde sa príčina
Problém sa vyrieši.
O týždeň príde rovnaký incident.
A rieši sa znova.
Čo sa tu vlastne pokazilo (analýza systému)
Problém nie je v incidente.
Problém je, že sa z neho nič nestalo.
Incident sa vyriešil, ale:
- nevznikla dokumentácia
- nevznikla znalostná položka
- nevznikol systém
Znalosť ostala:
- v hlave supportu
- v Slacku
- v jednom tickete
A tým pádom sa nedá použiť znova.
Toto je presne moment, kde firmy prichádzajú o najcennejší zdroj:
reálne skúsenosti z produkcie.
Skutočné náklady (čas, chaos, riziko)
Keď sa incidenty nezapisujú:
- každý problém sa rieši od nuly
- seniori sú neustále vyrušovaní
- onboarding nových ľudí je pomalý
- support nie je škálovateľný
Vznikajú aj sekundárne problémy:
- rovnaké chyby sa opakujú
- vznikajú falošné bugy
- eskalácie sú nekonzistentné
Firma síce „rieši incidenty“,
ale nebuduje znalostnú bázu.
Minimálny model riešenia
Základné pravidlo:
Každý vyriešený incident = nová support položka
Nie výnimka. Štandard.
Ako premeniť incident na dokumentáciu
Z jedného incidentu vznikne jedna položka:
- Symptóm
„Faktúra sa nevytvorí“ - Príčina
chýbajúci parameter v konfigurácii - Diagnostika
kde to skontrolovať
čo má byť správna hodnota - Riešenie
konkrétny postup - Eskalácia
kedy to už nie je support
Dôležité pravidlá
- zapisovať reálne scenáre (nie „učebnicové“)
- používať jazyk používateľa (symptómy)
- doplniť konkrétne kroky a logy
- nezovšeobecňovať príliš skoro
Príklad z praxe
Incident:
Používateľ sa nevie prihlásiť
Riešenie tímu:
reset hesla + odblokovanie účtu
Bez zápisu:
o týždeň rovnaký problém
So zápisom:
- support to vyrieši za 2 minúty
- bez pýtania sa
- bez eskalácie
Rozdiel je len v tom, že existuje dokumentácia.
Prepojenie na kvalitu a workflow
Toto nie je len dokumentačná aktivita.
Je to procesná zmena.
Incident by mal mať jasný výstup:
- vyriešenie problému
- aktualizácia dokumentácie
Ideálne ako súčasť Definition of Done:
- incident = uzavretý až po zápise do znalostnej bázy
Tým sa:
- znižuje chaos
- zrýchľuje support
- znižuje závislosť na senioroch
Krátke zhrnutie
Incident nie je len problém.
Je to zdroj znalostí.
Ak sa nevytvorí dokumentácia:
- tím sa nič nenaučil
Ak sa vytvorí:
- vzniká systém
- support sa zrýchľuje
- firma sa vie škálovať
Znalostná báza nevzniká plánovaním.
Vzniká systematickým zapisovaním reality.