Sådan skriver du en god brugervejledning til næsten alt

Indholdsfortegnelse:

Anonim

En gang i tiden fulgte faste brugerhåndbøger nye produkter af enhver art, der giver omfattende instruktioner om, hvordan man lærer alle funktioner og maksimerer din brug. I dag er fabriksleverede brugervejledninger meget mere overskuelige og ofte på flere sprog, hvilket komplicerer din læringskurve. At have en anstændig brugervejledning er en værdifuld vare, og hvis du ved hvordan man skriver en, er dette et talent i stor efterspørgsel. Det er simpelthen et spørgsmål om at mestre nogle få nøgleprincipper.

Elementer du skal bruge

  • Microsoft Word eller andet tekstbehandlingsprogram

  • Indsamling af billedkunst eller digitale fotografier

  • Enkel websideforfattersoftware

Beslut om formatet, om trykte dokumenter, websider, e-mails eller en kombination. Når du først skriver i et format, er det nemt at overføre det til et andet. Nogle mennesker er mere komfortable ved at læse et trykt dokument, de kan holde og fil væk. Andre kan foretrække en URL eller link til et dokument på din hjemmeside.

Vær organiseret, klar og kortfattet. Forvent og forklar ikke kun hvad produktbrugere vil gøre, men også hvad ikke at gøre. Du skal skrive med øje mod begge.

Start i begyndelsen, udfolder kun nødvendige oplysninger på logisk vis. Skriv i aktiv stemme, ikke passiv. Hold din kopi magert, eliminere fremmede ord. Hold det enkelt og metodisk.

Opbrud teksten med billeder, illustrationer eller diagrammer så meget som muligt. At gøre læsere vade gennem endeløs tekst med monstrous afsnit er en sikker måde at miste dem på. Langvarige, komplekse afsnit og sider er okay for tekniske manualer, men uegnede til enkle brugervejledninger. Hold det kort og sødt.

Advarsel læseren, hvad man ikke skal gøre med forskellige intervaller. Dette hjælper med at minimere frustration, når man lærer et nyt produkt eller en applikation.

Giv læserne andre ressourcer, de kan bruge til at supplere din guide.

Tips

  • Skriv i meget enkle termer. Antag ikke noget niveau af viden. Hvad der ligner dig let og vidende til dig, er måske ikke for dine læsere. Brug grafik, billedkunst og fotos af høj kvalitet til at forbedre udseendet af dit dokument og forbedre læsbarheden. Hold afsnit og beskrivelser korte.

Advarsel

Antag aldrig, at læseren er bekendt med produktet. Skriv hver guide som om de aldrig har set en før.