Skip to main content

Hva er programvaredokumentasjon?

Programvare refererer 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 opprettet som separate applikasjoner av produsenten eller tredjepartene. Dokumentasjon er en beskrivelse av et produkt og hvordan du bruker det.Programvaredokumentasjon beskriver programvare og hvordan du bruker dem.

Trykt programvaredokumentasjon, noen ganger referert til som programvaremanualer, blir ofte satt opp som en bok, med en tittelside, innholdsfortegnelse, kropp og indeks, og de har ofteNoen typiske komponenter.Den første komponenten de fleste brukere trenger er en installasjonsguide, og separate guider er gitt for de forskjellige operativsystemene programvaren fungerer på, etter behov.Installasjonsveiledningen viser spesifikasjonene som kreves for å kjøre programvaren, inkludert datamaskinoperativsystem (er), RAM, harddiskplass, en internettforbindelse og andre krav eller tillegg, for eksempel periferiutstyr.Dette følges med trinn-for-trinn-instruksjoner for installasjon, som kan være fra en CD-ROM, en DVD eller en nedlasting, for eksempel.Eventuelle uvanlige funksjoner ved installasjonsprogrammet og forklaringen av tilpassede installasjonsvalg, for eksempel alternative steder eller strømlinjeformede installasjoner, forklares generelt.

En "rask start" -veiledning er ofte den neste delen av den trykte programvaredokumentasjonen som brukes.Hurtigstartguiden tar opp der installasjonsveiledningen drar av, hjelper brukeren å komme i gang med programvaren og dens grunnleggende operasjoner.Denne delen kan være ordnet på en rekke måter, ettersom det passer den aktuelle 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 mini-lektoner.

Andre elementer som man kan forvente å finne i trykt programvaredokumentasjon inkluderer en fullstendig nedkjøring av funksjonene, med vekt på funksjoner som er nye på den nyeste versjonen;en liste over oppdateringer siden de tidligere versjonene, muligens inkludert bugs faste;informasjon om hvordan du får teknisk støtte;forklaringer på feilmeldinger;og informasjon for avanserte eller "strøm" -brukere.Spill og andre programvare kan omfatte juksark eller hint i dokumentasjonen.

Trykt 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øystips og hjelpeskjermer i selve applikasjonen, FAQS MDASH;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 programvaremanualer.De gode kan være utmerkede, mens de som ikke er godt utført, kan etterlate brukere med 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.