Sistēmas dokumentācija sastāv no rakstīta materiāla, ko izmanto, lai aprakstītu datortehnikas vai programmatūras sistēmas lietojumprogrammas. Dokumentāciju var parādīt kā drukātas rokasgrāmatas, flash kartes, Web lapas vai ekrāna palīdzības tekstu. Sistēmas dokumentācija ir svarīga jebkuras datorsistēmas panākumu sastāvdaļa. Tomēr daudziem izstrādātājiem ir grūti sagatavot pietiekamu dokumentāciju par saviem produktiem. Dažādiem dokumentācijas veidiem ir dažādi mērķi, tāpēc jebkuras dokumentācijas saturs būs atkarīgs no tās mērķauditorijas.
Projekta dokumentācija
Projekta dokumentācijas mērķis apraksta projektu kopumā. Projekta dokumentācija sniedz vadītājiem, vadītājiem un darbiniekiem plašu priekšstatu par projekta piedāvātajām metodēm, resursiem un mērķiem. Projekta iesnieguma dokumenti parāda vadītājiem projekta mērķus un budžetu. Tehniskajās specifikācijās ir aprakstītas aparatūras un programmatūras prasības projektiem. Projekta plānā ir detalizēti aprakstīti pasākumi, ko programmētāji, tehniķi un dizaineri veiks, lai sasniegtu projekta mērķus.
Testa dokumentācija
Testa dokumenti ilustrē ražojuma testēšanas plānus pirms tā izlaišanas. Kvalitātes nodrošināšanas nodaļa izstrādā testēšanas plānus gan iekšējiem "alfa" lietotājiem, gan ārējiem "beta" testētājiem.Testa dokumentācijā ir iekļauti testēšanas norādījumi - piemēram, konkrētiem soļu testētājiem jāievēro - lai noteiktu, vai produkts darbojas kā plānots. QA darbinieki arī apkopo žurnālu, kļūdu sarakstu un testētāju ziņojumus.
Komandas dokumentācija
Grupas locekļu ideju apmaiņa ir ļoti svarīga projekta veiksmīgai īstenošanai. Komandas dokumentācijā šīs apmaiņas tiek izmantotas pašreizējam projektam un turpmākajiem projektiem. Komandas plāni, grafiki un statusa atjauninājumi ir galvenie komandas dokumentācijas komponenti. Kontroljautājumi palīdz projektu vadītājiem apskatīt uzdevumus, kurus komanda ir pabeigusi. Komandu sanāksmju protokoli ļauj vadītājiem izsekot dažādiem jautājumiem, ieteikumiem un uzdevumiem komandas locekļu vidū.
Lietotāja dokumentācija
Svarīgākais sistēmas dokumentācijas elements ir saturs, kas sasniedz klientu. Lietotāja dokumentācijai jābūt brīvai no pārāk tehniska žargona un tajā jābūt skaidriem, kodolīgiem. Lietošanas pamācība parasti ir lietotāja dokumentācijas galvenā sastāvdaļa, bet lietotāji arī paļaujas uz citiem avotiem. Apmācības resursi, tostarp rokasgrāmatas un video, var palīdzēt lietotājiem ātri un viegli saprast, kā sistēma darbojas. Ja sistēma nedarbojas kā paredzēts, traucējummeklēšanas rokasgrāmata var palīdzēt lietotājam atrast un atrisināt problēmu.
