Príklad
V dokumentovom systéme sú uložené zdravotné správy pacientov a finančné výpisy klientov.
Lekár má prístup k dokumentom pacientov, ktorých má pridelených. Finančný pracovník vidí výpisy klientov vo svojej agende. Pracovník technickej podpory môže riešiť problémy s aplikáciou, ale podľa pravidiel systému nemá oprávnenie čítať tieto dokumenty.…
Klient požiada o výmaz svojich osobných údajov. Pracovníčka v DMS vymaže jeho kartu a systém zobrazí správu Údaje boli úspešne vymazané.
Pri ďalšej kontrole však nájdeš jeho meno v starej verzii zmluvy, adresu v naskenovanej prílohe a telefónne číslo vo výsledkoch vyhľadávania. Dokument sa dá navyše otvoriť cez pôvodný odkaz.…
Keď v aplikácii vytvoríme objednávku, zmeníme adresu alebo pridáme nový dokument, očakávame, že tieto údaje nájdeme aj po odhlásení a opätovnom prihlásení. Aplikácia ich preto potrebuje niekam uložiť. Na tento účel často používa databázu.
Používateľ pritom zvyčajne vidí iba formulár, tlačidlo Uložiť a výslednú správu. Za týmto jednoduchým úkonom sa skrýva spracovanie požiadavky, kontrola údajov a ich zápis.…
Používateľka sa prihlási do systému na správu dokumentov, nahrá pracovnú zmluvu a otvorí jej náhľad. Aplikácia používa HTTPS a prehliadač nehlási problém s pripojením.
Pri kontrole sieťových požiadaviek však zistíš, že náhľad sa sťahuje z inej adresy cez obyčajné HTTP. Prihlásenie je chránené, ale samotný dokument sa prenáša bez šifrovania.…
Aplikácia umožňuje používateľovi nahrať dokument a tvrdí, že uložené súbory sú šifrované.
Ako tester nemusím kontrolovať samotný kryptografický algoritmus. Potrebujem však overiť, či šifrovanie funguje tam, kde má, a či používateľ nestratí prístup k dokumentom.
Príklad
Používateľ nahrá dokument zmluva.pdf.
Po uložení:
Pracovníčka odošle z dokumentového systému návrh zmluvy na schválenie. Vedúci dostane e-mail s odkazom na dokument a možnosťou schváliť ho alebo zamietnuť.
Medzitým autorka nahrá novú verziu zmluvy. Vedúci však otvorí pôvodný e-mail a klikne na schválenie.
Ktorú verziu systém schváli? Má vedúci ešte oprávnenie rozhodnúť?…
V predchádzajúcom článku sme sledovali, ako internetový obchod požiada skladový systém o informáciu o produkte. Po odoslaní požiadavky príde odpoveď. Čo však aplikácia z tejto odpovede skutočne zistí?
Nestačí jej vedieť, že server niečo poslal späť. Potrebuje rozpoznať, či požiadavka uspela, aké údaje dostala a či ich dokáže použiť.…
Keď v internetovom obchode otvoríme detail produktu, vidíme jeho názov, cenu a dostupnosť. Tieto údaje nemusia pochádzať z jednej aplikácie. Obchod môže zobraziť produkt zo svojho katalógu, no informáciu o počte kusov si vyžiadať zo skladového systému. Aby si systémy navzájom rozumeli, musia mať dohodnuté pravidlá komunikácie.…
Príklad
Vo firemnom úložisku je schválená smernica. Po vydaní novej verzie sa pôvodná presunie do archívu, aby ju zamestnanci nepoužívali pri bežnej práci. Oprávnení ľudia ju však stále potrebujú nájsť pri kontrole. Po uplynutí stanovenej lehoty môže systém spustiť ďalší krok: upozornenie, posúdenie alebo odstránenie.
Chyba nemusí znamenať iba to, že starý dokument zostal na svojom mieste.…
Príklad
V systéme na správu dokumentov zmení editorka pri zmluve stav z „Na schválenie“ na „Schválené“. V histórii sa objaví nový riadok. Stačí to?
Z auditného logu potrebujem vedieť, ktorý dokument sa zmenil, kto zmenu vykonal, čo presne sa zmenilo a kedy. Skontrolujem aj to, či záznam zostane správny pri neúspešnej operácii, súbežnej práci a zmene vykonanej mimo obrazovky dokumentu.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Pracovníčka supportu sa interného AI asistenta opýta: „Kedy sa servisná požiadavka automaticky uzavrie?“ Asistent odpovie: „Po piatich dňoch bez reakcie zákazníka.“
Odpoveď vychádza zo skutočného dokumentu. Päťdňové automatické uzavretie však platí iba pre jedného zákazníka s úpravou systému na mieru.…
Príklad
V systéme na správu dokumentov je uložená interná smernica. Anna ju upraví a uloží novú verziu. Boris má k smernici prístup a sleduje jej zmeny, preto má dostať upozornenie. Externá spolupracovníčka prístup nemá a o zmene sa nemá dozvedieť.
Skôr než začneme testovať doručenie, potrebujeme vedieť, ktorá udalosť má notifikáciu spustiť.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Tím chce, aby interný AI asistent pomáhal supportu pri chybách synchronizácie objednávok. Vyberie existujúce návody, support záznamy a release notes a sprístupní ich RAG systému.
Pri skúšobnej otázke „Môžem po chybe spustiť synchronizáciu objednávky znova?“…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Predstavme si, že pracovníčka supportu sa interného AI asistenta opýta: „Môžem po chybe synchronizácie objednávky spustiť synchronizáciu ručne znova?“
Asistent nájde support položku o tejto chybe. Dokument vysvetľuje, ktoré údaje treba skontrolovať a kedy incident odovzdať integračnému tímu.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Pracovníčka supportu sa interného AI asistenta opýtala, ako riešiť neúspešnú synchronizáciu objednávky. Dostala použiteľný postup, ale aj časť internej poznámky: meno zákazníka, identifikátor jeho objednávky a informáciu o zmluvne dohodnutej výnimke.
Postup bol vecne správny.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Po vydaní novej verzie systému sa zmenil postup prideľovania používateľských oprávnení. Predtým mohol administrátor prideliť rolu priamo. Nový postup vyžadoval najprv schválenie žiadosti zodpovednou osobou.
Administrátorský manuál bol aktualizovaný. V znalostnej báze však zostala staršia support položka s pôvodným postupom.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support sa spýta interného AI asistenta: „Môžem po chybe zopakovať import faktúr?“
Asistent nájde administrátorskú príručku a odpovie: „Áno. Opravte súbor a spustite import znova.“
V príručke však postup závisí od toho, v akom stave sa import skončil.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
ADR (Architecture Decision Record) je stručný záznam významného architektonického rozhodnutia, ktorý uchováva dôvod rozhodnutia, zvažované možnosti a jeho očakávané dôsledky.
Tím sa rozhodol zmeniť spracovanie fakturácie. Namiesto priameho volania fakturačnej služby má objednávkový systém posielať správy cez message broker.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
ADR (Architecture Decision Record) je stručný záznam významného architektonického rozhodnutia, ktorý zachytáva jeho dôvod, zvažované možnosti a dôsledky.
V technickej dokumentácii je aktuálny diagram systému.
Objednávka sa uloží cez Order API. Následne sa správa odošle do message brokera, odkiaľ ju spracuje fakturačná služba a notifikačný modul.…
Príklad
Predstav si firemný dokument, napríklad novú smernicu pre vybavovanie reklamácií.
Autor pripraví návrh a odošle ho na odbornú kontrolu. Recenzent dokument skontroluje a vráti ho na doplnenie. Autor zapracuje pripomienky a odošle novú verziu. Vedúci oddelenia ju schváli a správca dokumentov následne zverejní zamestnancom.
Proces na prvý pohľad funguje.…
