Systemdokumentasjon består av skriftlig materiale som brukes til å beskrive applikasjoner av et maskinvare eller programvare. Dokumentasjonen kan vises som trykte håndbøker, flashkort, websider eller hjelpetekst på skjermen. Systemdokumentasjon er en viktig komponent i suksessen til et hvilket som helst datasystem. Imidlertid har mange utviklere en vanskelig tid å skape tilstrekkelig dokumentasjon for sine produkter. Ulike typer dokumentasjon har forskjellige mål, slik at innholdet i enhver dokumentasjon vil avhenge av det tiltenkte publikum.
Prosjektdokumentasjon
Formålet med prosjektdokumentasjonen beskriver prosjektet som helhet. Prosjektdokumentasjonen gir ledere, ledere og ansatte en bred oversikt over prosjektets foreslåtte metoder, ressurser og mål. Prosjektdokumentene viser ledere mål og budsjett for prosjektet. De tekniske spesifikasjonene beskriver maskinvare- og programvarekravene for prosjektene. Prosjektplanen beskriver trinnene programmerere, teknikere og designere vil ta for å oppnå prosjektets mål.
Test dokumentasjon
Testdokumenter illustrerer planene for testing av produktet før utgivelsen. Kvalitetssikringsavdelingen utvikler testplaner for både interne "alpha" brukere og eksterne "beta" testere.Testdokumentasjonen inneholder testinstruksjoner - for eksempel et bestemt sett av trinn testere må følge - for å avgjøre om produktet fungerer som planlagt. QA-ansatte samler også problemlogger, feillister og rapporter fra testere.
Lagdokumentasjon
Utveksling av ideer blant lagmedlemmer er avgjørende for prosjektets suksess. Lagdokumentasjon registrerer disse utvekslingene for bruk på det nåværende prosjektet og på fremtidige prosjekter. Lagplaner, tidsplaner og statusoppdateringer er hovedkomponenter i lagdokumentasjon. Kontrolllister hjelper prosjektledere å se hvilke oppgaver teamet har fullført. Referatet av lagmøter tillater ledere å spore ulike problemer, forslag og oppgaver blant lagmedlemmer.
Brukerdokumentasjon
Det mest kritiske elementet i systemdokumentasjonen er innholdet som kommer til kunden. Brukerdokumentasjonen må være fri for altfor teknisk sjargong og inneholde klart, konsistent språk. Brukerhåndboken er vanligvis hovedkomponenten i brukerdokumentasjonen, men brukerne er også avhengige av andre kilder. Opplæringsressurser - inkludert manualer og videoer - kan hjelpe brukerne raskt og enkelt å forstå hvordan systemet fungerer. Når systemet ikke fungerer som forventet, kan en feilsøkingsveiledning hjelpe brukeren å finne og løse problemet.
