Hur man skriver en träningshandbok

En träningsmanual är en instruktionsbok. Det är utformat för att ge en översikt över ett ämne innan du går på kurs eller att erbjuda ett spår att följa under en utbildning. Följ dessa steg för att skriva en träningshandbok.

steg

Känn din publik. Lär dig om kunskapsnivå och erfarenhet hos användarna med avseende på den produkt, system eller tjänst som adresseras av manualen.

Använd enkelt språk och ge omfattande information för de grupper som är på grundnivå. Nya användare behöver inte bara förstå produkten, de måste också lära sig hur man använder den.
Använd en mer specifik och fördjupad terminologi för de grupper som redan är bekanta med produkten / systemet. De behöver bara veta de nya ytterligare funktionerna.

Bildnamn Skriv ett träningshandbok Steg 2

Skriv ett sammanfattningsschema. Det hjälper dig att organisera information. Du kommer också att kunna kontrollera att alla nödvändiga argument är angivna.

Bildnamn Skriv ett träningshandbok Steg 3

Börja med orientering. Beskriv bolaget eller träningsinstitutet. Det skisserar företagets struktur med roller och ansvar. Lista dem eller använd nyckelord I allmänhet bör du inte anta att läsaren känner till ämnet och försöker vara mycket tydligt om de punkter du beskriver.

Håll det kort. Läs om och eliminera alla onödiga tillägg.

Bildnamn Skriv en träningshandbok Steg 4

Dela upp lektionerna i kapitel. Börja varje kapitel med en översikt över den information som kommer att presenteras på följande sidor. Använd rubriker för att organisera information i mindre avsnitt inom varje kapitel.

Börja varje steg med ett åtgärdsord.

Var kort och exakt. Kommunicera all kontextuell information i separata anteckningar för att sammanställa riktningarna och hjälpa användarna att följa processen från början till slut.

Varnar användarna om något annat sätt att utföra de beskrivna procedurerna. Om det finns mer än ett sätt att slutföra åtgärden, ange det i handboken.

Om det behövs, inkludera skärmar. Skärmbilderna ger visuell hjälp för att slutföra textinstruktionerna.

Bildnamn Skriv en träningshandbok Steg 5

Komponera de sammanfattande sektionerna. Skriv en kort översikt över huvudinformationen i varje avsnitt. Använd snabba referenstabeller för all information som ofta kan användas av användare (kombinationer av nycklar eller definitioner).

Ange en sammanfattning av lektionen i slutet av varje kapitel. Skapa ett avsnitt av bilaga eller referens i slutet av manualen för att inkludera alla synteser av de olika lektionerna.

Bildnamn Skriv en träningshandbok Steg 6

Testa det. Välj en grupp användare med samma egenskaper som de personer som ska använda träningshandboken. Ge feedback om läsbarhet, förbättringsområden och de avsnitt som behöver ytterligare analys eller ej.

Bildnamn Skriv en träningshandbok Steg 7

Redigera handboken. Använd feedbacken från provet av personer som har testat det för att kunna göra ändringar i innehållet eller strukturen i handboken.

Skicka handboken till din redaktionsavdelning eller en kollega. Gör det igen för grammatik och skiljetecken.

tips

Inkludera en feedbackformulär i träningshandboken. Användarna kan sedan skicka förslag efter att ha följt kursen eller när systemet eller produkten som dokumenteras i handboken ändras.

Dela på sociala nätverk:

Relaterade