Tekniska skribenter skapar olika typer av dokumentation, till exempel användarmanualer, API-dokumentation, ”How to”-guider och så vidare. Jag skrev en artikel om hur man skriver en användarmanual, så idag ska jag berätta om hur man skapar en ”How to”-guide.
När du får i uppdrag att skapa en guide bör ditt första steg vara planering. Här är vad du bör göra:
Förstå din målgrupp
När du börjar skriva din guide bör du tydligt förstå vem din målgrupp är. Vilken är deras ålder, vilken är deras bakgrund och så vidare. Detta kommer att definiera stilen på din ”hur man gör”-guide på den mest grundläggande nivån – komplexiteten i språket som används, antalet termer och många andra egenskaper.
Research om processen
Jag rekommenderar att du läser om andras erfarenheter av att skriva ”hur man gör”-guider. Det hjälper dig att få en tydlig bild av det framtida arbetet, och du kan integrera andras tillvägagångssätt i din arbetsprocess. Jag skrev till exempel om Amrute Ranades process för tekniskt skrivande, du kan läsa artikeln här: Du kan läsa den här artikeln: ’Great Technical Writing Process’. Så du kan också använda den här metoden för att underlätta ditt tekniska skrivande.
Samla in användbart material
Innan du börjar skriva, samla in material och information som kan hjälpa dig att skriva en ”hur man gör”-guide. Det kan vara ytterligare information om en produkt, andra ”hur man gör”-guider om liknande produkter eller något annat.
Skriv din ”hur man gör”-guide
Skapa först och främst en plan – det blir lättare att skriva en guide om du visualiserar den. Efter alla dessa förberedelser är det hög tid att börja skriva. När du skapar en guide bör du tänka på följande tips:
- Skriv på enkel engelska för att tala samma språk som dina läsare.
- Ditt språk bör alltid vara kortfattat (t.ex, ”Välj alternativet” i stället för ”Du bör välja alternativet”).
- Skapa numrerade listor för att strukturera stegen om en användare måste slutföra dem
- Lägg till visuellt innehåll som foton, skärmdumpar och diagram.
- Fördela innehållet i rubricerade avsnitt men skriv dem tydligt
- Om du vill använda skämt, var försiktig: folk kanske inte förstår dig
- Lägg till mini-TOC:er för att göra stora ämnen mer lättlästa.
Det viktigaste tipset är följande – stavnings- och grammatikfel är oacceptabla i dokumentationen, så kontrollera din guide noggrant. Här är en lista över de bästa kostnadsfria grammatikcheckarna. Du kan också be någon annan att korrekturläsa åt dig, eller läsa dina egna steg i omvänd ordning för att vara säker på att ditt skrivande är tydligt och enkelt. Här är några andra resurser för att skriva bra dokumentation:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
Självklart är detta inte allt man behöver veta om hur man skriver ”How to”-guider, men de här tipsen är de mest väsentliga, enligt mig. Jag hoppas att de hjälper dig.
God lycka till med dina skrivhandledningar!