en användarmanual eller användarhandbok är ett tekniskt kommunikationsdokument som är utformat för att utbilda användare på en viss produkt. Producerad i tryck eller digitalt kan de skrivas om nästan vilken produkt som helst, men är vanligast med datorprogramvara och hårdvara, elektroniska enheter och videospel.
vanligtvis skriven av tekniska skribenter eller produktdesigners, är dess syfte att informera användare och hjälpa dem att lösa eventuella problem som hänför sig till produkten. Som en viktig del av produktdistributionen kan kvaliteten på din manual starkt påverka den övergripande kundupplevelsen, varför du vill få det rätt!
i den här artikeln delar jag tips om hur man skriver en användarmanual som förmedlar information till dina kunder tydligt och visar hur du kan organisera det skrivprocessen i Zenkit.
Tips för att skriva en användarmanual
det finns mycket som går till att skriva en användarmanual. Från funktionsbeskrivningar, till reparationsinstruktioner, till alla juridiska detaljer och säkerhetsvarningar. Här är några tips att tänka på när det gäller att skriva det:
- Känn ditt mål
varje användarmanual ska ha ett syfte. Vanligtvis är det för att hjälpa användare att lösa problem som rör din produkt, men med det bör du också bestämma hur du vill hjälpa dem. När du har bestämt dig för den vinkel du vill ta, dela upp informationen i sektioner och steg-för-steg-instruktioner som är enkla att följa.
- Bestäm användaren
det är absolut nödvändigt att veta vilken typ av publik som läser din användarmanual eftersom den påverkar hur du skriver den. Att känna till din genomsnittliga användare kan ge dig en uppfattning om vilket språk du ska använda när du skriver användarmanualen, formatet och den övergripande stilen. Att skriva för tekniskt kunniga IT-specialister kommer till exempel att vara väldigt annorlunda än att skriva för föräldrar med unga familjer.
- använd tillgängligt språk
oavsett vem din publik är, bör språket i användarmanualtexten vara tillgängligt för även den mest icke-tekniska personen. Du måste anta att läsaren har noll kunskap om din produkt, så det bör vara begriplig, tydlig och koncis. Det bör adressera läsaren och användningen av jargong bör begränsas.
- gör det visuellt
människor är kända för att bearbeta visuella data 60 000 gånger snabbare än text, varför du vill att din användarmanual ska inkludera bilder. Användarmanualer innehåller nästan alltid relevanta bilder med texten. Vissa produkter delar till och med skärmdumpbilder av steg-för-steg-instruktioner eller är bara rent bilder (IKEA-manualer är berömda textfria). Bilder kan verkligen hjälpa till att förmedla det budskap du vill kommunicera till din läsare.
- förbättra sökbarheten
inse det, ingen kommer att läsa hela användarhandboken, så för läsare att hitta värde i det, du måste göra det enkelt nog för människor att skumma igenom och hitta vad de letar efter. Ge det ett rent format genom att ha en konsekvent layout från sida till sida och se till att det finns mycket utrymme mellan bitar av text. Använd välbekanta nyckelord relaterade till produkten och se till att teckensnittet är enkelt och läsbart.
hur du planerar din användarmanual
Zenkit är ett bra verktyg för att planera en användarmanual. Projekthanteringsverktyget är packat med funktioner som gör att du kan samla in data och sedan strukturera det för att skapa ett optimerat arbetsflöde. Här är stegen för att organisera din användarmanual skrivprocess.
Steg 1:
registrera dig för ett gratis Zenkit-konto och logga in.
steg 2:
när du har anpassat din profil klickar du på ”ny samling”, ger din samling ett namn och trycker på enter eller ”skapa”. Du kommer att dirigeras till standard Kanban-vyn.
du kan ge din samling en liten karaktär genom att anpassa en ikon för den. För att göra detta, klicka på samlingstiteln, valet ”anpassning” och välj de färger och ikonlogotyp du vill ha.
jag är personligen ett fan av att använda en Kanban styrelse för att visuellt kartlägga en projektplan. Det visuella schemaläggningssystemet är utmärkt för att identifiera flaskhalsar och problem som kan uppstå under planeringsprocessen. Det kan också ge dig en kristallklar översikt över hur ditt projekt fortskrider.
i Kanban-vyn visas tre standardkolumner märkta som”att göra, pågår och gjort”. Du kan byta namn på kolumnerna genom att helt enkelt klicka på ett av etikettnamnen och gå till avsnittet Namn i menyrutan som visas. För att lägga till fler steg i ditt arbetsflöde behöver du bara klicka på ”+ Lägg till steg”, ge kolumnen en etikett och antingen klicka på ”Skapa” eller tryck på enter.
naturligtvis kan du välja så många steg som du vill för ditt arbetsflöde och märka dem vad du tycker passar. Stegen jag gick för är följande:
- Info & resurser
- Feedback & instruktioner
- avsnitt
- utkast
steg 3:
när strukturen i ditt arbetsflöde har fastställts kan du börja lägga till andra element som objekt under varje kolumn.
som jag nämnde i början av den här artikeln innebär ett projekt som att skriva en användarmanual mycket innehåll; innehåll som måste delas upp i olika kapitel och avsnitt och avsnitt av avsnitt.
Zenkits subitems är den perfekta funktionen för att bryta ner större uppgifter i mindre. Ett av våra projekthanteringsverktygs 12 anpassade fält, det presenterar alla dina objekt på ett strukturerat sätt så att du kan arbeta med en hanterbar tidslinje.
för att lägga till ett underobjekt till ett av dina objekt, klicka bara på objektet för att öppna det. Klicka sedan på ” + ”- tecknet som ligger ovanför kommentarsektionen och välj sedan ”anpassat fält”. Under avsnittet” Typ ”bläddrar du ner och väljer fältet” underobjekt”. Glöm inte att ge fältet ett namn!
steg 4:
för att lägga till ytterligare struktur i ditt arbetsflöde kan du använda Zenkits hierarkivy. För att aktivera den här vyn i din samling, klicka på ”Kanban” (eller namnet på vilken vy du råkar vara i) som du hittar i det övre högra hörnet och välj ”ny vy”. En menyförlängning ska dyka upp och helt enkelt välja ”hierarki”.
Steg 5:
när du först använder hierarkivyn kommer du att upptäcka att dina objekt inte är kopplade. Du kan ansluta dem genom att dra och släppa varje objekt på huvudhierarkipanelen. Om du drar ett överordnat objekt kommer du att upptäcka att underobjekten kommer att följa med det.
hierarkin som tilldelas ett objekt beror på var du placerar det. Till exempel, objekt dras till toppen kommer att ha en nivå ett hierarki och objekt som dras under en annan kommer att förvandlas till en underobjekt av objektet.
hierarkivyn visar varje enskilt objekt som du har lagt till i hierarkin för dina objekt genom att använda indragningar för att ange när ett objekt blir ett underobjekt. Du kan bara få en översikt över de bästa uppgifterna eller se allt i ditt projekt på en gång genom att kollapsa eller öppna objekten.
planera andra typer av textdokument och material
precis som att planera en användarmanual kan Zenkit användas för att planera andra texttunga dokument eller material. Hierarkivyn och subitemfunktionen är perfekta för att planera alla projekt som kräver att man organiserar en stor mängd innehåll som måste delas upp i olika sektioner, till exempel en roman eller en högskoleuppsats.
Novel writing plan
att skriva en roman kan ta år att slutföra, varför det är bra att ha någonstans att notera allt. Med en liknande mall som användarhandboken kan du strukturera ditt nya kapitel för kapitel och hålla reda på alla tecken -, plot-och temadetaljer i en plattform.
avhandling / avhandlingsplan
från ämnesideer till forskning för att samla in data, skriva en avhandling eller avhandling kräver mycket planering. Genom att använda Zenkit för att hantera allt kan det hjälpa dig att få din avhandling klar i tid och se till att du inte kommer att förbise något viktigt!
Klicka här för att använda vår Avhandlingsplaneringsmall.
en bra användarmanual kommunicerar information tydligt till läsaren så att de kan övervinna eventuella problem som kan uppstå med produkten. Att använda Zenkit för att planera skrivprocessen och dra nytta av hierarkivyn och subitemfunktionen kan hjälpa dig att producera en kvalitetsmanual som kan ge dina kunder bästa möjliga upplevelse.
vilken var den senaste användarmanualen som du tyckte var till hjälp?
skål,
Dinnie och Zenkit-teamet