Sistemos dokumentus sudaro rašytinė medžiaga, naudojama kompiuterinės techninės įrangos ar programinės įrangos sistemos aprašymui. Dokumentai gali būti rodomi kaip atspausdinti vadovai, „flash“ kortelės, tinklalapiai arba ekrano pagalba. Sistemos dokumentacija yra svarbi bet kurios kompiuterinės sistemos sėkmės dalis. Tačiau daugelis kūrėjų turi sunkų laiką rengdami pakankamus dokumentus savo gaminiams. Įvairių tipų dokumentai turi skirtingus tikslus, todėl bet kokio dokumento turinys priklausys nuo numatomos auditorijos.
Projekto dokumentacija
Projekto dokumentacijos tikslas apibūdina visą projektą. Projekto dokumentai suteikia vadovams, vadovams ir darbuotojams išsamų projekto siūlomų metodų, išteklių ir tikslų vaizdą. Projekto pasiūlymo dokumentai rodo, kad vadovai supranta projekto tikslus ir biudžetą. Techninėse specifikacijose pateikiami projektams taikomi techninės ir programinės įrangos reikalavimai. Projekto plane išsamiai aprašomi programuotojų, technikų ir dizainerių veiksmai siekiant projekto tikslų.
Bandymų dokumentacija
Bandymo dokumentai iliustruoja gaminio bandymo planus iki jo išleidimo. Kokybės užtikrinimo departamentas rengia vidinių „alfa“ vartotojų ir išorinių „beta“ testerių bandymų planus.Bandymo dokumentuose yra bandymų nurodymų, pvz., Turi būti laikomasi konkrečių žingsnių testerių, kad nustatytumėte, ar produktas veikia taip, kaip planuota. QA darbuotojai taip pat renka bandymų žurnalų, klaidų sąrašus ir ataskaitas.
Komandos dokumentacija
Grupės narių keitimasis idėjomis yra gyvybiškai svarbus projekto sėkmei. Komandos dokumentuose įrašomi šie mainai, skirti naudoti dabartiniame projekte ir būsimuose projektuose. Komandos planai, tvarkaraščiai ir būsenos atnaujinimai yra pagrindiniai komandos dokumentacijos elementai. Kontroliniai sąrašai padeda projekto vadovams peržiūrėti, kokias užduotis komanda atliko. Komandų susitikimų protokolai leidžia vadovams stebėti įvairius klausimus, pasiūlymus ir užduotis tarp komandos narių.
Vartotojo dokumentacija
Svarbiausias sistemos dokumentacijos elementas yra kliento pasiekiamas turinys. Naudotojo dokumentai turi būti be techninio žargono ir juose turi būti aiški, glausta kalba. Vartotojo vadovas paprastai yra pagrindinis vartotojo dokumentacijos komponentas, tačiau vartotojai taip pat remiasi kitais šaltiniais. Mokymo ištekliai, įskaitant vadovus ir vaizdo įrašus, gali padėti vartotojams greitai ir lengvai suprasti, kaip sistema veikia. Kai sistema neveikia taip, kaip tikėtasi, trikčių šalinimo vadovas gali padėti vartotojui rasti ir išspręsti šią problemą.
