Sådan opretter du en brugervejledning

Brugermanualer er skrevet vejledninger - som kan stilles til rådighed digitalt eller trykt - der giver vejledning i, hvordan man gør noget eller bruger noget produkt. Selv om udtrykket "brugervejledning" er forbundet med software manualer, ledsager brugervejledninger også computere og andre elektroniske enheder som fjernsyn, radioer, telefoner og mp3-afspillere samt husholdningsapparater og haveudstyr. En god manual uddanner brugerne om produktets funktioner, samtidig med at de lærer dem, hvordan de kan bruges effektivt, har forklaret alt på en enkel måde. Nedenfor finder du ting at overveje, når du opretter en brugervejledning, fra indhold til layout.

indhold

Trin

Del 1oprettelse af den relevante brugerdokumentation
Del 2komponenterne i en brugsanvisning

Video: ballondyr instruktion - sådan laver du en ballonhund

Del 3udformning af en læselig manual

Video: arabisk vejledning til forældre - sådan opretter du et uni-login
Tips
Nødvendige materialer
Video: klassisk julestjerne
Kilder og citater

trin

Del 1
Oprettelse af den relevante brugerdokumentation

Definer hvem brugeren vil være. For at skrive en god manual, skal du udvikle målbrugerprofilen, enten formelt - ved at skabe en skriftlig profil - eller uformelt - ved at tage tid til at identificere egenskaberne hos de sandsynlige brugere af produktet. Denne profil er nyttig, når du er en del af et team, der skriver brugerdokumentation, samt hjælper dig med at tage konceptproduktet til sin endelige form. Når du danner en brugerprofil, skal du tænke på:

Hvor brugerne vil bruge guiden, hvad enten der er hjemme, på kontoret, i et isoleret arbejdsmiljø eller i bilen. Dette kan ikke kun bestemme indholdet, men stilen i manualen.
Hvordan brugerne vil bruge vejledningen. Hvis manuskriptet skal høres for ofte eller kun fungerer som en form for forskning, skal den have form af et referencedokument. Hvis det er noget, som brugerne ofte henviser til fra starten, skal referencereglen ledsages af en "Kom godt i gang" sektion og ved brug af instruktioner om de mest almindelige produktfunktioner.
I den oplevelse, som brugere allerede har med produktet og andre lignende. Hvis dit produkt er nyt eller meget forskelligt fra tilsvarende konkurrenter, skal du forklare forskellene og indeholde instruktioner om, hvordan du kommer i gang. Hvis produktet beskæftiger sig med noget, som brugerne typisk har problemer med, f.eks. Nogle computersoftware, skal du give tilstrækkelig information og detaljer på en forståelig måde.

Billede titel Opret en brugervejledning Trin 2

Skriv ned brugerens behov, så han kan forstå det. Medmindre brugeren har teknisk viden, er det bedst at undgå teknisk sprog, altid vælger enkle og klare forklaringer. Teksten skal organiseres på en måde, der efterligner brugerens tankegang - for eksempel optæller de indstillinger, der er grupperet efter funktion, mere fornuftigt end at notere dem efter brugernes hyppighed.

Ofte er der ingen undslippe de tekniske termer, såsom når man skriver en manual til grafiksoftware, der omfatter Fibonacci-grafik sammen med andre mere almindelige grafikker. I dette tilfælde er det nyttigt at definere vilkårene og give en slags baggrund, som en forklaring på, hvad Fibonacci-diagrammerne er, og hvad deres anvendelser er i finansielle analyser.

Billede titel Opret en brugervejledning Trin 3

Forklar det problem, som brugeren forsøger at løse og præsentere løsningen. At give en mulighed som en løsning på det generelle problem er noget, der virker på produktinformation, men efter køb skal brugeren lære at sætte produktet i brug. Identificer specifikke problemer, som personen står overfor, forklar dem i håndbogen og afslut med vejledningen til at løse dem.

Hvis problemet er komplekst, opdele det i mindre dele. Liste instruktioner og løsninger i rækkefølge. Opdeling af information på denne måde er en metode, der kaldes "fragmentering".

Del 2
Komponenterne i en brugsanvisning

Billede titel Opret en brugervejledning Trin 4

Video: Ballondyr instruktion - Sådan laver du en ballonhund

Inkluder dækningskunst og titelsider. Du skal bruge en omslag til enhver anden håndbog end et simpelt referencekort og en titelside for enhver håndbog, der er mere end et foldet ark papir.

Hvis håndbogen er beskyttet af ophavsret, skal meddelelsen indsættes på forsiden og titelsiderne.
Hvis der er vilkår og betingelser for at bruge manualen og det produkt, der er forbundet med det, skal du placere dem på indersiden af dækslet.

Billede titel Opret en brugervejledning Trin 5

Sæt henvisninger til relaterede dokumenter i forordet. Hvis dokumentationen ikke kun er vejledningen, henvises til de dokumenter, der har de nuværende versioner her. Du vil også indtaste afsnittet "Sådan bruger du denne vejledning", hvis der er en, i forordet.

Billede titel Opret en brugervejledning Trin 6

Inkluder et indeks, hvis manualen har mere end 10 sider.

Billede titel Opret en brugervejledning Trin 7

Anbring instruktioner / procedurer og referencemateriale på manualens krop. I de fleste tilfælde skal disse elementer have egne afdelinger, men du kan instruere læseren til at henvise til specifikt indhold fra et afsnit til et andet i det andet. På den måde kan brugeren finde informationen hurtigere.

Procedurerne skal skrives med en ensartet struktur i instruktionsdelen af manualen. Start med et overblik over opgaven og beskriv derefter hvad brugeren skal gøre og hvad resultatet skal opnås. Trinnene skal nummereres og begynde med handlingsord, samt trinene i afsnittene i denne artikel.
Referencemateriale kan indeholde lister over muligheder, fejlfindingstip og ofte stillede spørgsmål. Ordlister og indekser kan også tilføjes i slutningen af manualen, selvom listen over ofte stillede vilkår normalt vises i begyndelsen. Indekset kan udelades, hvis manualen har mindre end 20 ark.

Billede titel Opret en brugervejledning Trin 8

Brug billeder til support, hvis det er nødvendigt. Billeder kan illustrere nogle ideer bedre end tekster, især når der beskrives komplekse procedurer, hvor brugeren har brug for visuel information for at sikre, at de udfører trinene korrekt. Billeder kan produceres med tegneprogrammer, digitale kameraer og billedredigeringssoftware (som også kan bruges i tilfælde af skærmoptagelse).

Når du har lavet billedet, skal du gemme det i et komprimeret format og accepteres af softwaren, hvor du uddyber manualen. Reducer også din fysiske størrelse, så den passer til sidestørrelsen, men uden at fjerne de nødvendige detaljer for brugeren. Om nødvendigt kan du dele billedet i stykker for at vise de relevante dele ved siden af teksten.
Hvis du bruger flere billeder, skal du standardisere deres størrelse, enten ved at bruge samme længde og bredde eller reducere dem proportionalt til den oprindelige størrelse. Dette vil gøre dem mere attraktive for læseren. Det samme gælder for at skabe skærmbilleder af en computer, hvor det er nødvendigt at standardisere systemets farveskema, så alle efterlader lignende.
Mens redigering af software som Photoshop og Paint Shop Pro tilbyder anstændige screen capture muligheder, har dedikeret software som Snaglt også muligheder for nemt redigering, katalogisering og annotering af billeder.

Del 3
Udformning af en læselig manual

Video: Arabisk vejledning til forældre - Sådan opretter du et UNI-Login

Billede titel Opret en brugervejledning Trin 9

Vælg læsbare skrifttyper. Selvom computere understøtter hundredvis af forskellige skrifttyper, er målet med en brugsanvisning læsbar. At vælge et lille antal matchende skrifttyper er den bedste mulighed for dette. Skrifttyper kan let opdeles i to typer: serif og ikke-serif.

Sprite skrifttyper har små dekorative linjer i slutningen af stregerne, der udgør bogstaverne. Denne type skrifttype fungerer bedst til store tekstblokke i størrelser mellem 10 og 12 i en trykt manual. Eksempler er kilder som Times New Roman, Baskerville og Book Antiqua.
Sans serif skrifttyper har kun de streger, der udgør bogstaverne, uden dekorationer. Disse skrifttyper kan bruges i store tekstblokke i størrelser mellem 8 og 10 i digitale bøger, fordi manglen på serifs gør det svært at læse i størrelser over 12. Disse skrifttyper kan dog bruges i store størrelser i titler og overskrifter, samt at være fantastisk til fodnoter og tal i kolonner og tabeller. Eksempler omfatter skrifttyper som Arial, Calibri og Century Gothic.
Vælg mellem almindelige skrifttyper som Arial eller Time New Roman til manualer, men vælg flere dekorative muligheder for citater og titler, hvis du skriver en manual til et fantasy eller science fiction spil. I tilfælde af citater kan du også beholde standard skrifttype i teksten, men kursivere den.
Når du har defineret de skrifttyper, du vil bruge, skal du oprette en testside for at se, om de passer sammen på papir. Vis testen til den person, der har evnen til at indstille udseendet af manualen, før du fortsætter.

Billedbetegnelse Opret en brugermanual Trin 10

Tænk på layoutet på siden. Efter at have valgt skrifttyper, skal du vælge layoutet af alt, der går på siden.

Generelt skal du sætte titel- eller kapitelnavnet i overskriften eller sidefoden, og du kan sætte titlen på manualen på venstre side og titlen på kapitlet på højre side. Indtast også sidetalene i disse regioner, enten på højre side (i overskriften eller bundsekvensen) eller i midten (kun fodbold). Du kan differentiere den første side i hvert afsnit eller kapitel ved at placere sidenummeret i midten af sidefoden, mens de efterfølgende sider er nummereret i det ydre hjørne af overskriften.
Du kan indtaste callouts i farvede eller skraverede felter for at adskille dem fra resten af teksten. Vælg en farve eller et niveau af skygge, der ikke overlapper teksten.
Lav rimelige margener på alle sider, hvilket giver ekstra plads ved de kanter der bliver bundet.

Billede titel Opret en brugervejledning Trin 11

Overvej den type bindende. Hvis manualen har mere end fire sider, skal de sikres på en eller anden måde. Interne dokumenter kan hæftes i øverste venstre hjørne af siderne, men manualerne, der sendes med produkterne, er normalt bundet af en af nedenstående tre metoder:

Sidestiftningen er velegnet til manualer sammensat af 21 x 27,5 cm, 21 x 35 cm eller 27,5 x 42,5 cm ark. De billigste materialer på 48 sider eller derunder er så hæftede.
Bump hæftning er mere almindelig for referencer til tredjepart end for manualer, der sendes med ikke-automotive produkter, selv om de længere manualer er bundet på denne måde. (Paint Shop Pro blev solgt med en ryggradsstiftet guide, da den blev produceret af JASC Software.)
Spiralen er egnet til hjælpelinjer, der skal bruges udendørs, hvor de andre bindinger kan være for skrøbelige. Nogle af disse manualer har laminerede sider for at forhindre vand eller jordskader.

Billede titel Opret en brugervejledning Trin 12

Opret en skabelon til manualen. Adskillige tekst og redigering behandling software har en funktion til at oprette en skabelon, så du indtaste teksten, og det vises automatisk i den valgte for den del af manualen, som du arbejder skrifttype. (Denne artikel blev oprindeligt skrevet ved hjælp af en Microsoft Word-skabelon.) De fleste af disse programmer har foruddefinerede skabeloner, der kan skræddersyes til dine behov, så det er unødvendigt at oprette en skabelon fra bunden.

Denne software giver dig også mulighed for at oprette "stilarter", præ-definere skrifttyper og størrelser til sidehoveder, sidefødder, overskrifter og brødtekst. Du kan vælge en af de definerede stilarter (såsom "Overskrift 1", "Normal", "Citat") eller oprette din egen stil. Følg stil navngivning konventioner, hvis du har flere klasser pr. Tekst. (For eksempel identificerer Word stilarter for titler som "Titel 1", "Titel 2" osv. For de forskellige undertekstniveauer.) Prøv at oprette alle de stilarter, du vil bruge på forhånd, så du ikke behøver at stoppe og oprette dem under skriveprocessen.

tips

Brug tekstvariabler, hvor det er muligt. Du kan tildele værdier til dem, f.eks. Et produktnavn eller en kapitaltitel, og indsæt dem i dokumentet i stedet for at skrive selve teksten. Når du forhåndsviser eller udskriver manualen, vil teksten tage stedet for variablen. Hvis produktnavnet ændres, bliver det nemmere at ændre det i manualen ved at ændre variablen end ved at søge efter det og manuelt udskifte det i dokumentet.