Hur man skapar en användarmanual

Skapa lämplig användardokumentation

1. 1
   Definiera vem ditt användarnamn är. För att skriva en framgångsrik användarmanual, måste du utveckla en profil för ditt användarnamn, antingen formellt, genom att skapa en skriftlig profil, eller informellt, genom att ta tid att göra rimliga antaganden om din användares egenskaper. En sådan profil är användbart när du är en del av ett team skriva användardokumentation och kan också vara till hjälp i att ta själva produkten från idé till färdig blankett. Saker att tänka på när man bildar en användarprofil inkluderar:
   • Där användarna kommer att använda manualen, som hemma, på kontoret, på en avlägsen arbetsplats, eller i bilen. Detta får bestämma inte bara innehållet, men stilen instruktionsbok tar.
   • Hur användarna ska använda manualen. Om handboken är en de kommer att samråda endast sällan eller söka upp information, bör den ta hand formen av ett referensdokument. Om det är något som användarna kommer att samråda ofta i början, bör hänvisningen avsnitt åtföljas av ett "Komma igång" avsnittet och anvisningar om de vanligaste uppgifterna produkten kommer att användas till.
   • Hur mycket erfarenhet användarna har med produkten eller andra liknande. Om din produkt är ny eller väsentligt skiljer sig från liknande produkter, måste du inkludera en förklaring av hur det skiljer sig från andra produkter samt instruktioner om hur du kommer igång. Om produkten behandlar något som användaren ofta har problem med, till exempel många datorprogram, måste du ge lämplig information och detaljer på ett begripligt sätt.
2. 2
   Skriv till användarnas behov på ett sätt som användaren kan förstå. Om inte användaren har en teknisk bakgrund, är det förmodligen bäst att undvika alltför tekniskt språk till förmån för tydliga och enkla förklaringar. Texten bör också organiseras på ett sätt som efterliknar det sätt användarna tycker, objekt i listan produktegenskaper grupperade efter funktion ofta är mer förnuftigt än bara de som används oftast.
   • Ibland finns det inte att komma runt att använda tekniska termer, som till en graf-skapa program som innehåller Fibonacci diagram tillsammans med mer vanliga paj och stapeldiagram. I ett sådant fall är det användbart att definiera begreppet och ge lite bakgrund, såsom en förklaring av vad Fibonacci diagram är och deras användning i finansiell analys.
3. 3
   Förklara problemet användaren försöker lösa, sedan presentera lösningen på det. Erbjuder en funktion som lösningen på ett generellt problem fungerar bra vid marknadsföringen av produkten, men när användaren har produkten, han eller hon behöver för att räkna ut hur att ta den i bruk. Identifiera specifika problem användaren kommer att möta, ange dem i instruktionsboken, och sedan följa med instruktioner för att lösa dem.
   • Om problemet är en komplex fråga, dela upp det i mindre delar. Lista varje del med instruktioner om hur man ska lösa eller hantera det, och sedan följa med varje efterföljande del i följd. Breaking information nedåt på detta sätt kallas "chunking."

Instruktionsbok komponenter

1. 1
   Inkludera tillhörande lock och sidor titel. Du behöver en frontlucka för någon manual som är mer än en referens-kort och en titelsida för en manual som täcker mer än ett vikt papper (4 eller fler sidor i längd).
   • Om handboken är upphovsrättsskyddat, går ett meddelande om upphovsrätt på både framsidan och titelsidan.
   • Om det finns villkor för användning av manualen och produkten i samband med den, placera dem på insidan av omslaget.
2. 2
   Sätt hänvisningar till relaterade dokument i förordet. Om användaren dokumentationen är mer än 1 manual, hänvisa till de övriga handlingar, med rätt versionsnummer, här. Förordet är också där för att sätta ett "Så här använder du handboken" avsnittet om det finns någon.
3. 3
   Inkludera en innehållsförteckning om handboken överstiger 10 sidor.
4. 4
   Sätt instruktioner / rutiner och referensmaterial i kroppen av handboken. I de flesta fall, förfaranden och referensmaterial bör var och en har sina egna avsnitt, även om du kan tala om för användaren att hänvisa till visst innehåll i ett avsnitt från den andra. På så sätt kan användaren hitta den information han eller hon letar efter snabbare.
   • Rutiner bör skrivas på ett konsekvent struktur i hela instruktionen i handboken. Börja med en översikt av uppgiften, sedan beskriva vad användaren har att göra och vad resultat han eller hon skulle se. Åtgärder bör numreras och börja med handlingsverb, eftersom stegen i varje avsnitt i den här artikeln är skriven.
   • Referensmaterial kan innehålla listor med alternativ, felsökningstips och vanliga frågor. Ordlistor och index kan läggas i slutet av handboken, även om en lista över vanliga termer kan visas längst fram. Indexet kan utelämnas om den manuella kör mindre än 20 sidor.
5. 5
   Använd grafiska bilder som behövs för att stödja texten. Grafiska bilder eller skärmdumpar, kan illustrera vissa punkter i manualen bättre än text, särskilt i komplicerade procedurer där användaren måste ha visuell bekräftelse på att de utför stegen korrekt. Grafiska bilder kan produceras med hjälp av datorstödd utformning (CAD) eller grafiskt redigeringsprogram, digitalkameror och foto-redigeringsprogram, eller i fallet med skärmdumpar, antingen datorns inbyggda skärmbild förmåga eller ett grafikprogram med screen capture kapacitet.
   • När du skapar en grafisk bild, spara den i form av komprimerad ett format som din ordbehandlare eller desktop publishing program ger dig möjlighet att använda. Du kommer också vill minska den fysiska storleken på din bild till något som passar lättare på sidan samtidigt som man tillhandahåller tillräckligt detaljerade för användaren. (Om det behövs, kan du behöva skära den ursprungliga bilden i delar och visar de relevanta delarna tillsammans med stödjande text.)
   • Om du använder flera grafiska bilder i förfarandena, göra dem till en enhetlig storlek, antingen i samma dimensioner av längd och bredd eller i samma proportionella minskning från deras ursprungliga storlek. Detta kommer att göra bilderna mer attraktiv för användaren. Likaså när du skapar skärmdumpar från en dator, se till att datorn visar en standard färgschema när bilder Om bruksanvisningen kommer att visa skärmdumpar i färg.
   • Även grafisk redigering program som Photoshop och Paint Shop Pro erbjuder anständigt skärm kapacitet fånga, dedikerade skärmbild program som SnagIt har även möjlighet att enkelt ändra, katalog, och kommentera fångar skärmen.

Utforma en läsbar manual

1. 1
   Välj några läsbara teckensnitt. Även datorer kan stödja ett antal olika teckensnitt, är målet för en instruktionsbok för att vara lätt läsbar. Välja endast ett litet antal typsnitt som ser bra ut tillsammans är det bästa sättet att uppnå detta mål. Typsnitt kan delas upp i två typer: serif och sans serif typsnitt.
   • Serif typsnitt har små utsmyckning linjer vid ändarna av de viktigaste slag som bildar bokstaven. Serif typsnitt omfattar sådana typsnitt som Times New Roman, Baskerville, och Book Antiqua. Serif typsnitt fungerar bäst för stora delar av texten som visas i 10 till 12 punktstorlek i huvuddelen av en tryckt manual.
   • Sans serif-teckensnitt visas endast de linjer som bildar bokstäverna utan utsmyckning. Sans serif typsnitt omfattar sådana typsnitt som Arial, Calibri och Century Gothic. Sans serif-teckensnitt kan användas för stora bitar av text i storlekarna 8-10 poäng i en PDF eller webbaserad handbok, även om bristen på seriffer gör meningar som visas i storlekarna 12 punkter eller större svårare att läsa. De kan dock användas effektivt i större storlekar för att visa titlar och rubriker, och de är också stor i de mindre storlekarna för fotnoter och siffror i kolumner och tabeller.
   • Du bör i allmänhet välja vanligt typsnitt som Arial eller Times New Roman för din manual, även om du kanske vill använda en dekorativ typsnitt för citat eller för titlar om du skriver en manual för ett tv-spel med en fantasy eller science fiction-miljö. (När det gäller citat, kan du ofta få genom med en av de vanliga typsnitt och visa pull citat i kursiv stil.)
   • När du har beslutat om de teckensnitt du vill använda, skapa ett prov för att kontrollera att dina typsnitt går ihop bra på papper. Du kommer också vill visa det här provet till den som har godkänts under den manuella utseende innan du går vidare med att skriva det.
2. 2
   Fundera på layouten. När du har valt din manual s teckensnitt, måste du bestämma där allt går på sidorna.
   • Generellt kommer du vill sätta den manuella titel eller kapitel titel i sidhuvudet eller sidfoten, eventuellt med hjälp av den manuella titeln på vänster sida och kapitlet titel på den högra sidan. Du vill ha sidnumren i sidhuvudet eller sidfoten också, antingen på utsidan (sidhuvud eller sidfot) eller i mitten (sidfot endast). Du kanske vill ha den första sidan i varje avsnitt eller kapitel skiljer sig från de andra sidorna genom att placera dess sidnummer i mitten av sidfoten och efterföljande sidor i utanför hörnet av sidhuvudet.
   • Du kanske vill ha bildtext text i färgade eller skuggade rutor för att skilja den från resten av texten. Var noga med att välja en färg eller nivå av skuggning som inte överväldiga texten.
   • Tillåt någorlunda betryggande marginaler på alla sidor, med extra utrymme på kanterna som binds samman.
3. 3
   Tänk vilken typ av bindning för handboken. Om din manual kör mer än 4 sidor, kommer sidorna att behöva bindas ihop på något sätt. Även interna handlingar kan häftas ihop i hörnet, är externa bruksanvisningar som levereras med en produkt oftast bunden i en av tre olika sätt:
   • Side-häftning är lämplig för handböcker består av vikta 8,5 x 11 tum (21 x 27,5-cm), 8,5 x 14 tum (21 x 35-cm), eller 11 x 17 tum (27,5 x 42,5-cm) ark av papper. De flesta billiga manualer för 48 sidor eller färre är bundna på detta sätt.
   • Sadelhäftning oftare används för tredjepartsprogram referens guider än för bruksanvisningar som levereras med andra produkter än bilar, även om vissa långdraget manualer är bundna på detta sätt. (Paint Shop Pro levereras ursprungligen med en rygghäftade bundna manual när det producerades av JASC Software.)
   • Spiralbindning är lämplig för manualer avsedda att användas i mer robusta inställningar, till exempel utomhus, där side-häftade eller sadelhäftad manualer skulle falla sönder. Vissa spiral-bundna manualer kan också ha laminerade sidor för att hålla dem från att bli förstört om handboken blir våt eller lerig.
4. 4
   Bygg ett malldokument för din handbok. Många ordbehandling och desktop program publicering erbjuda dig möjligheten att skapa ett malldokument för din manual, så att när du skriver, kommer texten automatiskt att visas i det teckensnitt du valt för den del av handboken som du arbetar med. (Denna artikel, i själva verket skrevs ursprungligen med ett Microsoft Word-mall.) De flesta av dessa program också innehålla en uppsättning fördefinierade mallar som du kan ändra efter dina behov, istället för att skapa mallen från scratch.
   • Ordbehandling och desktop publishing program erbjuder också möjligheten att skapa "stilar", förinställt teckensnitt och-storlek format för sidhuvud, sidfot, rubriker och brödtext. Du kan välja någon av de definierade liknande namn (t.ex. "Heading1," "Normal", "Citat") eller skapa din egen stil med sitt eget namn. Så mycket som möjligt, följa konventionerna för etablerade liknande namn om du har flera stilar för samma klass av text. (Till exempel, Microsoft Word etiketter text stilar för rubriker som "Heading1," "Heading2," etc. för rubriker från den centrala budgetposten genom flera nivåer av underrubriker.) Försök att skapa alla stilar du behöver förskott så att du don ' t måste stanna upp och skapa dem under själva skrivprocessen.