Vzorové dokumenty

Vzorové dokumenty – napr. smernice…

Bonusy, Dokumentácia a používateľské príručky, Vzorové dokumenty

Checklist hodnotenia odpovede AI

Séria: Ako písať dokumentáciu a manuály v IT projekte

Účel a použitie checklistu

Checklist slúži na hodnotenie konkrétnej odpovede AI asistenta, ktorý používateľovi poskytuje informácie z dokumentácie alebo znalostnej bázy. Možno ho použiť aj pri odpovediach vytvorených s podporou RAG.

Hodnotí sa, či odpoveď rieši otázku používateľa, zodpovedá jeho situácii, vychádza z platných podkladov a zachováva potrebné podmienky a obmedzenia.…

Bonusy, Dokumentácia a používateľské príručky, Vzorové dokumenty

Checklist pripravenosti zdroja pre RAG

Séria: Ako písať dokumentáciu a manuály v IT projekte

Účel a použitie checklistu

Checklist slúži na posúdenie jedného dokumentu alebo znalostnej položky pred sprístupnením ako zdroja pre RAG. Pomáha zaznamenať, či má zdroj použiteľný obsah, jasnú platnosť, dohľadateľný pôvod a určený prístup.

Kontrola prebieha v dvoch častiach:

  • Kontrola pôvodného dokumentu alebo znalostnej položky.
…
Bonusy, Dokumentácia a používateľské príručky, Vzorové dokumenty

Konkrétna ukážka znalostnej položky pripravenej pre AI alebo RAG

Séria: Ako písať dokumentáciu a manuály v IT projekte

Táto príloha ukazuje jednu spracovanú znalosť o zrušení objednávky. Obsahuje pravidlo, podmienky použitia, postup, výnimky, pôvod informácie a údaje o jej platnosti.

Nadväzuje na príklad z článku „Praktická ukážka: od user story a špecifikácie po znalostnú položku pre AI“.…

Bonusy, Dokumentácia a používateľské príručky, Vzorové dokumenty

Interná smernica: Minimálny dokumentačný proces pre malý projektový tím

Séria: Ako písať dokumentáciu a manuály v IT projekte

Tento vzor smernice určuje minimálny postup pri tvorbe a aktualizácii projektovej dokumentácie. Pred zavedením tím doplní konkrétne zodpovedné osoby, miesto uloženia dokumentácie, schvaľovateľa smernice a dátum účinnosti.

1. Účel a rozsah smernice

Cieľom je uchovať informácie potrebné na vývoj, testovanie, nasadenie a podporu systému tak, aby tím nebol pri bežnej práci závislý od ústneho vysvetlenia konkrétneho človeka.…

Bonusy, Dokumentácia a používateľské príručky, Vzorové dokumenty

Interná smernica: Definition of Ready (DoR)

Verzia 1.0 — účinná od: [dopíš dátum]

Účel dokumentu

Táto smernica slúži na zjednotenie kritérií pripravenosti úloh pred začiatkom realizácie. Cieľom je minimalizovať nejasnosti, dodatočné otázky, nesprávne odhady a riziko implementácie na základe neúplných alebo nejasných požiadaviek.

Úloha sa nesmie zaradiť do vývoja, ak nespĺňa Definition of Ready (DoR).…

Bonusy, Dokumentácia a používateľské príručky, Vzorové dokumenty

Interná smernica: Definition of Done (DoD)

Verzia 1.0 — účinná od: [dopíš dátum]

Účel dokumentu

Táto smernica slúži na zjednotenie vnímania stavu „hotovo“ naprieč všetkými rolami v tíme. Zamedzuje nejasnostiam a zvyšuje kvalitu doručovaných výstupov.

Spoločné základné DoD pre všetky úlohy

Každá úloha (story, bug, task…) sa považuje za „hotovú“ iba vtedy, ak sú splnené nasledovné spoločné podmienky:

  • Úloha má priradeného zodpovedného človeka.
…
Návrat hore