Documentația sistemului constă din materiale scrise folosite pentru a descrie aplicațiile unui hardware sau a unui sistem software. Documentația poate fi afișată ca manuale imprimate, carduri flash, pagini Web sau text de ajutor pe ecran. Documentația sistemului este o componentă vitală a succesului oricărui sistem informatic. Cu toate acestea, mulți dezvoltatori au dificultăți în a crea o documentație suficientă pentru produsele lor. Diferitele tipuri de documentație au obiective diferite, astfel încât conținutul oricărei documentații va depinde de publicul dorit.
Documentația proiectului
Scopul documentației de proiect descrie proiectul în ansamblu. Documentația de proiect oferă managerilor, managerilor și angajaților o perspectivă largă asupra metodelor, resurselor și obiectivelor propuse ale proiectului. Documentele propuse de proiect arată directorilor obiectivele și bugetul proiectului. Specificațiile tehnice descriu cerințele hardware și software pentru proiecte. Planul proiectului detaliază pașii pe care vor lua programatorii, tehnicienii și designerii pentru a atinge obiectivele proiectului.
Documentație de testare
Documentele de testare ilustrează planurile de testare a produsului înainte de lansare. Departamentul de asigurare a calității dezvoltă planuri de testare atât pentru utilizatorii "alfa" interni, cât și pentru testerele externe "beta".Documentația de testare include instrucțiuni de testare - cum ar fi un set specific de teste care trebuie urmate de testeri - pentru a determina dacă produsul funcționează conform planificării. Personalul QA colectează de asemenea jurnale de probleme, liste de erori și rapoarte de la testeri.
Documentarea echipei
Schimbul de idei între membrii echipei este vital pentru succesul unui proiect. Documentația echipei înregistrează aceste schimburi pentru utilizare pe proiectul actual și pe proiectele viitoare. Planurile de echipă, programele și actualizările de stare sunt componente majore ale documentației echipei. Listele de verificare ajută managerii de proiect să vadă ce sarcini au finalizat echipa. Minutele întâlnirilor echipei permit managerilor să urmărească diverse probleme, sugestii și sarcini între membrii echipei.
Documentație utilizator
Cel mai important element al documentației sistemului este conținutul care ajunge la client. Documentația utilizatorului trebuie să fie liberă de jargonul tehnic și să conțină un limbaj clar și concis. Manualul de utilizare este de obicei componenta principală a documentației utilizatorului, dar utilizatorii se bazează și pe alte surse. Resursele de instruire - inclusiv manualele și videoclipurile - pot ajuta utilizatorii să înțeleagă rapid și ușor cum funcționează sistemul. Când sistemul nu funcționează așa cum era de așteptat, un ghid de depanare poate ajuta utilizatorul să găsească și să rezolve problema.
