INFORMACIJSKI

SUSTAVI

IZRADA DOKUMENTACIJE

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

DOKUMENTIRANJE
KORISNIČKA DOKUMENTACIJA

● Prilagođena korisnicima različitog iskustva

● Upute za uporabu (user manual)
● Priručnici (reference manual)
● Upute za vježbu (training guide, tutorial)
● Podsjetnici ili kratke upute (quick
reference guide, pocket guide, cue cards)
VELEUČILIŠTE BALTAZAR ZAPREŠIĆ
PROVJERA ISPRAVNOSTI
TEHNIČKA DOKUMENTACIJA
namijenjena tehničkom osoblju

● Upute za rukovanje i održavanje (operations manual)

● Opis procedura za pokretanje/zaustavljanje
(startup/shutdown)
● Opis izrade rezervnih kopija i vraćanja podataka
(backup, restore)
● Opis postupka ponovnog pokretanja i oporavka
(restart, recovery)

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

PROVJERA ISPRAVNOSTI

Tehnički priručnici, upravljanje konfiguracijom

(configuration management)

● Plan razvoja
● Specifikacija dizajna
● Opis arhitekture sustava
● Specifikacija sučelja prema drugim sustavima

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

PROVJERA ISPRAVNOSTI

Programska dokumentacija

● Izvorni kod
● Opis baze podataka
● Probni podaci i rezultati provjere
● Dnevnik promjena
● Programski priručnici

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

PREPORUKE ZA IZRADU
DOKUMENTACIJE
Između ostalog, dokumentacija mora:

● Biti dobro ilustrirana (slikama zaslona i njihovog

redoslijeda)
● Opisivati postupak rada, a ne samo sadržaj zaslona
● Uključivati rječnik korištenih izraza
● Opisati korake uvođenja u primjenu (npr. redoslijed
popunjavanja šifrarnika, određivanje lozinki i prava
pristupa)
● Odražavati stvarno stanje opreme u primjeni

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

PREPORUKE ZA IZRADU
DOKUMENTACIJE

● Nepostojanje dokumentacije može biti

razlogom za prestanak korištenja
aplikacija, naročito kada autor ili autori
prestanu biti raspoloživima
● Preporuča se odvojeno pohranjivati
odgovarajuću inačicu programske opreme
(alata) kojom je proizvod napravljen

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

PREPORUKE ZA IZRADU
DOKUMENTACIJE
Preporuke za izradu dokumentacije

● Dokumentacija mora biti napisana s gledišta čitatelja, a

ne pisca
● Izbjegavati ponavljanje
● Izbjegavati neodređenost
● Koristiti standardnu organizaciju dokumenata
● Dokumentacija mora bilježiti načela (argumente odluka)
● Dokumentacija mora biti ažurna
● Prije objavljivanja treba provjeriti/dokazati da odgovara
namjeni
VELEUČILIŠTE BALTAZAR ZAPREŠIĆ
PREPORUKE ZA IZRADU
DOKUMENTACIJE
● Primjeri
UserDoc.CHM, UserDoc.doc ProgDoc.doc,
ProjDoc-x.doc MaintIns.html

● Adrese
http://www.rspa.com/docs/index.html
http://www.rspa.com/apm/index.html
http://www.construx.com/doc.htm

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ

VELEUČILIŠTE BALTAZAR ZAPREŠIĆ