Документација система се састоји од писаног материјала који се користи за описивање примене рачунарског хардвера или софтверског система. Документација се може приказати као штампани приручници, фласх картице, веб странице или текст помоћи на екрану. Документација система је витална компонента успеха било ког компјутерског система. Међутим, многим програмерима је тешко да направе довољно документације за своје производе. Различити типови документације имају различите циљеве, тако да ће садржај било које документације зависити од циљане публике.
Пројецт Доцументатион
Сврха пројектне документације описује пројекат у цјелини. Пројектна документација даје руководиоцима, менаџерима и запосленима широк преглед предложених метода, ресурса и циљева пројекта. Документи о приједлогу пројекта показују да руководитељи циљева и буџет пројекта. Техничке спецификације описују хардверске и софтверске захтеве за пројекте. План пројекта детаљно описује кораке које ће програмери, техничари и дизајнери предузети како би постигли циљеве пројекта.
Тест Доцументатион
Документи тестирања илуструју планове за тестирање производа пре његовог пуштања. Одељење за осигурање квалитета развија планове тестирања и за интерне "алфа" кориснике и за спољне "бета" тестере.Документација за тестирање укључује инструкције за тестирање - као што је одређени скуп корака које тестери морају да прате - да би се утврдило да ли производ функционише како је планирано. Особље за осигурање квалитета прикупља и дневнике издавања, листу грешака и извјештаје тестера.
Теам Доцументатион
Размена идеја међу члановима тима је од виталног значаја за успех пројекта. Тимска документација евидентира ове размене за коришћење на текућем пројекту и на будућим пројектима. Тимски планови, распореди и ажурирање статуса су главне компоненте документације тима. Контролне листе помажу пројектним менаџерима да виде који су задаци тим завршили. Записници тимских састанака омогућавају менаџерима да прате различите проблеме, сугестије и задатке међу члановима тима.
Усер Доцументатион
Најкритичнији елемент документације система је садржај који допире до корисника. Корисничка документација мора бити слободна од претјерано техничког жаргона и мора садржавати јасан и концизан језик. Кориснички приручник је обично главна компонента корисничке документације, али се корисници ослањају и на друге изворе. Ресурси за обуку - укључујући приручнике и видео записе - могу помоћи корисницима да брзо и лако разумију како систем функционише. Када систем не функционише како је очекивано, водич за решавање проблема може помоћи кориснику да пронађе и реши проблем.
