Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
Firma chce nasadiť AI asistenta pre support.
Má k dispozícii:
- dokumentáciu
- FAQ
- staré tickety
AI začne odpovedať.
Výsledok:
- odpovede sú nepresné
- miešajú sa rôzne scenáre
- AI si „domýšľa“
Tím je sklamaný:
„AI nefunguje.“
Čo sa tu vlastne pokazilo (analýza systému)
Problém nie je v AI.
Problém je v dátach.
Dokumentácia:
- je nekonzistentná
- nemá štruktúru
- mieša Core a Custom
- obsahuje zastarané riešenia
AI robí presne to, čo má:
- pracuje s tým, čo dostane
Ak je vstup chaos,
výstup je chaos.
Skutočné náklady (čas, chaos, riziko)
Zle pripravená dokumentácia pre AI znamená:
- nesprávne odpovede klientom
- strata dôvery
- zvýšené zaťaženie supportu
Vznikajú aj ďalšie problémy:
- AI mieša workaroundy s finálnymi riešeniami
- nevie rozlíšiť klientské výnimky
- generuje nejednoznačné odpovede
A hlavne:
firma investuje do AI bez výsledku.
Minimálny model riešenia
Základ:
AI nie je začiatok. Je to nadstavba.
Najprv musí existovať kvalitná dokumentácia.
Čo musí dokumentácia spĺňať
1. Jasná štruktúra
Každá položka má rovnaký model:
- symptóm
- príčina
- diagnostika
- riešenie
AI potrebuje konzistentný formát.
2. Jednoznačný jazyk
- krátke vety
- konkrétne pojmy
- bez nejasností
Nie:
- voľné opisné texty
3. Oddelenie Core vs Custom
AI musí vedieť:
- čo platí pre všetkých
- čo je klientská výnimka
Inak:
- odpovedá nesprávne
4. Označenie workaroundov
Workaround musí byť:
- jasne označený
- oddelený od riešenia
Inak:
- AI ho bude považovať za štandard
5. Aktuálnosť
AI pracuje s tým, čo má.
Ak dokumentácia obsahuje:
- zastarané riešenia
AI ich bude používať.
6. Vyhľadateľnosť a štruktúra
- konzistentné názvy
- tagy
- prepojenia
AI potrebuje vedieť nájsť správnu informáciu.
Príklad z praxe
Otázka:
„Prečo sa mi nevytvára faktúra?“
Zlá dokumentácia:
- dlhé odseky
- zmiešané scenáre
- bez štruktúry
AI odpovie:
- nepresne alebo všeobecne
Dobrá dokumentácia:
- jasný symptóm
- konkrétne príčiny
- presné riešenia
AI odpovie:
- konkrétne
- použiteľne
Prepojenie na workflow
Príprava na AI nevzniká jednorazovo.
Vzniká postupne:
- incident → zápis
- bug → doplnenie
- aktualizácia → úprava
To, čo robíš dnes v dokumentácii,
určuje kvalitu AI zajtra.
Prepojenie na kvalitu
AI len zosilní to, čo už existuje.
Ak máš:
- kvalitnú dokumentáciu → AI pomôže
- chaos → AI ho zrýchli
Krátke zhrnutie
AI nie je riešenie problémov v dokumentácii.
Je to ich násobič.
Ak dokumentácia nie je:
- štruktúrovaná
- jednoznačná
- aktuálna
AI nebude fungovať.
Support dokumentácia pripravená pre AI znamená:
- pripravený systém
- nie len text
To, čo dnes zapisuješ pre support,
zajtra použije AI.