Hvordan lage brukerdokumentasjon

Skrive dokumentasjon om hvordan du bruker et dataprogram er avgjørende for både sluttbruker og alle som prøver å trene personer på det nye programmet. Dokumentasjonen må være tydelig og lett å forstå. Du ønsker ikke at brukerne skal måtte gjette på hvordan du bruker programmet. Brukerdokumentasjon trenger en balanse av både skriftlig og visuell trinn. Følgende trinn vil gi en oversikt over hvordan du oppretter en standardbruker guidebok.

Bruksanvisning

1 Skriv en kort beskrivelse av det nye programmet --- inkludere sitt formål, hvilke plattformer programmet vil kjøre på og eventuelle krav til minne. List flere punkter som sier viktigste funksjonene i programmet.

2 Skissere hvordan du vil at brukerdokumentasjonen for å se. Inkluder eventuelle topp- og bunntekst til sted innenfor dokumentasjon, sidetall og hvordan trekket skal se ut. Denne oversikten vil også hjelpe deg med å sette guidebok sammen.

3 Skriv ditt første avsnitt - hvordan du installerer programmet. State hvert trinn tydelig fra å sette inn den kompakte disken inn i datamaskinen til hva de skal gjøre når programvaren er installert. Gi skjermbilder av installasjonsprosessen. Ikke la ut noen trinn og liste eventuelle feil som kan oppstå. Ta med et diagram av feilsøkingstips.

4 Staten klart fremgangsmåten for å få programmet til å kjøre. Inkluder som ikonet for å klikke og hva hovedskjermen vil se ut. Gi et skjermbilde av åpningsskjermbildet.

5 Skriv ditt tredje avsnitt - hvordan å operere med programmet. Beskrive eventuelle menyfunksjonene, hvordan du får tilgang hjelp hvis tilgjengelig, hvordan du lagrer filer, hvordan du skriver ut, hvordan å avslutte programmet og andre grunnleggende funksjoner. Ta skjermbilder i denne delen også. Bruk enkle engelsk, og ikke forvente at sluttbrukeren å anta noe. Hvis programmet grensesnitt med et annet program eller pakke, forklare denne sammenhengen.

6 Komponer en enkel innholdsfortegnelse og en indeks ved hjelp av søkeord fra dokumentasjonen. Skriv denne delen når du har ovenfor sentrale deler gjort. Indeksen gir brukeren en rask måte å hente informasjon uten å måtte søke gjennom hele håndboken.

7 Lag en ordliste for eventuelle tekniske ord eller sjargong som må defineres for brukeren. Deretter designe coveret til å gå på forsiden av guidebok.

8 Rediger dokumentasjon - sjekk staving, grammatikk og generell informasjonsflyt. Gjør eventuelle revisjoner og passere dokumentasjonen videre til noen andre å dobbeltsjekke arbeidet ditt. Skriv ut og binde den endelige versjonen.