Så här skapar du en bruksanvisning

Användarhandböckerna är fysiskt skrivna guider (på papper) eller elektroniska dokument (PDF eller XPS) som innehåller instruktioner om hur man gör eller använder något. Även "användare" guider är oftast betraktas som relaterade till programvara är användarmanualer förknippas också datorer eller annan elektronisk utrustning såsom TV, stereo, telefoner och mp3-spelare, samt apparater och utrustning från trädgården. En bra användarhandbok informerar användarna om produktens funktionalitet, och undervisar också de olika operationerna i ett effektivt och enkelt samråd. Följande är de faktorer som ska beaktas vid skapandet av effektivt innehåll och utformningen av en användarmanual.

Del 1

Skapa en dokumentation som är lämplig för användaren

Definiera referensanvändaren. För att skriva en lyckad manuell måste du göra en profil för din användare, antingen formell, skapa en skriftlig eller informell profil, ta tid att göra rimliga antaganden om användarens egenskaper. En sådan profil är användbar när du ingår i en lagskrivningsdokumentation för användaren och kan också vara användbar i processen som tar produkten från idéen till den slutliga formen. När du skriver en användarprofil innefattar de faktorer som ska övervägas:

Där användarna kommer att använda handboken, hemma, på kontoret, på en avlägsen arbetsplats eller i bilen. Detta kan inte bara påverka innehållet utan även stilen i manualen.
Hur användarna ska använda guiden. Om du bara behöver sällan läsa handboken eller leta efter information, ska det framför allt ha formen av ett samrådsdokument. Om det är något som först kommer att konsulteras av användarna, bör samrådssektionen åtföljas av avsnittet "Komma igång" och anvisningar om de vanligaste användningarna av produkten.
Hur mycket erfarenhet har användarna redan med produkten eller andra i samma kategori. Om din produkt är ny eller har väsentliga skillnader jämfört med liknande produkter, måste du inkludera en förklaring av dessa skillnader samt instruktioner om hur du börjar använda det. Om produkten adresserar något som användarna ofta har problem med, liksom många datorprogram, måste du tillhandahålla lämplig information och detaljer i en förståelig stil.

Adressa dina användares behov så att de kan förstå. Om användaren inte har teknisk erfarenhet kommer det troligen att vara bättre att undvika specifika terminologier, och föredrar tydliga och enkla förklaringar. Texten bör också organiseras för att vädja till resonemanget av användare-listan egenskaperna hos produkten gruppera dem efter deras funktioner ofta är mer förnuftigt i listorna över de vanligaste kommandona.

Ibland finns det inget sätt att komma runt tekniska termer, till exempel för en kartläggningsprogram som innehåller Fibonacci-tabeller tillsammans med vanligare pie och stapeldiagram. I liknande fall är det användbart att definiera termen och ge en förklaring, till exempel genom att undersöka definitionen och användbarheten i den finansiella analysen av Fibonacci-tabellerna.

Förklara det problem som användaren försöker lösa och presentera lösningen. Att tillhandahålla den enda lösningen på ett generiskt problem fungerar i produktens försäljningsfas, men när användaren har köpt den måste han förstå hur man använder det på bästa sätt. Identifiera specifika problem där du kommer att stöta på användaren, ange dem i användarhandboken och gå till instruktionerna för att lösa dem.

Om problemet är ett av de komplexa, bryt ner det i mindre delar. Lista varje del med instruktioner om hur man löser det eller hanterar det, och ordna dem i följd. Detta förfarande är känt som "chunking" (Hackning).

Del 2

Element av en användarmanual

Inkludera lämplig omslagssida och titelsidor. Du behöver ett omslag för varje användarhandledning, som består av mer än bara ett referenskort och omslagssidor för handböcker längre än ett veckat pappersark (4 eller flera sidor långa).

Om handboken är skyddad av upphovsrätten måste den anges både på omslaget och på titelsidan.
Om du måste anmäla användarvillkoren för användningen av handboken och dess produkt måste du ange dem på insidan av locket.

Ange referenser till relaterade dokument i introduktionen. Om användardokumentationen omfattar mer än en volym, ange referenser till andra dokument här med de korrekta versionerna. Introduktionen är också den del där du ska infoga avsnittet "Hur man använder den här guiden", om det behövs.

Inkludera ett index, om manuell överstiger 10 sidor.

Sätt instruktionerna / metoderna och referensmaterialet i handbokens centrala del. I många fall bör referensmetoderna och materialen ha en egen sektion, men du kan alltid berätta för användaren att hänvisa till specifikt innehåll från ett avsnitt till ett annat. På så sätt kan användaren hitta informationen han söker efter snabbare.

Metoderna ska skrivas konsekvent längs instruktionsdelen i handboken. Börja med en översikt över uppgiften och beskriv sedan vad användaren behöver göra och vilka resultat han ska uppnå. Steg bör numreras och börja med åtgärdsverken, liksom steg i varje avsnitt i denna artikel.

Referensmaterial kan innehålla en lista med alternativ, förslag och vanliga frågor. Ordlistor och bilagor kan läggas till i slutet av handboken, även om en lista över de mest använda termerna kan visas i början. Indexet kan utelämnas om manuell har mindre än 20 sidor.

Använd grafik om du behöver stödja texten. Grafik, eller skärmdumpar, kan illustrera vissa punkter i handboken bättre än texten, särskilt inom komplexa förfaranden där användaren behöver en visuell bekräftelse på korrektheten av utförandet. Grafiken kan produceras med hjälp av CAD eller grafikprogram, digital redigering och digitalkameror, eller i fallet med skärmar med hjälp av den inbyggda funktionen på datorn ( "stämpel" / cmd + shift + 3) eller ett grafikprogram som ger skärmregistreringsalternativet.

När grafiken har skapats, spara den i komprimerat format så att det kan användas skriftligt eller publicera program. Du kommer också vill minska filstorleken för att underlätta införandet på sidan utan minskar Användarinformation (vid behov kan du behöva bryta ner den ursprungliga bilden och visa relevanta delar som du framsteg med texten).

Om du använder en mängd olika grafik i metoderna, behåll konsistensen i måtten, som är lika långa och bredda eller alltid reducerade med samma proportion i förhållande till deras ursprungliga format. Detta kommer att göra bilderna mer tilltalande för användaren. På samma sätt, när du sparar skärmdumpar på en dator, kontrollera att datorn är inställd på standardfärgning under det här steget, om manuell behåller dessa färger.

Även om grafikprogram som Photoshop och Paint Shop Pro erbjuder bra skärmsläckningsmöjligheter, kan även specifika program som SnagIt du enkelt redigera, katalogera och rätta skärmar.

Del 3

Utforma en läsbar handbok

Välj ett par läsbara teckensnitt. Även om datorer kan stödja många olika teckensnitt är målet med en användarmanual lätt läsbarhet. Valet av några bra matchade teckensnitt är det bästa sättet att uppnå detta mål. Det finns 2 typsnittskategorier: "serif" och "sans serif" (med eller utan tack).

Serif typsnitt har små uppsägningar i slutet av huvudlinjerna i bokstäverna. Seriffonter inkluderar Times New Roman, Baskerville och Book Antiqua. Serifs fungerar bäst i stora 10-12 textblock i den centrala delen av en tryckt bruksanvisning.
Sans serif typsnitt visar endast de egenskaper som bildar bokstäverna utan uppsägning. Sans serif inkluderar Arial, Calibri och Century Gothic. Dessa teckensnitt kan användas för stora textblock från storlek 8-10 i en onlinehandbok eller PDF, trots bristen på uppsägningar gör de 12 + stora fraserna svårare att läsa. De kan dock användas effektivt till större dimensioner för att visa titlar och titlar, och är lika lämpliga i mindre format för sidfot och nummer i kolumner eller tabeller.
Du bör i allmänhet välja neutral typsnitt som Arial eller Times New Roman din användarmanual, eftersom det är bättre att luta sig mot ett dekorativt typsnitt vid citat eller titlar, om du skriver till exempel för ett tv-spel med en science fiction eller fantasy inställningar (i Om det gäller extrakt från samma text, kan du ofta använda samma teckensnitt, i "kursiv" format).
När du väl har valt de teckensnitt du ska använda skapar du en testsida för att verifiera att teckensnittet passar ihop på papper. Det kommer också att vara lämpligt att visa detta bevis för alla som måste godkänna handbokens utseende innan de fortsätter.

Tänk på layouten. När du väl har valt typsnittet i din bruksanvisning måste du bestämma placeringen av de olika elementen på sidorna.

I allmänhet vill du placera manuell eller kapitel titel i rubriken eller längst ner på sidan, eventuellt med hjälp av manuell titel på vänster sida och kapitletitel på höger sida. Sidnumren ska vara över eller under, mot utsidan (sidhuvud eller sidfot) eller i mitten (endast sidfot). Du kanske vill skilja den första sidan i varje avsnitt eller kapitel från de andra genom att placera sitt sidnummer i mitten och nästa i det yttre hörnet av rubriken.

Du kanske vill återkalla delar av texten i färgade eller skuggade rutor för att skilja dem från resten av texten. Se till att du väljer en färg eller grad av skuggning som inte överlappar texten.

Lämnar rimligt breda marginaler på alla sidor, med tillräckligt med utrymme på kanterna som kommer att vara bundna till varandra.

Tänk på bindningstypen i användarhandboken. Om din handbok har mer än 4 sidor måste de vara bundna på något sätt. Även om interna dokument kan förenas med ett pappersklipp i ett hörn, är de externa handböckerna som levereras med produkten vanligtvis bundna på något av följande sätt:

Sidoklämmorna är lämpliga för handböcker av vikta pappersark 21x27,5cm, 21x35cm eller 27,5x42,5cm. De flesta av de ekonomiska handböckerna med mindre än 48 sidor är bundna på detta sätt.

Sidosømmen används oftast för externa referensguider i stället för användarhandböcker som är fästa vid andra produkter än bilar, även om några längre guider är bundna på detta sätt (Paint Shop Pro levererades initialt med en bunden sömledare, när den producerades av JASC Software).

Spiralbindningen är lämplig för användning av guider som är konstruerade för att vara robustare, till exempel för utomhusmiljöer, där häftade eller stygna handböcker inte skulle klara sig. Vissa spiralbundna handböcker kan även innehålla laminerade sidor för att förhindra att de förstörs i kontakt med vatten eller lera.

Bygg en modell för din manual. Många skrivnings- och publiceringsprogram erbjuder möjligheten att skapa ett malldokument för din användarmanual, så att texten automatiskt visas i önskat teckensnitt i den manuella delen du arbetar med (den här artikeln i själva verket var det ursprungligen skrivet med en modell av MS Word). Många av dessa program innehåller också en uppsättning förinställda mallar som du kan modifiera enligt dina behov, istället för att skapa en modell från början.

Skrivnings- och publiceringsprogram tillåter dig också att skapa "stilar", förinställda teckensnitt och dimensioner för rubriker, sidfot, titlar och textkroppar. Du kan välja en av de fördefinierade formaten (som "Heading1", "normal", "citat") eller skapa din egen stil med sitt namn. Följ så långt som möjligt konventionerna för namn på institutionella stilar om du har flera stilar för samma del av texten (till exempel, MS Word-etikettformat för rubriker som "Heading1", "Heading2", etc. med titlar, från den främsta till de olika textnivåerna). Försök att skapa alla stilar du behöver i förväg så att du inte behöver sluta skapa dem under den faktiska skrivprocessen.

tips

Använd så gott som möjligt koder och textvariabler. Du kan tilldela värden som namn på en produkt, titeln på en manual eller ett kapitel och placera dem i dokumentet istället för att skriva den faktiska texten. När du förhandsgranskar eller skriver ut ett dokument kommer texten att ersätta variabeln. Om produktets namn ändras eller om du ändrar namnet på manualen eller ett kapitel, blir det lättare att ändra informationen genom att ersätta textvariablernas värde istället för att söka efter det och ersätta det i dokumentet.

Saker du behöver

Program för skrivning eller publicering
Grafiskt program eller visuell inspelning

Visa mer ... (3)

Dela på sociala nätverk:

Relaterade