Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
Support dostane otázku:
„Prečo u nás funguje export inak ako u iného klienta?“
Support nevie odpovedať.
Začne zisťovať:
- je to bug?
- je to konfigurácia?
- je to nová funkcionalita?
Nakoniec sa ukáže:
- ide o klientskú úpravu
Ale táto informácia:
- nie je v dokumentácii
- nie je označená
- existuje len „v hlave“
Čo sa tu vlastne pokazilo (analýza systému)
Dokumentácia nerozlišuje:
- čo je Core (štandard produktu)
- čo je Custom (klientská úprava)
Všetko je zmiešané.
Výsledok:
- support nevie, čo je očakávané správanie
- nevie, čo má porovnávať
- nevie, či ide o chybu
Toto je jeden z najčastejších tichých problémov v produktových firmách.
Skutočné náklady (čas, chaos, riziko)
Bez rozdelenia Core vs Custom:
- vznikajú falošné bugy
- support eskaluje nesprávne problémy
- vývoj rieši „chyby“, ktoré nie sú chyby
A hlavne:
- onboarding nových ľudí je pomalý
- tím sa spolieha na konkrétnych ľudí
Vzniká chaos, ktorý nie je viditeľný na prvý pohľad.
Minimálny model riešenia
Základná zmena:
Každá funkcionalita musí mať jasne definovaný rozsah platnosti.
Čo je Core
- štandardná funkcionalita produktu
- platí pre všetkých klientov
- je súčasťou oficiálneho správania systému
Čo je Custom
- klientská úprava
- špecifické pravidlá
- výnimky z Core správania
Ako to zapisovať v support dokumentácii
Každá support položka má obsahovať:
- platnosť riešenia
Príklady:
- „Platí pre všetkých klientov“
- „Platí len pre klienta XY“
- „Platí pre klientov s modulom Z“
Príklad z praxe
Symptóm:
Export obsahuje špecifické pole
Bez označenia:
- support to považuje za bug
- eskaluje
S označením:
- „Custom úprava pre klienta XY“
Support vie:
- že je to očakávané
- že sa to nemá eskalovať
Prepojenie na dokumentáciu
Core vs Custom sa netýka len supportu.
Musí byť konzistentné naprieč:
- špecifikáciou
- testovaním
- používateľským manuálom
- admin dokumentáciou
Ak je rozdiel len v jednej časti:
- vzniká konflikt
Prepojenie na kvalitu a workflow
Toto je kritický bod pre kvalitu:
Ak nie je jasné, čo je Core:
- testovanie je nepresné
- dokumentácia je nejasná
- support je neistý
A zároveň:
je to základ pre škálovanie a AI.
AI bez rozlíšenia Core vs Custom:
- odpovedá nesprávne
- mieša výnimky so štandardom
Krátke zhrnutie
Core = štandard produktu
Custom = výnimka pre klienta
Ak to nie je jasne označené:
- support nevie, čo je správne
- vznikajú falošné chyby
- tím stráca čas
Rozdelenie Core vs Custom nie je detail.
Je to základ orientácie v projekte.