Hur man skriver en manual?
För att skriva en handbok bryter du ner processen som du försöker beskriva i enkla, smältbara bitar så att läsarna kan följa steg för steg. Se också till att din manual följer en logisk sekvens så att läsarna kan göra allt i ordning utan att behöva hoppa över mellan sektionerna. För att hjälpa till att organisera din handbok, inkludera en innehållsförteckning i början så att läsarna vet exakt var de ska hitta den information de letar efter. För tips om hur du undersöker ämnet i din manual, läs vidare!
(Hur man visslar behöver ingen, Hur man snider en vissling behöver några, och hur man spelar flöjt behöver många!).
Att skriva en bruksanvisning kan verka som en skrämmande uppgift, men det är lättare än du tror! Dessa steg gäller för alla skriftliga instruktioner, från det mycket enkla (Hur man klappar) till det intensivt komplicerade (Hur man bygger en halvledare.)
Del 1 av 4: lära känna ämnet
- 1Detta är nyckeln. Det kan verka självklart, men kunskap är nyckeln till att skriva en framgångsrik manual. Om du till exempel skriver en kamerahandbok, vet du att ett f-stopp och slutartiden inte bara är två separata funktioner - de är - men att veta hur de interagerar med varandra kommer att göra det mycket lättare för dig att beskriva varje funktion som det rör helheten.
- 2Prata med experter. Om din roll bara är författaren snarare än ämnesexperten, involvera kunniga människor under hela processen och se till att de granskar ditt arbete. Deras kunskap och råd är ovärderliga.
- 3Prova ett praktiskt tillvägagångssätt. Om du gör det du skriver om kommer det åtminstone att ge dig en känsla för vad användaren vill lära sig.
- 4Läs upp ämnet. Lär dig att prata samtalet och bli förtrogen med den produkt du skriver om.
- Manualer med liknande produkter visar hur andra författare har tagit sig an ämnet.
- Leta efter likheter bland författarna, vilket indikerar både gemensam funktionalitet och vanliga metoder för att beskriva något.
- Leta efter skillnader som sticker ut. Det är troligtvis funktioner som är unika för en viss produkt. Din produkt kanske eller inte innehåller dessa funktioner, eller kan ha alternativa sätt att lösa problemet som du kan beskriva, vilket förbättrar produktens värde. Även om ditt jobb kan skriva hur man gör, är det ett bra sätt att visa kunderna värdet av deras köp att uppmuntra dem att fortsätta läsa.
- Sluk handelstidningar. Ta reda på hur människorna som använder produkterna arbetar med dem dag till dag. De kanske önskar att det fanns en funktion som löste deras specifika problem, och om din produkt är lösningen måste den markeras.
- Manualer med liknande produkter visar hur andra författare har tagit sig an ämnet.
Hur gör jag en innehållsförteckning för en manual för hur jag äger ditt eget företag?
Del 2 av 4: planera din manuella layout
- 1Bryt ner det. Oavsett om det är ett enkelt steg-för-steg-instruktionsblad eller en manual för en 35 mm digitalkamera, har det flera fördelar att bryta ner det i smältbara bitar:
- Det låter dig fokusera på enskilda delar av helheten. Ditt mål är att bekanta användaren med hur man lär sig processen. Hur man utför funktionen kan lämnas till en tutorial i slutet, om så önskas, eller lämnas för användaren att upptäcka på egen hand.
- 2Följ en logisk sekvens. Det skulle till exempel inte vara bra att beskriva hur blixten på en kamera fungerar tills du har visat hur du monterar linsen, laddar filmen, sätter på kameran och justerar fokus. Detta är särskilt användbart om du inte känner till ämnet väl.
- 3Använd detta som din mall för din innehållsförteckning.
- 4Granska dina steg. När du har definierat de logiska avsnitten, granska dem för att se till att allt är täckt.
- 5Samla dina förnödenheter. Ha föremålen som du beskriver till hands och redo att användas enligt beskrivningen i handboken. Om du gör en papperslåda, ha papper, sax, tejp, lim och en linjal till hands. Om du skriver om en kamera, se till att din kamera är isär. Om möjligt bör produkten du skriver om vara tillbaka i rutan vid denna tidpunkt.
Om du skriver manualen i kronologisk ordning ska du först skriva handboken.
Del 3 av 4: börja skriva
- 1Skriv inledningen. Detta kommer att sätta tonen i hela handboken och ge användaren en uppfattning om vilken typ av manual de håller på att smälta. Kommer det att vara lätt och underhållande, eller rakt och nonsens? Det beror på din läsarkrets. Det finns mycket mer utrymme för verbal lek som lär barn att göra en papperslåda än att lära en läkare hur man går vidare med öppenhjärtkirurgi. Upprätta tonen tidigt och behåll den tonen genom hela manualen.
- 2Utför varje steg medan du skriver. Inte bara ger detta ditt skrivande luften av ärlighet och äkthet, du ser också till att ingenting kommer att utelämnas.
- Om det av någon anledning inte är möjligt att göra stegen, tänka igenom dem noggrant och kontakta någon som är expert.
- 3Numera stegen. Detta gör det lättare för människor att följa med och hänvisa till om de skulle förlora sin plats.
- Om du skriver på papper, se till att lämna utrymme för tillägg mellan varje steg. Kom ihåg att numrera om dina steg om du lägger till mer i.
- 4Inkludera tips och varningar. När du skriver kan du inse att om användaren utför ett steg slarvigt kan det orsaka problem.
- Omvänt, om det finns lite kunskap som gör användarens uppgift enklare eller mer intressant, lägg till den.
- 5Testa det. Använd bara dina skriftliga instruktioner och gör det du skriver om. Om du hittar platser där dina instruktioner saknas, lägg till nödvändig information. Upprepa detta steg tills du har alla steg och kan göra det du undervisar utan att behöva lägga till anteckningar.
- Överväg att få en vän eller två använda handboken. Titta noga på dem när de lär sig hur man använder produkten. Se var de går igenom den. Se var de går vilse, förvirrade eller misslyckas med uppgiften. Lyssna på vad de har att säga och justera sedan din manual.
- 6Korrekturläsa din handbok. Du vill inte skicka din slutgiltiga korrekturläsare (vare sig din byrå eller din make) en handbok full av uppenbara fel.
Del 4 av 4: formatering
- 1Börja på toppnivå. När du har alla nödvändiga steg detaljerade, gå igenom din manual för att hitta de uppenbara kategorihuvudena.
- Titel dem och notera deras platser.
- 2Skriv en innehållsförteckning, om tillämpligt. Titta på hur guiden läggs ut som ett exempel. Den huvudsidan erbjuder många sektionschefer. När du öppnar ett avsnitt listar det många underkategorier och artiklarna i underkategorierna. Ju mer detaljerad din handbok är, desto fler kategorier och underkategorier behöver du. (Hur man visslar behöver ingen, Hur man snider en visselpipa behöver några, och hur man spelar flöjt behöver många!)
- 3Korrektur igen. Ja, du gjorde det grundligt redan en gång. Att göra det en andra gång kommer utan tvekan att fånga några fler mindre fel eller platser där din manual inte är tydlig.
- För en mer omfattande handbok kan du också ta tillfället i akt att notera alla små ämnen och använda den informationen för att skapa ett index.
- 4Välj en titel.
Om du kan, låt en nybörjare göra en testkörning av din manual och skriv ner alla frågor de ställer!
- Även om något verkar självklart för dig, skriv ut stegen! Det hjälper dig att undvika att glänsa över något som din användare inte vet. Det är bättre att lägga in extra information snarare än att utelämna viktiga steg.
- Om du skriver en mycket detaljerad handbok som kräver kapitel, till exempel Hur man spelar flöjt, kan ditt första steg faktiskt vara att lista alla kapitel, som att välja en flöjt, montering och skötsel, tonproduktion, metoder för fingrar, din First Piece, etc. Du skulle sedan tillämpa de grundläggande reglerna för att skriva en manual på varje kapitel eftersom varje kapitel är som en separat manual i sig!
- När det är möjligt, illustrera dina instruktioner! Om du inte kan infoga bilder hänvisar du eleven till något vanligt som ett exempel. Till exempel, i formatering, steg 2 i dessa instruktioner, används utseendet på guideens layout för att illustrera hur en innehållsförteckning kan skapas.
- Att skriva varje avsnitt på en separat sida (eller på en dator) gör det lättare att redigera. Du kan lättare ordna om du har utrymme att arbeta och kan hitta dina redigeringsmärken. På datorn lämnar du 3 eller 4 rader (genom att trycka på Enter flera gånger) mellan varje steg så att du enkelt kan hitta pauserna.
- Om du kan, låt en nybörjare göra en testkörning av din manual och skriv ner alla frågor de ställer! Detta hjälper dig att fylla i tomrummen och göra din handbok mycket mer användbar.
Frågor och svar
- Hur gör jag en innehållsförteckning för en manual för hur jag äger ditt eget företag?Om du skriver manualen i kronologisk ordning ska du först skriva handboken. Gör sedan innehållsförteckningen i ordning efter stegen efter sidnummer.
Läs också:
Ansvarsfriskrivning Innehållet i denna artikel är för din allmänna information och är inte avsedd att ersätta professionell lag eller finansiell rådgivning. Det är inte heller avsett att lita på av användare när de fattar några investeringsbeslut.
