Hva er programvaredokumentasjon?
Programvare viser til rutiner og programmer utviklet for et datasystem som lar bruken utføre oppgaver eller på annen måte samhandle med datamaskinen. Programvaren kan leveres av produsenten som en systemkomponent, eller opprettes som separate applikasjoner av produsenten eller tredjeparter. Dokumentasjon er en beskrivelse av et produkt og hvordan du bruker det. Programvaredokumentasjon beskriver programvare og hvordan du bruker dem.
Trykt programvaredokumentasjon, noen ganger kalt programvarehåndbøker, er ofte satt opp som en bok, med en tittelside, innholdsfortegnelse, tekst og indeks, og de har ofte noen typiske komponenter. Den første komponenten de fleste brukere trenger, er en installasjonsveiledning, og det blir gitt separate guider for de forskjellige operativsystemene programvaren fungerer etter behov. Installasjonsveiledningen viser spesifikasjonene som kreves for å kjøre programvaren, inkludert operativsystem (er), RAM, harddiskplass, en Internett-tilkobling og andre krav eller tilleggsprogrammer, for eksempel periferiutstyr. Dette følges med trinnvise instruksjoner for installasjon, som for eksempel kan komme fra en CD-ROM, en DVD eller en nedlasting. Eventuelle uvanlige funksjoner i installasjonsprogrammet og forklaring på tilpassede installasjonsvalg, for eksempel alternative steder eller strømlinjeformede installasjoner, blir generelt forklart.
En "hurtigstart" -guide er ofte neste del av den trykte programvaredokumentasjonen som brukes. Hurtigstartguiden hjelper brukeren å komme i gang med programvaren og dens grunnleggende operasjoner når installasjonsguiden slås av. Denne delen kan arrangeres på forskjellige måter, som passer til den spesielle programvaren. En populær metode for oppgaveorienterte applikasjoner er en prosjektbasert introduksjon der brukeren lærer den grunnleggende funksjonaliteten til programvaren mens han fullfører noen minileksjoner.
Andre elementer som man forventer å finne i trykt programvaredokumentasjon inkluderer en komplett nedslipp av funksjonene, med vekt på funksjoner som er nye i den nyeste versjonen; en liste over oppdateringer siden forrige versjoner, muligens inkludert feil rettet; informasjon om hvordan du skaffer teknisk support; forklaringer på feilmeldinger; og informasjon for avanserte eller “strøm” brukere. Spill og andre programmer kan inneholde jukseark eller hint i dokumentasjonen.
Utskrevet programvaredokumentasjon er ikke den eneste typen. For det første kan den trykte dokumentasjonen også være tilgjengelig online eller som pdf. Ytterligere dokumentasjon kan også være tilgjengelig i form av verktøytips og hjelpeskjermer i selve applikasjonen, vanlige spørsmål - lister over ofte stilte spørsmål sammen med svar, søkbare artikler, nettopplæring, videoer og andre formater.
Programvaredokumentasjon varierer ganske mye i kvalitet, og dette gjelder spesielt programvarehåndbøker. De gode kan være utmerkede, mens de som ikke er godt utført, kan gi brukere mange spørsmål. Det er også brukere som ikke gidder å søke i dokumentasjonen før de stiller spørsmål på programvareprodusentens fora.