Príklad
Predstav si DMS systém, do ktorého zamestnanci nahrávajú dokumenty ako zmluvy, faktúry, technické špecifikácie alebo projektovú dokumentáciu.
Používateľ chce nahrať dokument vo formáte PDF. Systém povoľuje PDF, DOCX a XLSX do veľkosti 20 MB. Po nahratí sa dokument uloží, vytvorí sa náhľad a dokument je dostupný ostatným používateľom podľa oprávnení.…
V jednej LMS aplikácii sa riešil zvláštny problém. Študent dokončil lekciu, pozrel video aj vyplnil test, ale v reporte pre lektora mal stále progres iba 60 %. Naopak, vedenie firmy tvrdilo, že kurz dokončilo podozrivo veľa používateľov za pár minút.
Na prvý pohľad všetko fungovalo:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Release vyšiel.
Release notes boli pripravené.
Používateľský manuál ostal starý.
Support manuál neobsahoval novú funkcionalitu.
Admin dokumentácia neobsahovala nové nastavenie.
A výsledok?
Séria: Ako písať dokumentáciu a manuály v IT projekte
Release vyšiel večer.
Ráno začali prichádzať incidenty.
Vývoj pritom tvrdil:
„Veď to bolo v release notes.“
A v release notes bola jedna veta:
Príklad
Obsahový systém nemusí slúžiť iba na ručné publikovanie článkov cez administráciu. Často má aj API rozhranie, cez ktoré si iné systémy čítajú články, stránky, kategórie, tagy, obrázky, kurzy alebo používateľský progres.
Predstavme si CMS, kde redaktor vytvorí článok. Webová stránka si ho následne načíta cez API.…
Príklad
Predstav si spravodajský alebo vzdelávací portál, kde každý používateľ vidí iný obsah podľa svojho profilu, histórie alebo oprávnení.
Bežný návštevník vidí odporúčané články podľa kategórií, ktoré číta najčastejšie. Prihlásený študent vidí odporúčané kurzy podľa absolvovaných lekcií. Premium používateľ vidí platený obsah, zatiaľ čo bežný používateľ len ukážku článku.…
Príklad
Firma migruje starý CMS systém na novú platformu. Na pôvodnom webe bolo 12 000 článkov, obrázky, kategórie, tagy, SEO meta dáta a používateľské komentáre. Obsah sa exportuje zo starej databázy do XML a následne importuje do nového systému.
Na prvý pohľad migrácia prebehla úspešne. Články sa zobrazujú, obrázky existujú, URL adresy fungujú.…
Príklad
Predstav si portál s online kurzami alebo streamovaciu službu. Používateľ si kúpi mesačné predplatné cez platobnú bránu, napríklad Stripe, GoPay alebo PayPal. Po úspešnej platbe sa mu automaticky odomkne platený obsah.
Na prvý pohľad ide len o „zaplať a získaj prístup“. V praxi však ide o kombináciu:
Séria: Ako písať dokumentáciu a manuály v IT projekte
Používateľ otvorí release notes a prečíta si:
Lenže nikto nevie:
Príklad
Používateľ môže do systému nahrávať rôzne súbory:
Na prvý pohľad ide o jednoduchú funkcionalitu:
„Vyber súbor → Nahrať.“
V praxi je upload jedným z najrizikovejších miest aplikácie.
Stačí:
a aplikácia môže:
Príklad
Predstavme si portál, ktorý spája redakčný systém a vzdelávaciu platformu.
Používateľ si môže nastaviť, že chce dostávať upozornenia, keď:
Na prvý pohľad ide o jednoduchú vec: systém má poslať e-mail, push notifikáciu alebo zobraziť upozornenie v aplikácii.…
Pridanie komentárov pod články, videá alebo lekcie vyzerá na prvý pohľad jednoducho. V praxi je to však kombinácia formulárov, práv používateľov, notifikácií, moderovania, bezpečnosti a výkonu.
Predstav si portál s online kurzami. Používateľ pridá komentár pod lekciu:
„Video sa mi nedá prehrať od 15:30.“
Lektor dostane notifikáciu, odpovie na komentár a administrátor neskôr nevhodný komentár zmaže.…
Príklad
Predstav si spravodajský portál alebo LMS systém, kde sa články, obrázky, videá a štýly načítavajú cez CDN sieť. Redaktor upraví titulný obrázok článku alebo opraví chybu v texte, ale časť používateľov stále vidí starú verziu obsahu. Iní používatelia už vidia novú verziu. Ďalší majú rozbitý layout, pretože sa načítal nový CSS súbor, ale starý JavaScript zostal v cache.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Firma vydá novú verziu systému.
Release notes vyzerajú takto:
Používateľ nevie:
Support nevie:
Tester nevie:
Release notes existujú.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Vo firme sa blíži release.
Projektový manažér napíše:
„Pošlite mi zmeny do release notes.“
A začne chaos:
Nakoniec vznikne dokument typu:
Bez kontextu.…
Príklad
Predstavme si vzdelávací portál, ktorý má na začiatku iba niekoľko kurzov, desiatky lekcií a pár stoviek používateľov.
Po čase sa však obsah rozrastie:
Príklad
Predstav si portál s článkami (napr. blog, spravodaj alebo LMS). Redaktor vytvorí článok „Ako testovať API“.
Vyplní:
Na prvý pohľad všetko vyzerá správne.…
Príklad
Predstav si portál (napr. spravodajský web alebo LMS), ktorý:
Používateľ vidí obsah „ako keby bol náš“, ale v skutočnosti:
