Projektna dokumentacija se izrađuje u skladu sa odgovarajućom metodologijom i u različitim stilovima kako bi zadovoljila potrebe različitih tipova korisnika. Na primjer, dokumentacija proizvedena za tehničara će biti drugačija od dokumentacije operatera za unos podataka jer njihove uloge zahtijevaju različite nivoe i vrste znanja specifičnih za njihove poslove.
Dokumentacija se piše tokom razvoja bilo kog rješenja. Ona treba da sadrži sve neophodne detalje kako bi pomogla trenutnim programerima i korisnicima, kao i svim budućim.
Vrste dokumentacije:
Programska dokumentacija
Pri razvoju softverskog rješenja programer treba dokumentovati sve korake procesa razvoja. Softverski proizvod treba da bude u potpunosti podržan tehničkom dokumentacijom, tako da svaki programer u budućnosti može razumjeti proces i softverski kod koji je razvijen.
Sistemska i tehnička dokumentacija
Sistemska dokumentacija podrazumjeva dokumentovanje svih procesa razvoja sistema. To uključuje stavke kao što su rječnici podataka, dijagrami toka podataka, mrežni dijagrami i sve druge izmjene na sistemu do kojih je došlo tokom razvoja. Sva oprema treba biti dokumentovana i svi tehnički dijelovi sistema trebaju biti dokumentovani za buduću upotrebu.
Korisnička dokumentacija
Korisnička dokumentacija je skup dokumenata koji pomažu korisniku da koristi sistem, softver ili hardver koji se implementira. Obično se sastoji od papirnatih i elektronskih dokumenata za obuku ili pomoć korisniku. To uključuje priručnike za obuku, uputstva za procedure, FAQ (često postavljana pitanja) i sl.
Papirna dokumentacija
Papirna dokumentacija je tradicionalni oblik korisničke dokumentacije. Sastoji se od priručnika i referentnih vodiča koji danas treba biti dostupna i u elektronskom dijelu vaše intranet biblioteke. Ona takođe uključuje dokumente koji su proizvedeni u firmi/instituciji i koji su posebno dizajnirani za sistem. Korisnički priručnici su najčešći oblik dokumentacije na papiru. Oni pokrivaju, u tutorskom formatu, korake (step by step) potrebne za dovršavanje zadataka koje krajnji korisnik obavlja rutinski.
Elektronska dokumentacija
Tokom posljednjih nekoliko godina elektronska dokumentacija je postala popularan način da se zaposlenima i/ili krajnjim korisnicima pruži pomoć koja im je potrebna za izvršavanje zadataka. Većina softverskih paketa sada dolazi sa priručnikom za pomoć u štampanom i elektronskom obliku. Elektronska dokumentacija može da koristi pretragu ili hipertekst ali druge multimedijalne elemente za brže kretanje kroz dokumentaciju. Pošto su ovi oblici dokumentacije dostupni u bilo kom trenutku sa računara ili servera, često se naziva "online" dokumentacija.
Postoje i drugi oblici dokumentacije. Sve su korisne u zavisnosti od korisnika i njihovih potreba. Na primjer, postoje video tutorijali za obuku, eksterni sajtovi koji pružaju pomoć krajnjem korisniku.
Nivoi dokumentacije za korisnike
- Početnik (Novice) - Vodiči za brzi početak, savjeti za rješavanje problema i priručnici za korisnike koji detaljno objašnjavaju osnovne procese.
- Intermediate korisnik (srednji nivo) - Detaljnija uputstva za upotrebu koje podrazumjeva prethodno znanje, uputstva za rješavanje problema i jednostavne tehničke smjernice.
- Ekpert - Uputstva sa objašnjenjem složenih ili naprednih funkcija.
Ili po nivou uključenosti korisnika u sistem:
- Stručnjaci - Podrška, obično tehničari softvera ili hardvera čija je uloga da održavaju sistem.
- Specijalisti - Ovi korisnici zavise od korišćenja informacionih sistema za obavljanje svog posla. Uključuju operatore za unos podataka, web programere i grafičke dizajnere i sl.
- Pomoćni radnici, honorarci ili radnici na određeno vrijeme (Adjunct) - Korisnici kojima informacione tehnologije pomažu u njihovom radu, ali nisu od suštinskog značaja. U ovu grupu spadaju medicinsko osoblje, nastavnici, računovođe, advokati i menadžeri prodavnica i sl.
- Povremeni korisnici informacionog sistema ili IT tehnologije (Incidentals) - Npr. klijent koji koristi web-katalog proizvoda kompanije za naručivanje robe, pristup sistemima na prodajnim mjestima ili čak interakciju sa elektronskom centrom ili govornom poštom.
O ČEMU TREBA VODITI RAČUNA KADA JE IZRADA DOKUMENTACIJE U PITANJU
Ako ste na poziciji naručioca usluga, u fazi implementacije određenog softverskog rješenja, usvojili ste metodologiju za implementaciju informacionog sistema, onda vam je poznato je koja vrsta dokumentacije treba da bude isporučena i kada. Sa druge strane, potrebno je da se pobrinete da dostavljena dokumentacija (posebno programska, sistemska i tehnička) ima zadovoljavajući kvalitet.
Ovo uopšte nije bezazlen posao a može se realizovati na jedan od sljedeća 2 načina:
- Razvojem i osposobljavanjem internih kadrovskih kapaciteta koji će biti do te mjere kompetentni da ocjene kvalitet projektnih deliverabli uključujući projektnu dokumentaciju,
- Angažovanjem visokostručnih spoljnih saradnika sa potrebnim kvalitetima.
Ako vam se ovaj članak dopao, lajkujte FB stranicu DM Spot i budite obavješteni kad novi članak bude objavljen.