Hur man skriver en manual

Att skriva en bruksanvisning kan verka som en titanisk verksamhet, men det är lättare än du tror! Dessa steg gäller för alla typer av skriftliga instruktioner, från en enkel "Lär dig att applådera" upp till "Hur man bygger en halvledare".

Metod 1

Lär dig om ämnet

Detta är den grundläggande passagen. Det kan verka självklart, men kunskap är nyckeln till att skriva en bra manual. Om du till exempel skriver en manual för en kamera och vet att fokalförhållandet och slutartiden är två separata funktioner och hur de interagerar med varandra, blir det lättare för dig att beskriva den totala effekten av var och en av dessa funktioner.

Prata med experter. Om din roll bara är att skriva handboken och inte experten om ämnet, involvera personer som känner till ämnet och se till att de granskar ditt arbete. Deras råd och deras kunskaper är ovärderliga.

Försök med ett direkt tillvägagångssätt. Om möjligt gör eller använder du den sak du skriver om ger dig åtminstone en uppfattning om vad användaren behöver veta.

Lagen om texter om ämnet. Lär dig de tekniska termerna och bli praktiska om den produkt du skriver om.

Handböcker av liknande produkter visar dig hur andra författare har tagit upp ämnet.

Leta efter likheter mellan manualerna, vilket indikerar funktioner som är gemensamma för flera objekt och tillvägagångssätt som liknar beskrivningen av vissa aspekter.

Läs många branschblad. Ta reda på hur människor använder produkten. De kanske vill ha en funktion som löser ett visst problem, och om din produkt är lösningen måste du markera den.

Metod 2

Planera den manuella layouten

Dela den i sektioner Oavsett om det är ett steg för steg instruktionsblad, eller en manual för en 35mm digital kamera, dela manuell in i sektioner har många fördelar:

Det låter dig koncentrera sig på enskilda delar av hela. Ditt mål är att få användaren att förstå hur man lär sig processen. Hur man använder funktionerna kan behandlas i en guide i slutet, om du vill, eller du kan låta användaren veta.

Följ en logisk tråd. Det skulle till exempel inte vara lämpligt att beskriva hur kamerans blixt fungerar innan du visar hur du sätter i linsen, laddar kamerans rulle, slår på kameran och justerar fokusen. Detta hjälper dig speciellt om du inte känner till ämnet du har att göra med.

Använd denna division som en mall för ditt index.

Kontrollera dina steg. När du har definierat de logiska sektionerna, kolla på dem för att se till att du har täckt alla ämnen.

Få vad du behöver. Håll föremålen som du beskriver handy och försök använda dem enligt beskrivningen i handboken. Om du bygger en låda papper får du lite papper, några saxar, tejp, lim och linjal. Om du skriver på en kamera, demontera den innan du börjar.

Metod 3

Börja skriva

Skriv introduktionen. Detta markerar tonen i hela handboken och ger användaren en uppfattning om vilken typ av manual de ska läsa. Kommer det vara lätt och roligt, eller direkt och utan krusiduller? Du måste göra detta val enligt dina läsare. Det finns mycket mer utrymme för ordspel och roliga fraser när du måste lära barn att göra en låda papper, jämfört med att du behöver lära en kirurg hur man utför en operation i det öppna. Bestäm tonen från början och följ den genom hela handboken.

Utför varje steg som du skriver. Detta kommer att göra dina ord uppriktiga och autentiska, och du kommer att se till att du inte saknar något.

Om det av någon anledning inte är praktiskt att göra stegen, försök att föreställa dem i detalj och fråga en expert för råd.

Numrera stegen. Detta gör det lättare för läsaren att följa handboken och återupptäck tecknet om de bestämmer sig för att sluta läsa.

Om du skriver om cara, var noga med att lämna extra utrymme mellan stegen. Kom ihåg att korrigera numreringen av stegen om du lägger till nya.

Inkludera tips och varningar. Medan du skriver kan du inse att om en användare gör ett steg utan försiktighet kan det orsaka problem.

Tvärtom, om du tänker på några råd som kan göra användarens uppgift enklare eller mer intressant, lägg till den.

Prova det i första personen. Använd bara dina skriftliga instruktioner, gör det du skriver till. Om du upptäcker att vissa delar av dina instruktioner inte är kompletta, lägg till nödvändig information. Upprepa detta steg tills du kan slutföra användningen eller åtgärden utan att behöva lägga till anteckningar.

Låt din vän prova handboken. Titta på dem noggrant när de lär sig hur man använder produkten. Observera var de går utan problem, och kontrollera om de är förlorade, förvirrade eller misslyckas med att slutföra en passage. Lyssna på deras råd och korrigera sedan din bruksanvisning.

Granska din manual. Skicka inte en kopia full av pinsamma fel till din arbetsgivare.

Metod 4

format

Börja från högsta nivå. När du har skrivit alla nödvändiga steg, läs din handbok för att bestämma var du ska dela avdelningarna.

Ge varje avsnitt en titel och notera deras position.

Skriv indexet, om möjligt. Titta på hur wikiHow beställs som ett exempel. Huvudsidan erbjuder många avsnittstitlar. När du kommer åt en sektion hittar du en lista med många underkategorier, och i underkategorierna hittar du artiklarna. Ju mer detaljerad din handbok är, ju fler kategorier och underkategorier du behöver. Hur man visslar behöver ingen kategori, Hur man huggar en visselpipa, och hur man spelar flöjt för många!

Granska ditt jobb igen. Självklart har du redan gjort det, men upprepa det en gång till kommer att låta dig korrigera några mindre fel eller förtydliga några förklaringar.

För en mycket detaljerad handbok kan du använda denna möjlighet att kommentera alla underkategorier och ange dem i indexet.

Välj en titel.

tips

Om du skriver en mycket detaljerad handbok som kräver flera kapitel, till exempel, "Hur man spelar flöjten", det första steget kan vara att göra en lista med kapitel. I det aktuella exemplet "Välj en flöjt", "Montering och underhåll","Produktion av anteckningarna","Fingrar metoder","Din första sång", etc. Använd sedan de regler som presenteras för att skriva en manual för varje kapitel, eftersom det i själva verket är en liten manual till sig själv.
Även om något verkar uppenbart för dig, skriv alla nödvändiga steg! Det hjälper dig att inte glömma något som din användare inte vet. Bättre att lägga till lite information för mycket än att lämna en viktig passage.
När det är möjligt, lägg till bilder till dina instruktioner! Om du inte kan infoga bilder kan du citera några vanliga exempel. Till exempel i avsnittet "format" av dessa instruktioner användes wikiHows huvudsida som en mall att följa för att göra ett index.
Om du kan, ha din manual testad för en nybörjare och skriv ner varje fråga du frågar! Detta hjälper dig att slutföra handboken och göra den mycket mer användbar.
Att skriva varje avsnitt på en separat sida (eller på en dator) gör det enklare för dig att redigera handboken. Det blir enklare att omorganisera ditt arbete och hitta dina korrigeringar. På datorn lämnar du 3 eller 4 tomma linjer mellan pass, för att enkelt hitta brytpunkterna.

Dela på sociala nätverk:

Relaterade