Brukerhåndboken - User guide

For ikke å forveksle med brukerhåndboken .

En brukerhåndbok , også kjent som en brukerhåndbok , er ment å hjelpe brukerne med å bruke et bestemt produkt, en tjeneste eller et bestemt program. Det er vanligvis skrevet av en tekniker, produktutvikler eller selskapets kundeservicemedarbeidere.

Brukerveiledning følger ofte med ved kjøp av husholdningsapparater. Men nå er det vanlig i både tjenester, programvare, applikasjoner ... Det er publisert i papirkopi eller i myk kopi (dokument eller program).

De fleste brukerveiledninger inneholder både en skriftlig guide og tilhørende bilder. Når det gjelder dataprogrammer, er det vanlig å inkludere skjermbilder av grensesnittet mellom mennesker og maskiner, og maskinvarehåndbøker inneholder ofte klare, forenklede diagrammer . Språket som brukes er tilpasset tiltenkt publikum , med sjargong holdt til et minimum eller forklart grundig.

Innhold i en brukermanual

Delene av en brukermanual inkluderer ofte:

  • En forside
  • En tittelside og opphavsrettsside
  • Et forord, som inneholder detaljer om relaterte dokumenter og informasjon om hvordan du navigerer i brukerhåndboken
  • En innholdsside
  • En formålsseksjon. Dette bør være en oversikt i stedet for å beskrive formålet med dokumentet
  • En målgruppeseksjon for eksplisitt å angi hvem som er den tiltenkte målgruppen som må lese, inkludert valgfrie
  • Et omfangsavsnitt er avgjørende, ettersom det også fungerer som en ansvarsfraskrivelse, og angir hva som er utenfor virkeområdet og hva som dekkes
  • En guide for hvordan du bruker minst hovedfunksjonen til systemet
  • En feilsøkingsdel som beskriver mulige feil eller problemer som kan oppstå, sammen med hvordan du fikser dem
  • En FAQ (Frequently Asked Questions)
  • Hvor finner du ytterligere hjelp og kontaktinformasjon
  • En ordliste og, for større dokumenter, en indeks

Historie

Image
Brukerguiden inngravert i en modell av Antikythera -mekanismen.

Brukerguider er funnet med gamle enheter. Et eksempel er Antikythera -mekanismen , en 2000 år gammel gresk analog datamaskin som ble funnet utenfor kysten av den greske øya Antikythera i år 1900. På forsiden av denne enheten er tekststykker som beskriver funksjonene og driften av mekanismen.

Etter hvert som programvareindustrien utviklet seg, var spørsmålet om hvordan man best dokumenterte programmer uavgjort. Dette var et unikt problem for programvareutviklere, siden brukerne ofte ble frustrert over gjeldende hjelpedokumenter. Noen hensyn for å skrive en brukerhåndbok som ble utviklet på dette tidspunktet inkluderer:

  • bruk av vanlig språk
  • lengde og lesevansker
  • rollen som trykte brukerguider for digitale programmer
  • bruker-sentrert design

Programvarehåndbøker og veiledninger

Brukermanualer og brukerveiledninger for de fleste ikke-trivielle programvareprogrammer er boklignende dokumenter med innhold som ligner listen ovenfor. De kan distribueres enten på trykk eller elektronisk. Noen dokumenter har en mer flytende struktur med mange interne lenker. Den Google Earth brukerhåndboken er et eksempel på dette formatet. Begrepet guide brukes ofte på et dokument som tar for seg et bestemt aspekt av et programvareprodukt. Noen bruksområder er Installation Guide , Komme i gang , og diverse Slik guider. Et eksempel er Picasa Komme i gang -guiden .

I noen forretningsprogrammer , der grupper av brukere bare har tilgang til et delsett av programmets fulle funksjonalitet, kan det utarbeides en brukerveiledning for hver gruppe. Et eksempel på denne tilnærmingen er Autodesk Topobase 2010 Hjelp dokumentet, som inneholder separate Administrator Guides , bruker Guides , og en utvikler Guide .

Se også

Referanser