Sistemska dokumentacija je sestavljena iz pisnega gradiva, ki se uporablja za opis aplikacij računalniške strojne ali programske opreme. Dokumentacijo lahko prikažete kot tiskane priročnike, flash kartice, spletne strani ali zaslonsko besedilo pomoči. Dokumentacija sistema je bistvena sestavina uspeha katerega koli računalniškega sistema. Vendar pa je veliko razvijalcev težko ustvariti dovolj dokumentacije za svoje izdelke. Različne vrste dokumentacije imajo različne cilje, zato bo vsebina katere koli dokumentacije odvisna od ciljne publike.
Projektna dokumentacija
Namen projektne dokumentacije opisuje projekt kot celoto. Projektna dokumentacija daje vodstvenim delavcem, menedžerjem in zaposlenim širok pogled na predlagane metode, vire in cilje projekta. Dokumenti s predlogi projekta kažejo na cilje in proračun projekta. Tehnične specifikacije opisujejo zahteve strojne in programske opreme za projekte. Projektni načrt podrobno opisuje korake, ki jih bodo programerji, tehniki in oblikovalci sprejeli za doseganje ciljev projekta.
Preskusna dokumentacija
Dokumenti o preskusih ponazarjajo načrte za testiranje izdelka pred njegovo izdajo. Oddelek za zagotavljanje kakovosti razvija testne načrte za notranje uporabnike "alfa" in zunanje "beta" testerje.Testna dokumentacija vključuje navodila za testiranje - kot je na primer poseben niz korakov, ki jih morajo slediti testerji - da bi ugotovili, ali izdelek deluje po načrtih. Osebje za zagotavljanje kakovosti zbira tudi dnevnike izdaj, sezname hroščev in poročila preizkuševalcev.
Dokumentacija ekipe
Izmenjava idej med člani skupine je ključnega pomena za uspeh projekta. Skupina dokumentira te izmenjave za uporabo na trenutnem projektu in prihodnjih projektih. Timski načrti, urniki in posodobitve statusa so glavne sestavine dokumentacije ekipe. Kontrolni seznami pomagajo vodjem projektov, da si ogledajo, katere naloge je ekipa zaključila. Zapisniki timskih sestankov omogočajo vodjem, da spremljajo različna vprašanja, predloge in naloge med člani skupine.
Uporabniška dokumentacija
Najbolj kritičen element dokumentacije sistema je vsebina, ki doseže stranko. Uporabniška dokumentacija mora biti brez preveč tehničnega žargona in vsebovati jasen in jedrnat jezik. Uporabniški priročnik je običajno glavna komponenta uporabniške dokumentacije, vendar se uporabniki zanašajo tudi na druge vire. Sredstva za usposabljanje - vključno s priročniki in videi - lahko uporabnikom pomagajo hitro in enostavno razumeti, kako sistem deluje. Ko sistem ne deluje po pričakovanjih, lahko vodnik za odpravljanje težav pomaga uporabniku najti in rešiti težavo.
