Systemdokumentationen består af skriftligt materiale, der bruges til at beskrive applikationerne til et computerhardware eller software system. Dokumentationen kan vises som trykte manualer, flashkort, websider eller hjælpetekst på skærmen. Systemdokumentation er en vigtig del af succesen af ethvert computersystem. Men mange udviklere har svært ved at skabe tilstrækkelig dokumentation for deres produkter. Forskellige typer dokumentation har forskellige målsætninger, så indholdet af enhver dokumentation vil afhænge af dens målgruppe.
Projektdokumentation
Formålet med projektdokumentationen beskriver projektet som helhed. Projektdokumentationen giver ledere, ledere og medarbejdere et bredt overblik over projektets foreslåede metoder, ressourcer og mål. Projektforslagsdokumenterne viser ledere mål og budget for projektet. De tekniske specifikationer beskriver hardware og software krav til projekterne. Projektplanen beskriver de trin, som programmører, teknikere og designere vil tage for at nå projektets mål.
Test dokumentation
Testdokumenter illustrerer planerne for test af produktet inden udgivelsen. Kvalitetssikringsafdelingen udvikler testplaner for både interne "alpha" brugere og eksterne "beta" testere.Testdokumentationen indeholder testinstruktioner - som et specifikt sæt af trin, som testere skal følge - for at afgøre, om produktet fungerer som planlagt. QA-medarbejdere indsamler også problemlogs, fejllister og rapporter fra testere.
Team Dokumentation
Udvekslingen af ideer blandt holdmedlemmer er afgørende for projektets succes. Team dokumentation registrerer disse udvekslinger til brug for det aktuelle projekt og om fremtidige projekter. Holdplaner, tidsplaner og statusopdateringer er hovedkomponenter i teamdokumentation. Checklister hjælper projektledere med at se, hvilke opgaver teamet har gennemført. Protokollen fra holdmøder giver ledere mulighed for at spore forskellige spørgsmål, forslag og opgaver blandt gruppemedlemmer.
Brugerdokumentation
Det mest kritiske element i systemdokumentationen er det indhold, der når kunden. Brugerdokumentationen skal være fri for alt for teknisk jargon og indeholde et klart, præcist sprog. Brugermanualen er typisk hovedkomponenten i brugerdokumentationen, men brugerne er også afhængige af andre kilder. Uddannelsesressourcer - herunder manualer og videoer - kan hjælpe brugere hurtigt og nemt at forstå, hvordan systemet fungerer. Når systemet ikke fungerer som forventet, kan en fejlfindingsvejledning hjælpe brugeren med at finde og løse problemet.
