Hur man skriver en handbok

Lär känna motivet

1. 1
   Detta är nyckeln. Det kan tyckas självklart, men kunskap är nyckeln till att skriva en framgångsrik handbok. Till exempel, om du skriver en kamera manual, att veta att en f-stop och slutartiden är inte bara två separata funktioner-de-men att veta hur de interagerar med varandra kommer att göra det mycket lättare för dig att beskriva varje fungera eftersom det gäller hela.
2. 2
   Prata med experter. Om din roll är helt enkelt att författaren snarare än ämnet expert, engagera kunniga människor genom hela processen och se till att de granska ditt arbete. Deras kunskap och råd är ovärderlig.
3. 3
   Prova ett praktiskt tillvägagångssätt. Om möjligt, gör det du skriver om kommer, åtminstone, ge dig en känsla för vad användaren kommer att vilja lära sig.
4. 4
   Läs på i ämnet. Lär dig att prata tal, och bli insatta i den produkt som du skriver om.
   • Manualer för liknande produkter kommer att visa dig hur andra författare har tacklat frågan. # ** Leta efter likheter mellan de författare, som indikerar både gemensam funktionalitet och gemensamma strategier för att beskriva något.
     • Leta efter skillnader som sticker ut. De kommer sannolikt att vara funktioner som är unika för en viss produkt. Din produkt får eller inte får innehålla dessa funktioner, eller kan ha alternativa sätt att lösa problem som du kan beskriva, öka värdet på din produkt. Medan ditt jobb kan skriva en hur-till, visar kunderna värdet av deras köp är ett bra sätt att uppmuntra dem att fortsätta läsa.
   • Devour facktidningar. Ta reda på hur de människor som använder produkterna arbetar med dem dag-till-dag. De kanske önskar att det fanns en funktion som löste deras särskilda problem, och om din produkt är lösningen, som behöver lyftas fram.

Planera din manual layout

1. 1
   Bryt ner det. Huruvida en enkel steg-för-steg instruktion ark, eller en handbok för en 35mm kamera, bryta ner det i lättsmält bitar har flera fördelar:
   • Det låter dig fokusera på enskilda delar av det hela. Ditt mål är att bekanta användaren med hur man lär sig processen. Hur man utföra funktionen kan lämnas för en tutorial i slutet, om så önskas, eller vänster för användaren att upptäcka på egen hand.
2. 2
   Följ en logisk följd. Det skulle göra något gott, till exempel för att beskriva hur blixten på en kamera fungerar tills du har visat hur man fäster linsen, ladda filmen, slå på kameran och justera fokus. Detta är särskilt användbart om du inte känner till ämnet väl.
3. 3
   Använd detta som din mall för innehållsförteckningen.
4. 4
   Granska dina steg. När du har definierat de logiska avsnitt, granska dem för att se till att allt är täckt.
5. 5
   Samla dina leveranser. Har de objekt som du beskriver å och redo att använda som beskrivs i handboken. Om du gör en pappkartong, har papper, sax, tejp, lim, och en linjal hands. Om du skriver om en kamera, se till att kameran är demonterad. Om möjligt, bör produkten du skriver om att vara tillbaka i rutan på denna punkt.

Börja skriva

1. 1
   Skriv inledningen. Detta kommer att ange tonen för hela handboken, och kommer att ge användaren en idé om vilken typ av manuell de är på väg att smälta. Kommer det att vara lätt och underhållande, eller enkel och no-nonsens? Det beror på din läsekrets. Det finns mycket mer utrymme för verbala barn leka undervisning att göra en pappkartong än det är att undervisa en läkare hur man ska gå vidare med öppen hjärtkirurgi. Upprätta tonen tidigt och hålla den tonen i hela handboken.
2. 2
   Utför varje steg som du skriver. Inte bara detta ger ditt skrivande luften av ärlighet och äkthet, se till att du också ingenting kommer hamna ute.
   • Om du av någon anledning är det inte möjligt att göra stegen, tror dem igenom grundligt och rådfråga någon som är expert.
3. 3
   Antal stegen. Detta gör det lättare för människor att följa med, och att hänvisa till om de förlorar 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 mer i.
4. 4
   Inkludera tips och varningar. Som du skriver, kanske du inser att om användaren utför ett steg slarvigt, kan det orsaka problem.
   • Omvänt, om det finns någon bit av kunskap som kommer att göra användarens arbete lättare eller mer intressant, lägga den i.
5. 5
   Testa det. Med bara din skriftliga instruktioner, göra det du skriver om. Skulle du hitta platser där dina instruktioner saknas, lägga in den nödvändiga informationen. Upprepa detta steg tills du har alla steg och kan göra vad man undervisar utan att behöva lägga till anteckningar.
   • Tänk att ha en vän eller två använd manual. Titta på dem noga när de lär sig hur man använder produkten. Se där de zip genom den. Se där de går vilse, förvirrad, eller misslyckas med uppgiften. Lyssna på vad de har att säga, och sedan justera manuellt därefter.
6. 6
   Korrekturläsa din manual. Du vill inte skicka din slutliga korrekturläsare (vara att din byrå eller din make) en handbok full av uppenbara fel.

Formatera

1. 1
   Börja på den högsta nivån. När du har alla nödvändiga detaljerade steg, gå igenom din manual för att hitta de uppenbara kategorin huvuden.
   • Titel dem, och notera sina platser.
2. 2
   Skriv en innehållsförteckning, om tillämpligt. Titta på det sätt som Google är anlagd som ett exempel. Den viktigaste sidan erbjuder många sektionschefer. När du öppnar ett avsnitt, listar det många underkategorier, och underkategorierna artiklar listan. Ju mer detaljerad din manual är, desto fler kategorier och underkategorier som du behöver. (Behöver ingen, Hur Rista en Whistle behöver ett par, och hur man spela flöjt behöver många!)
3. 3
   Korrekturläsa igen. Ja, du gjorde det ordentligt en gång redan. 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 bara är inte klart.
   • För en mer utförlig manual, kan du också ta tillfället i akt att notera alla de små ämnen, och använda den informationen för att skapa ett index.
4. 4
   Välj en titel.