Skriva en teknisk träningshandbok

Som företagsägare kan du upptäcka att du behöver utveckla en teknisk träningsmanual för dina anställda eller för dina kunder. Oavsett om du väljer att skriva manualen själv, tilldela projektet till en av dina kunniga medarbetare, eller lägga ut skrivandet till en entreprenör, bör handledningens utveckling följa vissa riktlinjer så att den tillgodoser behoven hos dem som ska använda träningsmaterialet .

Identifiera din publik

Innan något av skrivandet eller forskningen görs, identifiera vem som ska använda handboken. Om materialet är för dina kunder, behöver de instruktioner som är strukturerade mot en nybörjare. Om du skapar handboken för dina anställda, kan du behöva inkludera några riktlinjer som är specifika för ditt företag när du skriver materialet. Till exempel, även om en viss produkt kan ha en rad funktioner, kan du begränsa dina anställda till en mindre delmängd av dem och inkludera de begränsningarna i din träningshandbok.

Bestäm dina mål

När du har utvecklat en grundprofil för din publik, bestämma vad dina mål är att skriva i träningshandboken. I allmänhet ger en teknisk träningshandbok steg för steg instruktioner till användaren om hur man använder en produkt. När du bestämmer målen för din handbok, bestämmer du om du bara ska tillhandahålla grundläggande instruktioner eller att gå mer ingående i användningen av produkten. Till exempel, även om programvarans grundläggande användning kan vara att skriva bokstäver, kanske du också vill ha ytterligare instruktioner för att skapa ett nyhetsbrev.

Införliva visuella

Visuella är användbara för att styra användaren genom de steg som förklaras i det skriftliga innehållet i din tekniska träningshandbok. Ett flödesschema eller ett diagram ger grafiska representationer av stegen i texten. I förekommande fall kan fotografier eller ritningar peka användaren på specifika egenskaper hos en produkt som beskrivs i anvisningarna. Till exempel kan din manual gå till användaren genom att ansluta en dator till en router. En visuell bild av den fysiska layouten som visar där anslutningskabeln bifogas kompletterar de skriftliga instruktionerna.

Skriv klart

Som en expert som skriver den tekniska träningshandboken bör du noggrant överväga din formulering. Tänk på den kunskapsnivå som målgruppen har när du skriver. Om de behöver träningshandboken vet de förmodligen inte mycket om produkten. De kan inte heller förstå akronymer eller branschjargong som kommer naturligt för dig. Förklara varje akronym vid första användningen och undvik jargong. Förklara steg tydligt i enkla uttalanden. Skapa kapitel som är logiskt uppdelade i separata underämnen. Testa ett tredje part instruktionerna för att vara säker på att informationen är klar och uppnår de önskade resultaten.