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.
Čo sa tu vlastne pokazilo (analýza systému)
Dokumentácia existuje.
Ale nedá sa používať.
Problém nie je obsah.
Problém je štruktúra:
- neexistujú pravidlá pomenovania
- neexistujú tagy
- neexistuje jednotný systém
Znalostná báza je:
- zoznam článkov
- nie nástroj na riešenie problémov
Skutočné náklady (čas, chaos, riziko)
Ak sa v dokumentácii nedá vyhľadávať:
- support ju prestane používať
- vzniká paralelný „ústny systém“
- znalosti sa znova presúvajú do hláv ľudí
Ďalšie dôsledky:
- pomalé riešenie incidentov
- nekonzistentné odpovede
- zbytočné eskalácie
A hlavne:
dokumentácia stráca dôveru.
Minimálny model riešenia
Základ:
Znalostná báza musí byť navrhnutá na vyhľadávanie.
Nie na čítanie.
1. Názvy položiek
Názov rozhoduje, či sa položka nájde.
Pravidlo:
- písať podľa symptómu
- použiť jazyk používateľa
Príklady:
- „Používateľ sa nevie prihlásiť“
- „Export sa nespustí“
Nie:
- „Problém s autentifikáciou“
- „Chyba modulu exportu“
2. Tagy (značky)
Tagy umožňujú filtrovanie a kombinovanie.
Odporúčané typy tagov:
- modul (export, login, fakturácia)
- typ problému (chyba, konfigurácia, oprávnenie)
- úroveň (L1, L2)
- klient / custom
Príklad:
- export
- chyba
- klient XY
3. Konzistentné pomenovanie
Najväčší problém v praxi:
- každý píše inak
Príklady:
- „login nefunguje“
- „problém s prihlásením“
- „user sa nevie prihlásiť“
Výsledok:
- vyhľadávanie nefunguje
Riešenie:
- definovať štandard názvov
- používať jednotné pojmy
4. Vyhľadateľnosť v praxi
Support nehľadá presne.
Používa:
- skratky
- nepresné výrazy
- rôzne formulácie
Znalostná báza musí rátať s týmto:
- synonymá
- varianty názvov
- jednoduchý jazyk
5. Prepojenia medzi položkami
Jedna položka často nestačí.
Preto:
- prepojiť súvisiace problémy
- prepojiť workaroundy
- prepojiť bugy
Výsledok:
- support sa dostane k riešeniu aj nepriamo
Príklad z praxe
Problém:
„Používateľ sa nevie prihlásiť“
Dobre nastavená báza:
- názov: „Používateľ sa nevie prihlásiť“
- tagy: login, oprávnenie, chyba
- prepojenie:
- „Účet je zablokovaný“
- „Chýbajúca rola“
Support nájde riešenie za pár sekúnd.
Prepojenie na kvalitu a workflow
Štruktúra znalostnej bázy nie je technický detail.
Je to:
- základ pre rýchlosť supportu
- základ pre onboarding
- základ pre AI
Ak je zlá:
- dokumentácia existuje, ale nepoužíva sa
Prepojenie na AI
AI funguje nad dátami.
Ak sú dáta:
- nekonzistentné
- neštruktúrované
- nevyhľadateľné
AI bude:
- odpovedať nesprávne
- miešať informácie
Znalostná báza je základ pre budúcu automatizáciu.
Krátke zhrnutie
Znalostná báza nie je archív.
Je to nástroj na riešenie problémov.
Ak sa v nej nedá vyhľadávať:
- support ju nepoužije
- znalosti sa stratia
Základ:
- názvy podľa symptómov
- konzistentné pojmy
- premyslené tagy
- prepojenia medzi položkami
Ak sa dokumentácia nedá nájsť za pár sekúnd,
ako keby neexistovala.