Tips om Skrive Bruksanvisninger

Unngå forvirrende sjargong og konsentrere seg om en klar , presis beskrivelse av teknologien du beskriver kan du lage en enkel , intuitiv brukerveiledning uavhengig av faget natur . Før du skriver den manuelle , forberede innholdet nøye , planlegge hvordan du vil utvikle den til instruksjons prosa og dømme detaljnivået som kreves . Alltid ta vare ikke å gjøre leseren føler oversvømt av komplekse , overarbeidet beskrivelse. Førsteinntrykk

En stygg , tung , fargerike manuelle med massevis av illustrasjoner , vitser og unødvendige detaljer vil sette de fleste lesere av å åpne den til ønsket side . Som sådan , dekselet , størrelsen og utformingen av den manuelle , og de ​​første sidene spille en viktig rolle . Lag en enkel , informativ dekning og innføring og holde den alminnelige leser i bakhodet hele tiden . En effektiv håndboken vil ha en godt skrevet , lett - å-bruke innholdssiden med en nøyaktig liste over relevante kapitteloverskrifter , sidetall og underseksjoner for rask og enkel søking .
Detaljer om Design og Layout

trykte brukerhåndbøker med enkle , romslige , svart- hvitt oppsett er lettest å lese og fordøye . En manuell bør inneholde nok informasjon til at leseren til å fullføre alle nødvendige oppgaver knyttet til produktet eller oppgaven i spørsmålet (for eksempel instruksjoner for å jobbe og reparere en mikrobølgeovn ) , men det bør ikke være så stort og teknisk detaljert at det blir tung og dermed vanskelig å transportere rundt hjemmet. Streber etter å oppnå den riktige balansen mellom design og innhold ; ikke faller i fellen med å lage et vakkert designet manuell med dårlig unnfanget konsepter og dårlig skriving . Det samme prinsippet gjelder for alle diagrammer og bilder : Hold dem enkle, klare , godt plassert på siden og relevant . PNG-filer har små , ​​håndterbare filstørrelser , men husk å sjekke reproduseres bildet for klarhet og lesbarhet .
Know Your Subject

Vi kan ikke alle har brukt samme mikrobølgeovn , datamaskin eller blyantspisser . Utvikle en klar forståelse av hvordan en eller to modeller av utstyret arbeid , deretter begynne å tenke på hvordan man best kan beskrive hver komponent . Bruk standard terminologi , og aldri gjøre opp navnene til de forskjellige komponentene . Ta alltid potensielle lesere som om de har kjennskap til elementet på noen nivå , men trenger ekstra hjelp med detaljene ; Hvis ikke, kan du risikere å støte dem ved å fornærme deres intelligens . Legg så mange detaljer som mulig , men presentere det enkelt og i en vennlig , hjelpsom måte .
Color Coding
p Hvis du tror du kan legge til den grunnleggende manuelle deg har skapt , forsiktig fargekode visse fakta og koble dem gjennom hele teksten. ( Ikke bruk fluorescerende rosa , hold deg til lys , enkle farger som pastell greener og blues . ) Denne sammenhengen er en type " indeksering ", og gjør bruk av folks kognisjon og psykologi lesing. Det gir dem mulighet til å utvikle en bedre forståelse av arbeidet og funksjoner av en del av utstyret i stedet for å gi dem et enkelt eller " flat" landskapet i tanken .
Forskjellige stiler av Prose

Utvikle og forbedre effektiviteten av din bruksanvisning ved å eksperimentere med litt forskjellige stiler å skrive . Bryt hver seksjon og ledd ned i en kort beskrivende avsnitt for innføring , noe som gir en grunnleggende beskrivelse av de elementene som er involvert , og deretter legge til en trinn-for -trinn- sett med instruksjoner etter første ledd til å fortelle leseren nøyaktig hvordan du skal fullføre en viss reparasjon eller funksjon . Denne teknikken holder den manuelle flytende og interessant samtidig formidle mest mulig kunnskap i løpet av kort tid . Selv når jeg prøver avanserte teknikker for å lage en brukerveiledning , alltid gå tilbake til det grunnleggende : Sjekk staving , grammatikk , konsistens , språk og formatering på en jevnlig basis

.