Séria: Ako písať dokumentáciu a manuály v IT projekte
Praktická ukážka
1. User story
Názov: Export faktúr do XML
User story:
Ako účtovník
chcem exportovať faktúry do XML
aby som ich mohol importovať do účtovného systému
2. Špecifikácia požiadavky
Popis funkcionality:
Systém umožňuje exportovať faktúry do XML súboru na základe zvoleného rozsahu dátumov.
Vstupy:
- dátum od
- dátum do
- typ faktúr (voliteľné)
Správanie systému:
- systém vyfiltruje faktúry podľa zadaných parametrov
- systém vygeneruje XML súbor
- súbor sa stiahne do zariadenia používateľa
Obmedzenia:
- export obsahuje len schválené faktúry
- ak neexistujú žiadne faktúry v danom rozsahu, systém zobrazí hlásenie
Chybové stavy:
- neplatný dátumový rozsah → chybová hláška
- prázdny výsledok → informácia „Žiadne dáta na export“
3. Akceptačné kritériá
- Používateľ môže zadať dátumový rozsah
- Systém exportuje len faktúry v danom rozsahu
- Export obsahuje len schválené faktúry
- Výstup je vo formáte XML
- Súbor sa automaticky stiahne
- Ak neexistujú dáta, zobrazí sa hláška
- Neplatný rozsah dátumov zobrazí chybu
4. Testovacie prípady (zoznam)
- export s platným rozsahom dátumov
- export bez dát (žiadne faktúry)
- export s neplatným rozsahom dátumov
- export obsahuje len schválené faktúry
- overenie formátu XML
- overenie stiahnutia súboru
- export s filtrom typu faktúr
5. Používateľský manuál
Ako exportovať faktúry do XML
Kedy túto funkciu použiť
Použi export, keď potrebuješ preniesť faktúry do účtovného systému.
Kroky
- Otvor modul Fakturácia
- Klikni na Export
- Zadaj rozsah dátumov (od – do)
- (Voliteľné) vyber typ faktúr
- Klikni na Generovať
Výsledok
XML súbor sa stiahne do tvojho zariadenia a môžeš ho použiť na import do účtovného systému.
Obmedzenia
- export obsahuje len schválené faktúry
- ak v danom rozsahu neexistujú faktúry, systém zobrazí hlášku
Chybové stavy
- ak zadáš neplatný rozsah dátumov, systém zobrazí chybovú hlášku
- ak neexistujú žiadne dáta, export sa nevytvorí
Čo je tu dôležité (bez teórie)
- user story definuje cieľ
- špecifikácia definuje správanie
- akceptačné kritériá definujú podmienky
- testy overujú realitu
- manuál umožňuje používateľovi vykonať úlohu
Všetko opisuje tú istú vec.
Len z iného pohľadu.
Toto je presne ten „most“, ktorý v projektoch často chýba.