Táto šablóna slúži na vytvorenie samostatnej znalostnej položky, ktorú môže používať človek, interné vyhľadávanie, AI asistent alebo RAG riešenie.
Jedna znalostná položka má riešiť jednu konkrétnu tému, postup, pravidlo alebo problém. Nemá spájať viac nesúvisiacich oblastí do jedného dokumentu.
1. Základné údaje
Názov znalostnej položky:
Interný identifikátor:
Typ znalosti:
- pracovný postup
- pravidlo
- riešenie problému
- opis funkcionality
- konfigurácia
- obmedzenie
- známy problém
- vysvetlenie pojmu
- iné:
Modul alebo oblasť systému:
Produkt:
Verzia produktu:
Prostredie:
- produkcia
- testovacie prostredie
- vývojové prostredie
- všetky prostredia
- iné:
Rozsah platnosti:
- Core
- Custom
- Core s klientskou výnimkou
- konkrétny zákazník:
Používateľská rola:
Cieľová skupina:
- používateľ
- administrátor
- technická podpora
- tester
- vývojár
- integrátor
- AI asistent
- iná:
2. Účel znalostnej položky
Stručne opíšte, na akú otázku má položka odpovedať alebo aký problém má pomôcť vyriešiť.
Účel:
Príklad otázky používateľa:
Očakávaný výsledok:
3. Kontext použitia
Opíšte situáciu, v ktorej sa má táto znalosť použiť.
Kedy je položka relevantná:
Nevyhnutné vstupné podmienky:
Predchádzajúci stav systému:
Potrebné oprávnenia:
Súvisiaca funkcionalita alebo proces:
4. Hlavné pravidlo alebo odpoveď
Uveďte jednoznačnú a samostatne zrozumiteľnú odpoveď.
Hlavné pravidlo:
Očakávané správanie systému:
Výsledný stav:
Pri písaní odpovede nepoužívajte odkazy typu „ako je uvedené vyššie“, „pozri predchádzajúcu kapitolu“ alebo „postupujte štandardným spôsobom“. Znalostná položka musí zostať zrozumiteľná aj po oddelení od pôvodného dokumentu.
5. Postup
Jednotlivé kroky zapíšte v správnom poradí.
Krok 1
Činnosť:
Očakávaný výsledok:
Krok 2
Činnosť:
Očakávaný výsledok:
Krok 3
Činnosť:
Očakávaný výsledok:
Ak postup obsahuje rozhodovanie, pri každej podmienke uveďte aj jej následok.
Podmienka:
Výsledok pri splnení podmienky:
Výsledok pri nesplnení podmienky:
6. Výnimky a obmedzenia
Známe výnimky:
Obmedzenia funkcionality:
Prípady, na ktoré sa tento postup nevzťahuje:
Rozdiely medzi verziami:
Rozdiely medzi Core a Custom:
Rozdiely podľa zákazníka:
7. Riešenie problému
Viditeľný symptóm:
Chybové hlásenie:
Možné príčiny:
Diagnostický postup:
Riešenie:
Kedy problém eskalovať:
Komu problém eskalovať:
Údaje, ktoré treba priložiť k eskalácii:
8. Terminológia
Preferovaný názov:
Povolené synonymá:
Nepoužívané alebo zastarané názvy:
Skratky a ich význam:
Názvy obrazoviek, polí alebo tlačidiel uvádzajte presne tak, ako sa zobrazujú v systéme.
9. Zdroj a dôveryhodnosť informácie
Pôvodný zdroj:
Odkaz na zdroj:
Autor zdrojovej informácie:
Vlastník znalostnej položky:
Overil:
Spôsob overenia:
- kontrola so systémom
- kontrola so špecifikáciou
- funkčný test
- potvrdenie vlastníkom procesu
- potvrdenie technickou podporou
- iné:
Dátum overenia:
10. Platnosť a životný cyklus
Stav položky:
- návrh
- na kontrolu
- schválená
- platná
- zastaraná
- archivovaná
Platná od:
Platná do:
Dátum poslednej aktualizácie:
Dátum najbližšej kontroly:
Nahrádza položku:
Nahradená položkou:
Dôvod zmeny:
11. Citlivosť a prístup
Úroveň prístupu:
- verejné
- interné
- dôverné
- obmedzené na konkrétnu rolu
- obmedzené na konkrétneho zákazníka
Obsahuje osobné údaje:
Obsahuje bezpečnostne citlivé údaje:
Obsahuje prihlasovacie údaje, tokeny alebo tajomstvá:
Obsahuje údaje konkrétneho zákazníka:
Povolenie na použitie v AI alebo RAG:
- povolené
- povolené po anonymizácii
- povolené iba pre interné riešenie
- nepovolené
- vyžaduje schválenie:
12. Súvisiace znalosti
Súvisiace znalostné položky:
Súvisiaca používateľská dokumentácia:
Súvisiaca administrátorská dokumentácia:
Súvisiaca technická dokumentácia:
Súvisiace user stories alebo požiadavky:
Súvisiace testovacie prípady:
Súvisiace incidenty alebo chyby:
13. Metadáta pre vyhľadávanie
Kľúčové slová:
Synonymá používané používateľmi:
Názvy modulov:
Používateľské roly:
Typ problému:
Chybové kódy:
Jazyk položky:
Priorita zdroja:
14. Referenčné otázky na overenie použiteľnosti
Pripravte otázky, pomocou ktorých sa overí, či človek alebo AI dokáže položku správne nájsť a použiť.
Referenčná otázka 1
Otázka:
Očakávaná odpoveď:
Informácia, ktorá musí byť v odpovedi:
Informácia, ktorá sa v odpovedi nesmie objaviť:
Referenčná otázka 2
Otázka:
Očakávaná odpoveď:
Informácia, ktorá musí byť v odpovedi:
Informácia, ktorá sa v odpovedi nesmie objaviť:
Referenčná otázka 3
Otázka:
Očakávaná odpoveď:
Informácia, ktorá musí byť v odpovedi:
Informácia, ktorá sa v odpovedi nesmie objaviť:
15. Kontrola pred schválením
Pred schválením znalostnej položky overte:
- položka rieši jednu konkrétnu tému
- názov jasne opisuje obsah
- účel je zrozumiteľný bez znalosti pôvodného dokumentu
- je uvedený produkt, modul a verzia
- je rozlíšený rozsah Core a Custom
- postup obsahuje vstupné podmienky
- jednotlivé kroky majú očakávané výsledky
- pravidlá obsahujú aj výnimky a obmedzenia
- terminológia zodpovedá systému
- je uvedený pôvod informácie
- je určený vlastník položky
- je uvedený stav a časová platnosť
- citlivé údaje majú nastavené prístupové obmedzenia
- súvisiace dokumenty sú prepojené
- referenčné otázky boli prakticky overené
- AI nedostane klientsku výnimku ako všeobecné pravidlo
- podľa položky sa dá pracovať bez doplňujúceho telefonátu seniorovi
Evidencia schválenia
Vypracoval:
Dátum:
Skontroloval:
Dátum:
Schválil:
Dátum:
Poznámka: