Ang dokumentasyon ng system ay binubuo ng nakasulat na materyal na ginagamit upang ilarawan ang mga aplikasyon ng isang computer hardware o software system. Ang dokumentasyon ay maaaring maipakita bilang mga naka-print na manual, flash card, mga pahina ng Web o teksto ng tulong sa screen. Ang dokumentasyon ng sistema ay isang mahalagang bahagi ng tagumpay ng anumang sistema ng computer. Gayunpaman, maraming mga developer ay may isang mahirap na oras sa paglikha ng sapat na dokumentasyon para sa kanilang mga produkto. Iba't ibang mga uri ng dokumentasyon ang may iba't ibang mga layunin, kaya ang nilalaman ng anumang dokumentasyon ay nakasalalay sa kanyang nilalayon na madla.
Project Documentation
Ang layunin ng dokumentasyon ng proyekto ay naglalarawan ng proyekto sa kabuuan. Ang dokumentasyon ng proyekto ay nagbibigay sa mga executive, manager at empleyado ng malawak na pagtingin sa mga iminungkahing pamamaraan, mapagkukunan at layunin ng proyekto. Ang mga dokumento sa panukala sa proyekto ay nagpapakita ng mga executive ng mga layunin at badyet ng proyekto. Ang mga teknikal na detalye ay nagbabalangkas sa mga kinakailangan sa hardware at software para sa mga proyekto. Ang plano ng proyekto ay naglilista ng mga hakbang na gagawin ng mga programmer, technician at designer upang makamit ang mga layunin ng proyekto.
Test Documentation
Ang mga dokumento sa pagsusulit ay naglalarawan ng mga plano para sa pagsubok ng produkto bago ito ilabas. Ang kalidad ng departamento ng kasiguruhan ay bumuo ng mga plano sa pagsubok para sa parehong mga panloob na "alpha" na mga gumagamit at panlabas na "beta" na mga tagasubok.Kasama sa dokumentong pagsubok ang mga tagubilin sa pagsubok - tulad ng isang tukoy na hanay ng mga hakbang na mga tagasubok na dapat sundin - upang matukoy kung ang produkto ay gumagana bilang binalak. Kinokolekta din ng mga tauhan ng QA ang mga log ng isyu, mga listahan ng bug at mga ulat mula sa mga tagasubok.
Koponan ng Dokumentasyon
Ang pagpapalitan ng mga ideya sa mga miyembro ng koponan ay mahalaga sa tagumpay ng isang proyekto. Ang dokumentasyon ng koponan ay nagtatala ng mga palitan na ito para gamitin sa kasalukuyang proyekto at sa mga proyekto sa hinaharap. Ang mga plano ng koponan, mga iskedyul at mga update sa katayuan ay mga pangunahing bahagi ng dokumentasyon ng koponan. Ang mga checklist ay tumutulong sa mga manager ng proyekto na tingnan kung aling mga gawain ang nakumpleto ng koponan. Ang mga minuto ng mga pulong ng koponan ay nagpapahintulot sa mga tagapamahala na subaybayan ang iba't ibang mga isyu, mga mungkahi at mga takdang-aralin sa mga miyembro ng pangkat
Dokumentasyon ng User
Ang pinaka-kritikal na elemento ng dokumentasyon ng sistema ay ang nilalaman na umaabot sa customer. Ang dokumentasyon ng gumagamit ay dapat na libre mula sa labis na teknikal na hindi maintindihang pag-uusap at naglalaman ng malinaw at maigsi na wika. Ang user manual ay karaniwang ang pangunahing bahagi ng dokumentasyon ng gumagamit, ngunit ang mga user ay umaasa rin sa iba pang mga mapagkukunan. Ang mga mapagkukunan ng pagsasanay - kabilang ang mga manual at video - ay maaaring makatulong sa mga gumagamit nang mabilis at madaling maunawaan kung paano gumagana ang system. Kapag hindi gumanap ang system tulad ng inaasahan, ang gabay sa pag-troubleshoot ay maaaring makatulong sa user na mahanap at malutas ang problema.
