Skrive en teknisk træningsvejledning

Som virksomhedsejer kan du opleve, at du skal udvikle en teknisk træningsvejledning til dine medarbejdere eller til dine kunder. Uanset om du vælger at skrive manualen selv, tildele projektet til en af ​​dine kyndige medarbejdere eller outsource skrivningen til en entreprenør, bør udviklingen af ​​manualen følge visse retningslinjer, så den opfylder behovene hos dem, der vil bruge træningsmaterialet .

Identificer din målgruppe

Før nogen af ​​skrivning eller forskning er udført, skal du identificere, hvem der bruger håndbogen. Hvis materialet er til dine kunder, har de brug for instruktioner, der er struktureret mod en startbruger. Hvis du opretter manualen til dine medarbejdere, skal du muligvis inkludere nogle retningslinjer, der er specifikke for din virksomhed, når du skriver materialet. Selvom et bestemt produkt kan have en række funktioner, kan du f.eks. Begrænse dine medarbejdere til en mindre delmængde af dem og indeholde disse begrænsninger i din træningsvejledning.

Bestem dine mål

Når du har udviklet en grundprofil for dit publikum, skal du bestemme, hvad dine mål er at skrive i træningsvejledningen. Generelt giver en teknisk træningsvejledning trinvise instruktioner til brugeren om, hvordan man bruger et produkt. Når du bestemmer målene for din manual, skal du beslutte, om du blot skal give grundlæggende instruktioner eller at gå mere indgående i brugen af ​​produktet. For eksempel kan du måske også medtage yderligere instruktioner til oprettelse af et nyhedsbrev, selvom din software er grundlæggende brug for at skrive bogstaver.

Indarbejde visuelle

Visuelle er nyttige til at lede brugeren gennem de trin, der er forklaret i det skriftlige indhold i din tekniske træningsvejledning. Et rutediagram eller et diagram giver grafiske fremstillinger af trinnene i teksten. Hvor det er relevant, kan fotografier eller tegninger pege brugeren til specifikke egenskaber ved et produkt, der er beskrevet i instruktionerne. For eksempel kan din manual gå brugeren igennem, hvordan du tilslutter en computer til en router. Et billede af det fysiske layout, der viser, hvor forbindelsesledninger er vedhæftede, øger de skriftlige instruktioner.

Skriv klart

Som en ekspert, der skriver den tekniske træningsvejledning, skal du omhyggeligt overveje din ordlyd. Overvej niveauet af viden, målgruppen har, når du skriver. Hvis de har brug for træningsvejledningen, ved de sikkert ikke meget om produktet. De kan heller ikke forstå akronymer eller industri jargon, der kommer naturligt til dig. Forklar hver akronym ved første gangs brug og undgå jargon. Forklar trinene tydeligt i enkle udsagn. Opret kapitler, der er logisk opdelt i separate underemner. Har en tredjepart test instruktionerne for at være sikker på, at oplysningerne er klare og opnår de ønskede resultater.