Tekniske forfattere udarbejder forskellige typer dokumentation, f.eks. brugermanualer, API-dokumentation, “How to”-guides osv. Jeg har skrevet en artikel om, hvordan man skriver en brugermanual, så i dag vil jeg fortælle dig om at oprette en ‘How to’-guide.
Når du får en opgave om at oprette en guide, bør dit første skridt være planlægning. Her er, hvad du bør gøre:
Forstå din målgruppe
Når du begynder at skrive din guide, bør du klart forstå, hvem din målgruppe er. Hvad er deres alder, hvad er deres baggrund og så videre. Dette vil definere stilen i din “How to”-guide på det mest grundlæggende niveau – kompleksiteten af det anvendte sprog, antallet af udtryk og mange andre karakteristika.
Research om processen
Jeg anbefaler, at du læser om andres erfaringer med at skrive “how to”-guides. Det vil hjælpe dig med at få et klart billede af det fremtidige arbejde, og du kan integrere andres fremgangsmåder i din arbejdsproces. Jeg har f.eks. skrevet om Amrute Ranades tekniske skriveproces, du kan læse artiklen her: Du kan læse artiklen ‘Great Technical Writing Process’ her: ‘Great Technical Writing Process’. Så du kan også bruge denne metode til at lette din tekniske skrivning.
Saml nyttige materialer
Hvor du begynder at skrive, skal du indsamle materiale og oplysninger, der kan hjælpe dig med at skrive en ‘how-to’-vejledning. Det kan være yderligere oplysninger om et produkt, andre “how-to”-guides om lignende produkter eller noget andet.
Skriv din “how-to”-guide
Først og fremmest skal du lave en plan – det bliver nemmere at skrive en guide, hvis du visualiserer den. Efter alle disse forberedelser er det på høje tid at begynde at skrive. Mens du laver en guide, bør du huske på følgende tips:
- Skriv på almindeligt engelsk for at tale samme sprog som dine læsere.
- Dit sprog skal altid være kortfattet (f.eks, ‘Vælg indstillingen’ i stedet for ‘Du bør vælge indstillingen’).
- Opret nummererede lister for at strukturere trinene, hvis en bruger skal gennemføre dem
- Føj visuelt indhold som f.eks. fotos, skærmbilleder og diagrammer til.
- Afbryd indholdet i overskriftsafsnit, men skriv dem tydeligt
- Hvis du vil bruge vittigheder, skal du være forsigtig: Folk forstår dig måske ikke
- Føj mini-TOC’er til for at gøre store emner mere læselige.
Det vigtigste tip er følgende – stave- og grammatikfejl er uacceptable i dokumentationen, så tjek din vejledning grundigt. Her er en liste over de bedste gratis grammatikkontroller. Du kan også bede en anden person om at læse korrektur for dig eller læse dine egne trin i omvendt rækkefølge for at være sikker på, at din skrift er klar og enkel. Her er et par andre ressourcer til at skrive god dokumentation:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
Det er selvfølgelig ikke alt, hvad der er at vide om at skrive “How to”-guides, men disse tips er de mest essentielle, efter min mening. Jeg håber, at de kan hjælpe dig.
Godt held og lykke med dine vejledninger!