Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
Firma má support dokumentáciu.
Má desiatky článkov.
Možno stovky.
Nikto však nevie:
- či sa používa
- či pomáha
- či má zmysel
Dokumentácia existuje.
Ale jej hodnota je len pocit.
Čo sa tu vlastne pokazilo (analýza systému)
Dokumentácia sa nemeria.
Typická realita:
- píše sa, ale nevyhodnocuje
- nikto nesleduje dopad
- neexistujú metriky
Výsledok:
- nevieme, čo funguje
- nevieme, čo je zbytočné
- nevieme, kde sú medzery
Dokumentácia je náklad.
Nie nástroj.
Skutočné náklady (čas, chaos, riziko)
Bez merania:
- vzniká obsah, ktorý nikto nepoužíva
- support stále eskaluje rovnaké problémy
- onboarding sa nezlepšuje
Ďalšie dôsledky:
- dokumentácia stagnuje
- tím jej neverí
- investovaný čas sa nevracia
A hlavne:
nedá sa ju zlepšovať.
Minimálny model riešenia
Základ:
Merať nie objem dokumentácie, ale jej dopad.
Kľúčové metriky
1. Rýchlosť riešenia (Time to Resolution)
Otázka:
- skracuje dokumentácia čas riešenia?
Ak áno:
- funguje
2. Počet eskalácií
Otázka:
- znižuje dokumentácia počet eskalácií?
Ak nie:
- chýba diagnostika alebo riešenia
3. Opakované incidenty
Otázka:
- rieši sa ten istý problém znova?
Ak áno:
- dokumentácia neexistuje alebo sa nepoužíva
4. Používanie dokumentácie
Otázka:
- support ju reálne používa?
Signály:
- otvorenia článkov
- vyhľadávania
- spätná väzba
5. Onboarding
Otázka:
- ako rýchlo sa nový človek dostane do výkonu?
Ak je dokumentácia kvalitná:
- onboarding je kratší
Čo nemerať
Častá chyba:
- počet článkov
- počet strán
- počet slov
Tieto metriky nehovoria nič o kvalite.
Príklad z praxe
Máš 50 článkov.
Support stále eskaluje:
- „Používateľ sa nevie prihlásiť“
Záver:
- problém nie je v množstve
- problém je v kvalite alebo vyhľadateľnosti
Prepojenie na workflow
Meranie musí byť súčasť procesu:
- pravidelné vyhodnotenie
- úprava dokumentácie
- doplnenie chýbajúcich scenárov
Bez toho:
- dokumentácia stagnuje
Prepojenie na kvalitu a AI
Efektívna dokumentácia je základ:
- kvalitného supportu
- škálovania tímu
- AI automatizácie
Ak nemáš metriky:
- nevieš, či si pripravená na ďalší krok
Krátke zhrnutie
Dokumentácia, ktorú nemeriaš, nevieš riadiť.
Základ:
- rýchlosť riešenia
- počet eskalácií
- opakované problémy
- reálne používanie
Ak dokumentácia nezlepšuje prácu supportu,
neplní svoj účel.