Hvordan skrive en brukerhåndbok for programvare

Den bruksanvisningen for programvare er nesten like viktig som selve programvaren. Bruksanvisningen er viktig for å lære både grunnleggende og mer avanserte teknikker for et program eller et program. Manualer er vanligvis kort, men hvis mer detalj er nødvendig, kan de være mye lenger. Lengden av en manual vil avhenge utelukkende på type programvare og hvor mye detaljer det skal inneholde. Brukere vil sette pris håndbøker med lett å finne, konsis informasjon, med nok detaljer for å unngå forvirring.

Bruksanvisning

1 Skriv en disposisjon for den manuelle. Dette vil gi deg en plan å følge.
Ting å ta med i oversikten er installasjonsprosedyren, programvare formål, menybeskrivelser, vanlige oppgaver, avanserte funksjoner, og en feilsøkingsdelen. Også inkluderer sub-seksjoner i disposisjonen for bestemte oppgaver, som å opprette en ny fil, lagre filer, og utskrift av filer.

2 Detalj installasjonsprosessen, inkludert datakrav. Gi krav før hovedinstallasjonsprosedyren slik at brukerne kan forberede sin datamaskin.
Inkluder selv de mest grunnleggende trinnene for datamaskinen nybegynnere. Disse trinnene kan inkludere "dobbeltklikke på installasjonsfilen" eller "sett inn CD-en i CD-ROM-stasjonen."
Typiske installasjonstrinn innebærer å forklare installasjonsalternativer, for eksempel en typisk installasjon versus en avansert installasjon, gang brukeren steg-for-steg gjennom hver GUI-skjermen de møter, registrere programvaren og skrive inn noen koder eller serienumre, og hvordan du kan få tilgang til programmet gang installert for å verifisere korrekt installasjon.

3 Gi en detaljert beskrivelse av programvaren formål. Ta med hva en bruker trenger programvaren for og hvordan de kan dra nytte av. For eksempel, hvis programvaren omhandler regnskap, forklarer vanlige regnskapsoppgaver som programvaren gjør enklere. Forklar hvilke funksjoner som er viktigst for sluttbrukeren. Dette vil gi brukeren en idé om hvilke funksjoner for å prøve å lære først. For eksempel, i musikk etableringen programvare, fortelle brukeren om hvor mange spor kan lagres på en gang, eventuelt inkluderte lyder og rytmer, og formatene filene kan lagres i.
Ta med en kort beskrivelse av avanserte funksjoner som gjør denne programvaren forskjellig fra andre på markedet. For eksempel kan programvaren være i stand til å generere flere rapporter eller støtter flere filtyper enn noe annet program tilgjengelig for øyeblikket.

4 Forklar hvordan du kan navigere i menyer. Forklar hvert element i menyene. Alle elementer som ikke kan forklares på en eller to setninger bør inkluderes i vanlige oppgaver i håndboken. Disse oppgavene kan omfatte forskjellige skrifttyper og farger, utskrift til ulike formater og filtyper, og organisere filer og informasjon.

5 Skriv en egen seksjon for avanserte funksjoner og ekstra funksjoner. Dette er stedet å gå i detalj. For eksempel kan en brukerveiledning for Microsoft Excel inneholder informasjon om hvordan du lager rapporter, lenker og makroer.
Ekstra funksjoner vil inneholde funksjoner for sluttbrukeren kan ikke forvente. For eksempel kan musikk etableringen programvare komme sammen med en musikkspiller. Ta deg tid til å forklare ekstra som kan komme med programvaren, eller unike bruk av programvaren.

6 Gi feilsøkingstips. Forklar betydningen av eventuelle feil brukeren kan støte på, hvordan å løse problemet, og hvordan du kan hindre det i fremtiden. Dette er også stedet for å ta med kontaktinformasjon og help desk informasjon.