Dokumentacija sustava sastoji se od pisanog materijala koji se koristi za opis primjene računalnog hardvera ili softverskog sustava. Dokumentacija se može prikazati kao tiskani priručnici, flash kartice, web-stranice ili tekst pomoći na zaslonu. Dokumentacija sustava je vitalna komponenta uspjeha bilo kojeg računalnog sustava. Međutim, mnogi programeri imaju poteškoća u stvaranju dovoljne dokumentacije za svoje proizvode. Različite vrste dokumentacije imaju različite ciljeve, tako da će sadržaj bilo koje dokumentacije ovisiti o ciljanoj publici.
Projektna dokumentacija
Svrha projektne dokumentacije opisuje projekt u cjelini. Projektna dokumentacija daje rukovoditeljima, menadžerima i zaposlenicima široki pregled predloženih metoda, resursa i ciljeva projekta. Dokumenti prijedloga projekta pokazuju izvršne ciljeve i proračun projekta. Tehničke specifikacije opisuju hardverske i softverske zahtjeve za projekte. Plan projekta detaljno opisuje korake koje će programeri, tehničari i dizajneri poduzeti kako bi postigli ciljeve projekta.
Dokumentacija ispitivanja
Dokumenti o testiranju ilustriraju planove za testiranje proizvoda prije njegovog otpuštanja. Odjel za osiguranje kvalitete razvija testne planove za interne "alfa" korisnike i vanjske "beta" testere.Ispitna dokumentacija uključuje upute za testiranje - kao što je određeni skup koraka koje testeri moraju slijediti - kako bi se utvrdilo radi li proizvod kako je planirano. Osoblje za osiguranje kvalitete također prikuplja dnevnike problema, popise bugova i izvješća testera.
Dokumentacija tima
Razmjena ideja među članovima tima ključna je za uspjeh projekta. Timska dokumentacija bilježi te razmjene za korištenje na tekućem projektu i budućim projektima. Timski planovi, rasporedi i ažuriranja statusa su glavne komponente dokumentacije tima. Kontrolni popisi pomažu voditeljima projekata da vide koji su zadaci tim završili. Zapisnici timskih sastanaka omogućuju menadžerima da prate razna pitanja, prijedloge i zadatke među članovima tima.
Korisnička dokumentacija
Najkritičniji element dokumentacije sustava je sadržaj koji dopire do korisnika. Korisnička dokumentacija mora biti slobodna od pretjerano tehničkog žargona i mora sadržavati jasan i sažet jezik. Korisnički priručnik je obično glavna komponenta korisničke dokumentacije, ali se korisnici oslanjaju i na druge izvore. Resursi za obuku - uključujući priručnike i videozapise - mogu pomoći korisnicima da brzo i lako razumiju kako sustav funkcionira. Kada sustav ne funkcionira kako je očekivano, vodič za rješavanje problema može pomoći korisniku da pronađe i riješi problem.
