La documentació del sistema es compon de material escrit usat per descriure les aplicacions d'un maquinari o sistema de programari. La documentació es pot mostrar com a manuals impresos, targetes flash, pàgines web o text d'ajuda a la pantalla. La documentació del sistema és un component vital de l'èxit de qualsevol sistema informàtic. Tanmateix, molts desenvolupadors tenen dificultats per crear documentació suficient per als seus productes. Diferents tipus de documentació tenen objectius diferents, de manera que el contingut de qualsevol documentació dependrà del públic al qual es vulgui.
Documentació del projecte
El propòsit de la documentació del projecte descriu el projecte en conjunt. La documentació del projecte ofereix als executius, directius i empleats una visió àmplia dels mètodes, recursos i objectius proposats pel projecte. Els documents de la proposta del projecte mostren als executius els objectius i el pressupost del projecte. Les especificacions tècniques indiquen els requisits de maquinari i programari per als projectes. El pla de projecte detalla els passos que els programadors, tècnics i dissenyadors adoptaran per assolir els objectius del projecte.
Prova de documentació
Els documents de prova il·lustren els plans per provar el producte abans del seu llançament. El departament de garantia de qualitat desenvolupa plans de prova tant per a usuaris interns "alfa" com per a provadors externs "beta".La documentació de la prova inclou instruccions de prova, com ara un conjunt específic de passos que els verificadors han de seguir per determinar si el producte funciona correctament. Els treballadors de la QA també recopilen registres d'incidències, llistes d'errors i informes dels verificadors.
Documentació d'equip
L'intercanvi d'idees entre els membres de l'equip és vital per a l'èxit d'un projecte. La documentació de l'equip registra aquests intercanvis per al seu ús en el projecte actual i en futurs projectes. Els plans d'equip, els horaris i les actualitzacions d'estat són components principals de la documentació de l'equip. Les llistes de comprovació ajuden els administradors de projectes a veure quines tasques ha completat l'equip. Les actes de les reunions d'equip permeten als administradors realitzar un seguiment de diversos problemes, suggeriments i assignacions entre els membres de l'equip.
Documentació d'usuari
L'element més crític de la documentació del sistema és el contingut que arriba al client. La documentació de l'usuari ha de ser lliure d'una argot excessivament tècnica i contenir un llenguatge clar i conciso. El manual d'usuari sol ser el principal component de la documentació de l'usuari, però els usuaris també confien en altres fonts. Els recursos de formació, inclosos els manuals i els vídeos, poden ajudar els usuaris a comprendre de manera ràpida i senzilla el funcionament del sistema. Quan el sistema no funciona com s'esperava, una guia de resolució de problemes pot ajudar l'usuari a trobar i resoldre el problema.
