Tips om hur man skriver User Manuals

Undvika förvirrande jargong och koncentrera sig på en klar och precis beskrivning av den teknik du beskriver kan du skapa en enkel, intuitiv användarhandbokenoavsett ämne naturen . Innan du skriver manualen , förbereda innehållet noggrant , planera hur du ska utveckla det till instruktions prosa och bedöma den detaljnivå som krävs . Ta alltid noga med att inte få läsaren att känna sig översvämmas av komplexa , överarbetad beskrivning . First Impressions

En ful , tung , färgglada manuell med massor av illustrationer, skämt och onödiga detaljer kommer att sätta de flesta läsare av även öppna den till önskad sida . Som sådan , omslaget , storlek och utformning av handboken , och de första sidorna spelar en viktig roll . Skapa en enkel , informativ lock och introduktion och hålla den allmänna läsaren i åtanke hela tiden . En effektiv handbok kommer att ha en välskriven , enkel att använda innehållsförteckningen med en exakt förteckning över relevanta kapitelrubriker , sidnummer och underavdelningar för snabb och enkel sökning .

Information om design och layout

pappersanvändarhandböckermed enkla , rymliga , svartvittlayouter är lättast att läsa och smälta . En handbok bör innehålla tillräckligt med information för att göra det möjligt för läsaren att fylla i alla nödvändiga uppgifter i samband med produkten eller uppgiften i fråga (t.ex. anvisningar till arbete och reparera en mikrovågsugn ) , men det bör inte vara så stor och tekniskt detaljerat att det blir tunga och således svåra att transportera i hemmet. Sträva efter att uppnå rätt balans mellan design och innehåll; inte faller i fällan att skapa en vackert utformad handbok med ogenomtänkta koncept och dålig handstil . Samma princip gäller för alla diagram och bilder : Håll dem enkla , tydliga , väl positionerat på sidan och relevant . PNG-filer har små , ​​hanterbara filstorlekar , men kom ihåg att kontrollera den återgivna bilden för tydlighet och läsbarhet . Addera Känn ditt ämne

Vi kan inte alla har använt samma mikrovågsugn , dator eller pennvässare . Utveckla en klar förståelse för hur en eller två modeller av utrustningen arbete, då börja tänka på hur man bäst kan beskriva varje komponent . Använd standardterminologi, och gör aldrig upp namnen för de olika komponenterna . Behandla alltid potentiella läsare som om de har kunskap om objektet på någon nivå , men behöver extra hjälp med detaljerna; annars kan du riskera att stöta bort dem genom att förolämpa deras intelligens . Lägg till så mycket information som möjligt , men presenterar det helt enkelt och på ett vänligt , hjälpsamt sätt .
Färgkodning
p Om du tror att du kan lägga till den grundläggande manual har skapat , mjukt färgkoda vissa fakta och länka dem i hela texten . ( Använd inte fluorescerande rosa , hålla sig till ljus , enkla färger som pastell grönt och blått . ) Denna koppling är en typ av " indexering " och använder sig av människors kognition och psykologi läsning . Det ger dem möjlighet att utveckla en bättre förståelse av arbetena och funktioner i en utrustning snarare än att ge dem en förenklad eller " platt" landskap tanke .

Olika stilar av Prosa

Utveckla och förbättra effektiviteten i din handbok genom att experimentera med lite olika stilar att skriva . Bryt varje avsnitt och avsnitt ner i en kort beskrivande stycke för införandet , vilket ger en grundläggande beskrivning av de element som ingår , och sedan lägga till en steg-för -steg- instruktion efter första stycket för att tala om för läsaren exakt hur man fyller en viss reparation eller -funktion. Denna teknik håller den manuella flödande och intressant samtidigt förmedla de kunskaper i en kort tid . Även när man försöker avancerade tekniker för att skapa en användarmanual, alltid gå tillbaka till grunderna : Kontrollera din stavning , grammatik , konsistens , språk och formatering regelbundet Addera
.