Uansett hvor genial oppfinneren, programmereren eller rasjonalisereren kan være, noen ganger kan hans kreasjoner rett og slett ikke brukes til det tiltenkte formålet. Årsaken til dette er feil utarbeidet bruksanvisning eller fullstendig fravær. Men selv geniale oppfinnere skriver noen ganger slike instruksjoner at, bortsett fra smale spesialister, kan ingen lese disse papirene. Så hvordan tegner du riktig et slikt nødvendig dokument?
Det er nødvendig
- - hundre prosent kunnskap om enheten eller programvareproduktet som manualen skrives for;
- - kunnskap innen lingvistikk;
- - skriveferdigheter.
Bruksanvisning
Trinn 1
En brukerhåndbok eller, med andre ord, en bruksanvisning er et dokument designet for å gi hjelp til å bruke et bestemt system til brukerne. For å lage en brukerhåndbok, må du kjenne det beskrevne systemet hundre prosent, men se på det med øynene til en uvitende student. Anta at en brukerhåndbok er skrevet for et programvareverktøy som ikke har noen analoger ennå. Tenk deg at dette er første gang du bruker dette programmet. Hvor begynner du? Hva er det første du må vite? Organiser denne kunnskapen i kategorier av betydning.
Steg 2
Ved å dele all informasjon om opprettelsen din i grupper, har du laget en plan for å skrive en brukerhåndbok. Begynn å beskrive arbeidet i programmet ditt fra bunnen av, og la de siste vanskelige detaljene være, for eksempel omprogrammeringsfunksjoner eller håndtering av kritiske feil. På dette stadiet bør du ha innholdet i brukerhåndboken klar - en av de nødvendige delene av dette dokumentet.
Trinn 3
Hvis håndboken du lager er ment for bruk i et stort selskap, bør du ta hensyn til bedriftsstandardene som er vedtatt der. I mange russiske selskaper godtas for eksempel ikke brukerhåndbøker uten illustrativ støtte, med andre ord bilder som forklarer hva som er skrevet. I tillegg til innholdet, bør brukerhåndboken inneholde andre obligatoriske deler: - Kommentar, det vil si en forklaring på de generelle målene for håndboken og det beskrevne produktet; - en introduksjon som beskriver dokumentene knyttet til brukerhåndboken og hvordan å bruke håndboken; - seksjoner som forklarer bruken av produktet på forskjellige stadier av bruken, for eksempel første trinn, reparasjon eller vedlikehold; - seksjon med ofte stilte spørsmål og svar på dem; - ordliste eller emneindeks.
Trinn 4
Vanligvis er en teknisk forfatter involvert i opprettelsen av en brukerhåndbok - en person som har all den nødvendige kunnskapen både på språket og i produktet som blir beskrevet. Som teknisk forfatter uten opplæring er det noen få regler å huske på. For det første må du ikke misbruke spesielle vilkår som ikke er forståelige for en vanlig bruker. For det andre må hvert begrep som brukes, være detaljert og forklart. For det tredje må du skrive så tydelig og kortfattet som mulig. Til slutt må en teknisk forfatter kunne se på sin egen tekst gjennom øynene til en vanlig bruker for å se manglene i sin egen tekst.
Trinn 5
Det er bra å teste den ferdige teksten i brukerhåndboken i praksis ved å tilby den til en person som ikke hadde noe med det beskrevne produktet å gjøre. Ved felles innsats er det mulig å eliminere alle manglene og fallgruvene i dokumentet.
