Når du skriver vejledninger, skal du undgå overtalende sprog og vælge en opgavebaseret tilgang. Hold skriften kortfattet og klar, og fokuser på at sætte brugeren i stand til at udføre opgaven med succes.

Følg generelt disse retningslinjer:

Kortfattethed og klarhed

Hold sætningerne korte og forståelige. Brug fælles terminologi, når det er muligt. Undgå at bruge idiomer, slang, jargon, kælenavne, forkortelser og akronymer. Hvis du bruger terminologi, der kan være ny eller forvirrende, skal du klart definere hvert udtryk, når det optræder første gang i vejledningen.

Publikum

Det er vigtigt at kende dit publikum, når du skriver vejledninger, så du medtager alle nødvendige oplysninger og udelukker unødvendige oplysninger. Når du kender din målgruppe, kan du foretage rimelige og velinformerede antagelser baseret på målgruppens sandsynlige baggrund, erfaring og fortrolighed med emnet. Hvis du f.eks. skriver en vejledning til en gruppe ældre borgere på det lokale bibliotek, er det måske ikke sikkert at antage, at de er bekendt med det grundlæggende i at åbne et bestemt softwareprogram. Hvis du derimod skriver instruktioner til en gruppe softwareudviklere i en professionel organisation, kan det være sikkert at antage, at de er bekendt med det grundlæggende i at åbne en bestemt softwareapplikation.

Når du beslutter, hvilke oplysninger der skal medtages og udelukkes fra instruktioner, er det vigtigt at identificere klart, hvem din målgruppe er, og hvad deres sandsynlige færdigheder er med hensyn til emnet for instruktionerne og relaterede baggrundsoplysninger.

Hvis en målgruppe sandsynligvis har en bred vifte af erfaring og viden, der omfatter forskellige niveauer af fortrolighed og ekspertise, kan du bruge forskellige teknikker til at holde hvert sæt instruktioner kortfattet og fokuseret på en enkelt opgave, samtidig med at du stadig giver de nødvendige oplysninger. Du kan f.eks. oprette separate instruktioner for forudsætningsoplysninger og give dit publikum mulighed for hurtigt og nemt at få adgang til de separate instruktioner (via hyperlinks, bilag osv.).

Grafik

Billeder taler mere end ord. Tilføjelse af grafik til at formidle dine tanker kan være mere effektivt end selve ordene. Instruktioner, der er godt illustreret og ledsager dine skriftlige instruktioner, er normalt meget vellykkede. Det tilføjer et ekstra niveau af forståelse og giver læseren mulighed for at skimme eller fejlfinde, hvis der opstår problemer. Billeder tilføjer en ekstra dimension, der gør det muligt for din læser at visualisere slutproduktet. Når du bruger grafik, skal du også være opmærksom på de visuelle elever og tilpasse grafikken.

Og selv om billeder er gode, skal du være forsigtig med ikke at medtage fotografier eller illustrationer, der er forvirrende eller ikke har forbindelse med den egentlige skriftlige vejledning. Hvis du parrer et dårligt billede med dine instruktioner, kan du forårsage stress hos læseren eller skabe forvirring, når han skal forsøge at tyde, hvad du mener.

Og når du tager billeder, skal du også sørge for, at området er godt oplyst, og at billederne er klare og lyse. Mørke eller slørede billeder er ofte vanskelige at følge med i. Sørg for at fotografere motivet i samme retning hver gang for at undgå forvirring, og overvej at bruge et stativ.

Størrelsen er også vigtig, når du bruger billeder i instruktioner. Et billede, der er for lille til at kunne ses, er lige så ubrugeligt som et sløret billede.

For at være effektiv og forståelig skal din tekst og grafik for hvert trin klart korrelere med det pågældende trin i vejledningen.

Formatering

Husk, at læserne rent faktisk skal udføre opgaven, mens de læser med i vejledningen. Du bør derfor ikke bruge hele blokke med små, små, svært tydelige tekststykker. Sørg for at skabe et design og layout til din vejledningsside, der gør det letlæseligt og tilføjer æstetisk kvalitet. Hvis du holder siden enkel, men med et defineret hierarki, vil det hjælpe læseren med at gennemføre trinene i vejledningen.

Når du designer din side, er et solidt hierarki vigtigt for at sikre, at den kan scannes. Brugen af fede overskrifter, kursiv skrift og romertal hjælper læseren til nemt at finde sin plads og bidrager til det overordnede visuelle udseende.

Rækkefølge

Det er vigtigt, at dine instruktioner planlægges i en logisk rækkefølge. Sørg for at angive problemet tydeligt på den første side. Følg dine problemer med et sæt specifikke trin, der beskriver, hvordan du løser det foreslåede problem. Tekniske instruktioner skal flyde i et logisk mønster. Når du f.eks. samler et bord, ville det ikke være godt, hvis du lægger sidste hånd på det, før du har fået alle skruerne på plads. Som tidligere nævnt skal der også være tydelig grafik, hvor det er nødvendigt for at tydeliggøre handlingen. Husk, at et billede siger mere end tusind ord.

Test og verifikation

Vi ved alle, at instruktioner er svære at skrive, og at det nogle gange lyder godt på papiret, men når du rent faktisk forsøger at tage instruktionerne i brug, kan du opdage, at din formulering ikke giver mening for andre. Husk, at det, der kan være almindeligt eller indlysende for dig, kan forbløffe dine læsere, så kend din målgruppe. Ud over at teste din vejledning på dig selv, skal du få en person, der ikke ved noget om dit produkt, til at teste den. Dette kaldes en brugervenlighedsundersøgelse. Tag noter om, hvad der virkede, og hvad der ikke virkede, og revider derefter din vejledning i overensstemmelse hermed. I det lange løb vil det endelige sæt blive mere effektivt, jo flere personer der tester dine instruktioner, jo mere effektivt vil det endelige sæt være.