Trin 1 for at Få Generel Viden om Brugervejledning Skabelon
Før du rent faktisk bruger Brugervejledning Skabelon og de andre værktøjer, som jeg udviklede for Philip, jeg ønskede at gøre sikker på, at vi har samme udgangspunkt. Jeg gav ham nogle generelle oplysninger om brugervejledninger og nogle gode eksempler på eksisterende brugervejledninger.
Jeg har listet disse oplysninger nedenfor.,
Hvad er definitionen af en brugermanual?
en brugervejledning er et teknisk kommunikationsdokument, der skal hjælpe folk med at bruge et produkt. En god brugervejledning hjælper brugerne med at bruge et produkt sikkert, sundt og effektivt.,
Andre navne, eller andre former for en brugervejledning, kan være:
- User guide
- Teknisk dokumentation
- betjeningsvejledning
- Operationel manual
- Training manual
- Guide til Hurtig Start
- Installation manual
- Vedligeholdelse manual
- Software-manual
Udover de primære mål for en brugervejledning (til at hjælpe en bruger), sekundære mål kunne være at skabe en bedre oplevelse og for at opfylde lovmæssige krav.
en brugervejledning består af tekstmæssige visuelle oplysninger (illustrationer, skærmbilleder, tabeller osv.,) for at hjælpe brugeren med at udføre specifikke opgaver.
brugeren spiller den centrale rolle, når man udarbejder en brugermanual. En velformuleret brugermanual indeholder kun de oplysninger, der er relevante for den tilsigtede bruger af produktet.
brugervejledningen skal indeholde både proceduremæssige oplysninger (trinvise instruktioner) og konceptuelle oplysninger (oplysninger, som brugeren har brug for for at forstå proceduremæssige oplysninger).
en god brugervejledning er kortfattet og bruger jargon-fri sprog. En god brugervejledning skal svare på, hvordan og hvilke spørgsmål., De skal indeholde oplysninger om, hvad der sker, hvis en opgave ikke udføres korrekt.
i nogle tilfælde er et produkt beregnet til at blive brugt af forskellige typer brugere. Typiske brugertyper er slutbrugeren, installatøren, vedligeholdelsesingeniøren og operatøren. Hver brugertype har brug for en anden tilgang med hensyn til sprog, der skal bruges, tonen i stemmen og forudsat konceptuelle oplysninger.
hvilke oplysninger skal være i en brugervejledning?
forskellige slags produkter har brug for en brugervejledning. Et produkt kan være et system, værktøj, enhed, et instrument, et stykke soft .are eller en app.,advarsel
ved Hjælp af en brugervejledning skabelon
Den vigtigste værktøj, som jeg har udviklet for at hjælpe Philip trække op hans brugervejledning en Brugervejledning Skabelon., Skabelonen indeholder alle de oplysninger og mere fra listen ovenfor. Det opfylder kravene til hans produkt.skabelonen til brugermanualen kan bruges til at oprette din manual til dit system, værktøj, enhed, instrument eller til at oprette en installationsmanual, soft .aremanual, driftsmanual, vedligeholdelsesmanual eller træningsmanual.
Baseret på den første skabelon for Philip, har vi udviklet skabeloner for følgende produktgrupper:
- Medicinsk Udstyr
- Legetøj
- Maskine
- Elektronik
Hvad formater gør en brugervejledning have?,
brugervejledninger kan leveres i enten et papirformat eller som et elektronisk dokument (PDF eller placeret online eller på enheden i HTML). Brugermanualen skabelon er et MS Wordord-dokument, der kan udskrives eller placeres online.
brugermanualer kan oprettes ved hjælp af en række forskellige værktøjer. Hvert værktøj har sine egne fordele og ulemper., indholdet er muligt
Alt i en løsning,
Omni-platform publikationer
Indeholder standard brugervejledning skabeloner
brugervejledning eksempler
under udarbejdelsen af en brugervejledning med hjælp af de Brugervejledning Skabelon, det kan være praktisk at have nogle gode eksempler., Via nedenstående links kan du downloade en brugervejledning prøve for dokumentation:
- IKEA vejledning til installation
- Jura brugervejledning
Trin 2 Identificere Brugeren(s) i Din Brugervejledning Skabelon
Ok, så nu Philip har nogle grundlæggende viden om brugervejledninger. Lad os dykke ned i detaljer og handlinger.
Når du vil skrive en manual, der hjælper din bruger med at løse problemer, skal du først definere, hvem din bruger er. Dette kan gøres ved at oprette en brugerprofil, også kaldet en persona.,
med en persona tager du nogle rimelige antagelser om din brugers egenskaber. Dette er ikke kun nyttigt til at oprette dine brugervejledninger, men det er et vigtigt element i starten af udviklingen af ethvert produkt! Som uddannet industriel designingeniør startede vi alle vores designopgaver på denne måde.
Når jeg kontrollerede ISOVO. – websiteebstedet, fandt jeg ikke engang en klar beskrivelse af deres tilsigtede brugere. Derfor bad jeg Philip om at definere sine brugere og besvare spørgsmål som:
- Hvem er brugeren af dit produkt?,
- anvendes produktet professionelt eller hovedsageligt privat?
- hvilke andre tekniske erfaringer har de? Hvad beskriver brugeren?
Jeg har oprettet en skabelon, der indeholder spørgsmålene. Jeg bad Philip om at udfylde skabelonen.
Du kan selv bruge skabelonen til at bestemme, hvem din bruger er. Bemærk, at den anden fane også indeholder Philips svar, så du har et eksempel på, hvordan arket kan bruges.
handling: Brug skabelonen til at beskrive dine(e) brugere.
Jeg er en stor fan af at visualisere ting., Så hvis du vil tage definitionen af din bruger et skridt videre, vil jeg foreslå, at du visualiserer din bruger i form af en persona. Når du opretter en persona, giver du din bruger et navn, alder et cetera, så det bliver en rigtig person, der repræsenterer din bruger.
Jeg gjorde dette for Philip., Dette er resultatet:
Handling: at Skabe en visualisering af din bruger
Hvis du ønsker at vide mere om, hvordan du definerer din målgruppe og skabe personas:
Trin 3 Oprettelse af Emner til Din Brugerens Problemer
Start med at identificere problemer, at din bruger(e) måske vil opstå i løbet af et produkts livscyklus, og at han/hun ønsker at løse. Typiske problemer kan omfatte: installation af produktet, brug af produktet, brug af produktet sikkert, vedligeholdelse af produktet og bortskaffelse af produktet.,
Hvis problemet er for komplekst, kan du bryde det ned i bidder.
Jeg bad Philip om at identificere de problemer og løsninger, som hans bruger måtte støde på i løbet af produktets livscyklus. For at gøre det oprettede jeg en anden skabelon til Philip. I den venstre kolonne i fanen livscyklus nævnes stadierne i et produkts livscyklus. Disse er afledt af den internationale standard for brugervejledning, IEC/IEEE 82079. Vores brugermanual skabeloner er i overensstemmelse med denne standard.
på fanen livscyklus kan du se, hvordan Philip justerede livscyklussen til sit eget produkt.,
handling: Brug denne skabelon og instruktionerne på den første fane til at identificere de problemer, din bruger måtte have i løbet af dit produkts livscyklus og præsentere deres løsninger.,
Hvis du ønsker at vide mere om, hvordan du definerer dine brugerens problemer og skabe emner:
- Emne-baserede authoring
- Minimalisme
- Oplysninger kortlægning
- Chunking
Trin 4 Angiv Strukturen af de Brugervejledning Skabelon
Philip har nu identificeret de problemer, en bruger kan have med hans produkt i løbet af dets livscyklus, og han har nu tænkt på den løsning til at løse problemet. Med andre ord: Philip har defineret emnerne for sin brugermanual., Hvert emne kan kun dreje sig om et specifikt emne, har et identificerbart formål og skal være i stand til at stå alene.
et emne skal give svaret på kun en brugers spørgsmål. En bruger ønsker at løse et problem ad gangen. Når en bruger har løst problemet, vil han/hun gå og løse det næste problem.
et emne bliver et afsnit i brugervejledningen. Det kan være et kapitel eller et (under)afsnit. Så snart en bruger leder efter et svar på sit problem, vil han bruge indholdsfortegnelsen til at finde ud af, hvordan man navigerer til det svar.,
Jeg bad Philip om at strukturere emnerne og definere deres plads i brugermanualen ved at tildele et bestemt emne til et specifikt kapitel eller (under)afsnit. Resultatet kan ses på fanen ToC.
handling: sådan definerer du strukturen i din brugermanual:
- Kopier indholdet fra fanen livscyklus til fanen ToC.
- på fanen ToC skal du erstatte Produktnavn med dit eget Produktnavn.
- Tilføj en kolonne til venstre. Navngiv det ‘sektion’.
- Organiser dine sektioner logisk, hvis det er relevant.
- Bestem, hvilke emner der vil blive kapitler ved at tilføje kapitelnumre., Begynd nummerering FORBEREDELSESPRODUKT til brug med nummer 4. Vi vil tilføje nogle flere kapitler i næste trin.
- Bestem, hvilke emner der vil blive afsnit ved at tilføje sektionsnumrene.
- Bestem, hvilke emner der vil blive underafsnit ved at tilføje underafsnittsnumrene.
Du har nu oprettet indholdsfortegnelsen (ToC). ToC er konturen af din brugermanual. Senere vil vi tilføje nogle flere emner/sektioner, som introduktion, sikkerhedsoplysninger osv., så bekymre dig ikke om at tilføje det nu.,
Trin 5 Opret meningsfulde overskrifter
hvert emne i brugervejledningen får sin egen overskrift. Overskrifterne er de (sub-)titler, der går forud for den faktiske tekst. De vises i ToC, så brugeren kan navigere til de nødvendige oplysninger.
så Philip har netop oprettet (sub-)titlerne til sine emner.fordi Toc-posterne spiller en så vigtig rolle i at hjælpe din bruger med at finde vej, og for at hjælpe dem med at springe over det, der ikke er vigtigt, har de brug for lidt mere opmærksomhed.grundlæggende skal du prøve at arbejde med tre niveauer af overskrifter: overskrifter på første, andet og tredje niveau.,
overskriften på første niveau beskriver, hvad hele kapitlet eller sektionen handler om (f.eks. INSTALLATION af produktet). Overskrifterne på andet niveau skal bruge formuleringsstilen’ Ho.whathat’ (f. eks. hvordan produktet monteres, og hvordan den elektriske Installation udføres). En overskrift på tredje niveau bruger navneord (f.eks. Emballageindhold og værktøjer, der skal bruges).
Jeg bad Philip om at omdirigere sine overskrifter og tage notits af følgende generelle retningslinjer:
- brug strukturen som vist ovenfor for første, andet og tredje niveau overskrift.,
- sørg for, at overskrifterne er selvforklarende. Overskriften gør pandekager er meget mere brugerorienteret end at bruge MagicCook5000.
- sørg for, at overskriften dækker hele emnet. Hvis afsnittet dækker vedligeholdelse og reparation af et produkt, vil overskriften vedligeholdelse være ufuldstændig.
- prøv om muligt at udelade artikler i begyndelsen af overskrifter
handling: skriv nye overskrifter til dine ToC-poster.Philips ‘ ToC med meningsfulde overskrifter kan findes på fanen Toc w. meningsfulde overskrifter.,
Trin 6 fastlægger den Retlige Indhold
Afhængig af det marked, hvor produktet er placeret i eller tages i brug, afhængig af produktgruppe dit produkt tilhører, specifik lovgivning, der gælder for dit produkt.
generelt kræver lovgivningen, at dit produkt er ‘sikkert’ og giver derfor generelle sikkerhedskrav, som dit produkt skal opfylde.
disse krav indeholder også krav til indholdet af din brugervejledning og sikkerhedsinstruktioner.,
for at sælge dit produkt på et bestemt marked, skal du sørge for, at din brugermanual overholder disse krav.
Disse to artikler nedenfor vil fortælle dig, hvordan du kan finde ud af præcis, hvilken lovgivning der gælder for dit produkt til det Europæiske og AMERIKANSKE marked, og hvad kravene er til din brugervejledning. Pro tip: når der allerede er en overensstemmelseserklæring tilgængelig, kan du finde de gældende direktiver derinde.,
- Sådan opretter du vejledninger, der overholder EU
- Sådan opretter du vejledninger, der overholder EU
Philip behøvede ikke at udføre disse trin, da den skabelon, han brugte, allerede indeholdt det juridiske indhold som krævet i de relevante direktiver.
For sit produkt, for det betyder, at følgende oplysninger er nødvendige, for den brugervejledning for hans produkt:
EU (relevante CE-mærkning direktiver: LVD EMC, RoHS, WEEE og REACH):
- brugermanualen skal oversættes til de sprog, der tales i det land, hvor produktet er solgt.,
- brugervejledningen skal beskrive den påtænkte anvendelse af produktet.
- brugervejledningen skal beskrive den med rimelighed forventede utilsigtede anvendelse af produktet.
- hvis det er relevant, bør manglende overholdelse i boligområder nævnes.
- type, parti eller serienummer eller andet element, der gør det muligt at identificere produktet, skal anføres på produktet. Hvis produktet er for lille, kan dette placeres i brugervejledningen.
- navn, registreret handelsnavn eller registreret varemærke og postadresse skal nævnes på produktet., Hvis produktet er for lille, kan dette placeres i brugervejledningen.
- der skal udføres en risikoanalyse for at bestemme de resterende risici i forbindelse med brugen af produktet. Der skal gives sikkerhedsoplysninger for at informere brugeren om de foranstaltninger, der skal træffes.
- informationeee oplysninger skal medtages
- oplysninger om emballageaffald skal medtages.
udover denne lovgivning er der også en international standard for brugervejledninger, IEC / IEEE 82079-1:2019. Denne standard er blevet harmoniseret i EU., Overholdelse af harmoniserede standarder giver en formodning om overensstemmelse med den tilsvarende lovgivning!
brugermanualskabelonen overholder denne standard.
Jeg har også oprettet en IEC 82079-tjekliste, der kan bruges til at dobbelttjekke, at din brugermanual overholder denne standard.
for at oprette en internationalt kompatibel brugermanual skal du altid sørge for, at din manual opfylder kravene i EU, USA og 80279.,
handling: for at bestemme de juridiske krav til din brugermanual:
- følg trin 1-2 fra EU ‘ s overholdelse og / eller trin 1-6 fra de amerikanske overholdelsesartikler for at bestemme de juridiske rammer for dine instruktioner.
- Undersøg IEC 82079-tjeklisten for at sikre, at din manual overholder 82079-standarden.
I denne video forklarer jeg hvordan du kan lave en manual der er i overensstemmelse med 82079 standard:
TIL BUTIKKEN
Trin 7 Download og Forberede Brugervejledning Skabelon
Nu Philip kan starte den faktiske oprettelse af hans brugervejledning.,
Jeg bad ham om at justere indholdsfortegnelsen i skabelonen i henhold til hans egen indholdsfortegnelse. Uden at fjerne og obligatoriske elementer selvfølgelig…
kan du huske fra trin 4, at jeg bad om at starte nummereringen af sektionerne med kapitel 4? Når du selv har do .nloadet brugermanualen template doc, vil du se, at der er tilføjet et par standardkapitler, samt nogle bilag.,
Handling: for At justere brugervejledning skabelon:
Hvis du ønsker at arbejde med den gratis skabelon:
- Download gratis brugervejledning skabelon i Word 2013 eller 2007
- Skift afsnitsoverskrifterne i henhold til dine egne Indholdsfortegnelsen. Bemærk! Juster ikke indholdsfortegnelsen. Indholdsfortegnelsen kan opdateres automatisk, når du har justeret sektionsoverskrifterne.
- tilføj det obligatoriske indhold som bestemt i trin 6 i din manual.
- hvis det er relevant, skal du ændre afsnit 1-3 og tillæggene efter dine egne behov.,
Eller bruge en af vores betalte skabeloner, der indeholder alle obligatoriske indhold, som Philip gjorde:
- Medicinsk Udstyr, som EU ‘
- Medicinsk Udstyr til OS
- Maskiner EU
- Maskiner OS
- Elektronik EU
- Legetøj EU
Trin 8 Skabe Indhold til Din Brugervejledning Skabelon
Skriv den Tilsigtede Brug
Formålet med dit produkt, eller bedre: den tilsigtede brug, er hjertet i en brugervejledning, og danner grundlaget for at sikre en sikker og sund brug af produktet.,
den måde, hvorpå den tilsigtede brug beskrives, bestemmer også dit ansvar og påvirker det videre indhold i brugermanualen.
den mest lovlige lovgivning kræver, at du medtager en beskrivelse af den påtænkte anvendelse i brugervejledningen.
den internationale standard for brugervejledninger, IEC 82079-1, indeholder følgende definition for den tilsigtede anvendelse:
en udtømmende række funktioner eller planlagte applikationer defineret og designet af leverandøren af produktet
Ved at beskrive den tilsigtede anvendelse bestemmer du produktets sikre kuvert., Og når du først har bestemt den tilsigtede anvendelse, kan du fokusere på kun at give disse sikkerheds-og brugervejledninger til, hvordan du bruger produktet i den givne konvolut.
derudover kræver mange flere standarder, direktiver og forskrifter til den tilsigtede brug også, at du inkluderer en beskrivelse af det med rimelighed forudsigelige misbrug.
for eksempel kan det med rimelighed forudsigelige misbrug af et aggressivt vaskemiddel være brugen af det i et fødevareforarbejdningsmiljø.
at være for lidt opmærksom på at beskrive det med rimelighed forudsigelige misbrug vil påvirke et selskabs ansvar.,
produktansvar love / regulering holde en producent ansvarlig for et defekt produkt. Hvis et produkts mangel skal bestemmes, vil alle omstændigheder blive taget i betragtning. Dette omfatter den med rimelighed forudsigelige anvendelse af produktet.
beskrivelsen af den påtænkte anvendelse bestemmer, hvilke instruktioner der er angivet i resten af manualen. For eksempel, hvis et kølesystem kun bruges til afkøling af visse lægemidler, skal kun disse procedurer beskrives.,
hvis det med rimelighed kunne forudses, at kølesystemet kan anvendes som et system til afkøling af organer, skal dette beskrives i instruktionerne. Dermed vil du som producent begrænse dit ansvar, og du kan kun fokusere på at beskrive, hvordan du bruger systemet til at afkøle medicin.
handling: skriv den tilsigtede anvendelse og det med rimelighed forudsigelige misbrug af dit produkt.
Figur 1. Rimeligt forudsigeligt misbrug?,
skriv sikkerhedsadvarslerne baseret på risikoanalysen
selvom den tilsigtede anvendelse nu er klart defineret, betyder det ikke, at brug af et produkt er helt uden nogen risiko.
for at identificere de farer, der følger med brugen af et produkt, kan du foretage en risikoanalyse. En risikoanalyse kan også være obligatorisk for visse produktgrupper, såsom lavspændingsudstyr, legetøj, maskiner og udstyr til brug i eksplosiv atmosfære.
standarder, som ISO 12100, er udviklet til, hvordan man udfører en risikoanalyse., ISO 12100 giver også en metode til at træffe afbødende foranstaltninger: Tretrinsmetoden. I henhold til denne metode, er der følgende hierarki af risikobegrænsende foranstaltninger:
- indbyggede foranstaltninger til sikker konstruktion
- Beskyttelse og supplerende beskyttelsesforanstaltninger
- Oplysninger for brug
Dette betyder, at brugeren guide skal advare om eventuelle tilbageværende risici, der er relateret til brugen af produktet. Dette gøres med sikkerhedsadvarsler.,
Køb nu
en god sikkerhedsadvarsel beskriver arten af en farlig situation, konsekvenserne af ikke at undgå en farlig situation og metoden / metoderne til at undgå den.
for at angive graden af fare, som brugeren kan støde på, skal signalordene “fare”, “Advarsel” og “forsigtighed” anvendes.
Tag et kig på følgende sikkerhedsmeddelelser:
advarsel! Roterende dele. Risiko for alvorlige skader. Hold hænderne fri. Lockout / Tagout før service.
så vil du advare brugeren, hvor der kan opstå en farlig situation. ANSI5535.,6 standard beskriver følgende steder i brugervejledningen, hvor dette kunne være:
- grupperet i et separat kapitel.
- I den første del af den særlige sektion:
- Indlejret i en procedure:
1. Gør det her.
2. Gør det. Advarsel! Dette er indlejrede sikkerhedsmeddelelser. Generel tekst generel tekst generel tekst.
3. Gør det her.,
- i forordet kan eventuelle supplerende direktiver placeres, såsom Læs alle instruktioner før brug eller gem disse instruktioner til fremtidig reference kan placeres i introduktionen af en brugermanual.
i EU kan det afhængigt af produktets art kun være tilladt at levere sikkerhedsoplysningerne i trykt form og resten af oplysningerne online.
for at hjælpe Philip med at oprette og placere en sikkerhedsmeddelelse, har jeg oprettet en anden skabelon.
handling: Foretag en risikoanalyse og lav dine sikkerhedsmeddelelser ved hjælp af denne skabelon.,
Opret alt andet indhold
nu bad jeg Philip om at oprette alt andet indhold, såsom procedurer, tekniske specifikationer og juridiske oplysninger.
Jeg gav følgende tip:
- Ekskluder unødvendigt materiale for at undgå overbelastning af information (for eksempel salgsfremme, omfattende gentagelse osv.).
- sørg for, at Vilkår er velkendte for brugeren, tekniske funktioner og vilkår er godt forklaret og brug vilkår konsekvent.
- beskriv eventuelle forudsætninger, der skal være opfyldt, før de faktiske instruktioner starter., Dette kan også beskrive specialværktøjer eller plads til vedligeholdelse og reparation.
- Giv konceptuelle oplysninger, når oplysninger er nødvendige for tilstrækkelig forståelse og udførelse af opgaver.
- altid skrive emne baseret.
- brug et fed skrift for alle produktelementer.
- brug en stilguide til at hjælpe dig med at skrive og formatere dokumentation på en klarere måde.
- angiv, hvornår du vil tilføje et billede for bedre forståelse senere.
- sørg for, at ord og sætninger ikke er for komplicerede eller for sofistikerede.,
- Brug enkle / standardiserede og korte sætninger: en sætning-en kommando.
- læg ikke for meget information i en sætning.
- Brug de direkte aktive stemme-og selvhævdende kommandoer.
- brug ord som navneord og verb konsekvent for at undgå tvetydighed.
- for at skrive bedre instruktioner skal du bruge principperne om minimalisme i teknisk kommunikation og forenklet Teknisk engelsk.
handling: Opret alt andet indhold til din brugermanual.
igen, for de fleste produktgrupper er der betalte skabeloner tilgængelige, hvilket kan gøre arbejdet lettere., Disse skabeloner indeholder alle juridiske tekster, obligatoriske bortskaffelsesoplysninger, ophavsretlige erklæringer og overholder IEC 82079-standarden på brugervejledning.
Placer sikkerhedsadvarslerne i den rigtige position
Når jeg bruger skabelonen til at lave sikkerhedsmeddelelserne, bad jeg Philip om at angive, om en sikkerhedsmeddelelse er et supplerende direktiv eller skal placeres som en grupperet, sektion eller indlejret sikkerhedsmeddelelse.
nu er al tekst oprettet, sikkerhedsmeddelelserne kan placeres på det rigtige sted.,
handling: Placer alle sikkerhedsmeddelelser på det rigtige sted i brugermanualen.
trin 9 Føj Navigation til din Brugermanualskabelon
en brugermanual skal hjælpe folk ved at give oplysninger om, hvordan man bruger et produkt. At finde de rigtige oplysninger, der løser brugerens problem, skal tage så lidt tid som muligt.
udformning af meningsfulde overskrifter er et af de værktøjer, der hjælper brugerne med at finde information., Men der er flere andre værktøjer til at hjælpe brugeren til at finde de oplysninger, han/hun ønsker, f.eks.:
- indholdsfortegnelse
- sidenummerering
- Index
jeg spurgte Philip til at opdatere indholdsfortegnelsen og tilføje sidenummerering og et indeks.
handling: Tilføj eller opdater din indholdsfortegnelse, sidenummerering og indeks.
Trin 10 Få din brugermanual gennemgået
Philip har nu oprettet udkastet til sin brugermanual ved hjælp af brugermanualskabelonen. Vi kalder denne version tekstmæssige indhold design.,da Philip har en forretningspartner og en udvikler med dybdegående teknisk produktkendskab, bad jeg Philip om at lade dem gennemgå arbejdet indtil videre.
både hans forretningspartner og udvikleren gav feedback. Philip brugte denne feedback til at optimere brugermanualen.
handling: Send udkastet til brugermanualen til alle i dit team, der muligvis kan levere feedback. Bed dem om at kombinere al feedback i .t dokument, før de sender det tilbage til dig. Dette stimulerer diskussion af dine teammedlemmer og forhindrer uenighed på et senere tidspunkt.,
trin 11 Opret billederne
Når brugermanualen er blevet gennemgået og optimeret, er teksterne mere eller mindre klare. Dette betyder, at alle billeder nu kan oprettes og tilføjes til indholdet.grunden til at vente, indtil teksterne er klar, er, at oprettelse eller redigering af billeder kan være tidskrævende. Da billeder skal understøtte, erstatte eller forøge tekst, vil du vente med at oprette dem, indtil teksterne er endelige.
billeder i brugervejledninger kan omfatte illustrationer, fotos, skærmbilleder, tabeller, diagrammer og skemaer.,
Der er mange gode værktøjer, der kan hjælpe dig med at skabe dine billeder, sådan som:
- Snagit eller Adobe Photoshop til redigering skærmbilleder eller billeder
- Solidworks Composer eller Google Sketchup for at skabe stregtegninger
- Lucidchart eller Microsoft Visio til diagrammer og skemaer
jeg rådede Philip ikke at bruge billeder som et billigt alternativ til illustrationer. Ofte er fotos ikke så informative, fordi de indeholder for meget information. Derudover kan Fotos få en brugermanual til at se rodet ud.,
af den grund brugte Philip Google Sketchup til at oprette sine illustrationer.
handling: Opret billederne til din brugermanual.
Hvis du ønsker at vide mere om at skabe billeder:
- ved Hjælp af tekst, billeder eller video
- Oprettelse af IKEA-ish manualer
Trin 12 Endelig Ind i den Brugervejledning Skabelon
Før vi begynder at gøre det pænt og oversætte det indhold, vi ønsker at være sikker på, at indholdet er komplet.
for at gøre det bad jeg Philip om at bruge en tjekliste.,
handling: l sørg for, at din brugermanual overholder alle relevante krav fra IEC 82079-1:2012 ved at bruge denne tjekliste.
trin 13 Design din brugermanual skabelon
en veldesignet manual bidrager til en bedre brand og brugeroplevelse.
Du kan justere Brugermanualskabelonen i MS Wordord ved at tilføje et firmalogo og justere skrifttype, farver osv., men det kan have begrænsninger.
Når du ved, hvordan du arbejder med Adobe Indesign, eller er villig til at lære at arbejde med det, vil dette give dig meget større designmuligheder.,
Jeg oprettede denne skabelon i Indesign og bad Philip om at justere den for at matche hans brandidentitet.
Handling: Juster Brugervejledning Skabelon til at passe dit brand identitet, eller download InDesign-bruger manual skabelon og justere den.
trin 14 DTP fungerer
DTP står for Desktop Publishing, og .ikipedia beskriver det som ‘oprettelse af dokumenter ved hjælp af sidelayoutfærdigheder på en personlig computer primært til udskrivning’.Philip har nu både indholdet af sin brugermanual (Wordord-fil) og brugermanualskabelonen (InDesign-fil)., Indholdet skal sættes i InDesign-skabelonen. Dette kaldes Desktop Publishing.handling: Placer indholdet fra din Wordord-fil i Indesign-skabelonen. Hvis du besluttede ikke at bruge InDesign-skabelonen, men sidder fast i Wordord-filen, kan du springe over dette trin.
trin 15 Oversæt og Udgiv dine brugervejledninger
afhængigt af det marked, hvor du vil sælge dit produkt, skal du muligvis oversætte brugervejledningen.
nogle generelle tips:
- Kig efter en oversætter med lignende erfaring., Det kan være en oversætter, der har erfaring med at oversætte teknisk indhold, med lignende produkter eller med at oversætte brugervejledninger.
- hvis du har brug for at oversætte til flere sprog, kan det spare dig for meget tid at arbejde med et oversættelsesbureau.
- spørg oversætteren eller agenturet om deres kvalitetsprocedurer, og hvem der skal revidere teksten efter oversættelse.
- da du kender dit produkt bedst, og hvem dit publikum er, kan det være en god id.at give oversætteren eller agenturet en ordliste eller en liste med den terminologi, du vil bruge.,
- Kig efter en oversætter, der kan arbejde direkte i din Wordord-eller InDesign-fil, eller find et agentur, der også kan gøre DTP-arbejdet. Alternativt kan du selvfølgelig gøre det selv.da Philip vil sælge sit produkt i både USA og EU, besluttede han at arbejde med et agentur.
handling: Find en oversætter eller et agentur, der passer til dine behov, og få din brugermanual oversat.
generelt bør en brugervejledning være tilgængelig i et format, der er let tilgængeligt for brugeren. Der kan udskrives, eller bruges online eller på enheden.,
som bruger ønsker oplysninger i det øjeblik, han / hun har brug for det, og dermed ikke tænke i kanaler, ville den bedste tilgang være at give instruktionerne Omni-platform.
i Den Europæiske Union er det for nogle produktgrupper stadig begrænset til at give den brugermanual, der er trykt, produktet.
fra April 2016 kan instruktionerne fra mange produktgrupper dog leveres i et andet format end på tryk. Der er dog en undtagelse.sikkerhedsoplysninger skal stadig leveres i papirform sammen med produktet., Desuden bør der efter anmodning fra en forbruger stilles en papirbrugermanual til rådighed for forbrugeren.
Philip besluttede at følgende:
- han leverer en trykt komplet manual med produktet, herunder sikkerhedsinstruktionerne.
- han oprettede en separat hurtigstartguide, der også skal leveres med produktet.
- han placerede en pdf-version af den fulde manual online.
- han opretter en online-Hjælp-sektion på sit websiteebsted med HTML-versionen af brugermanualen. Her kan han også tilføje videoer., Og ved at optimere HTML-versionen til søgemaskiner gør han det lettere for sin bruger at finde information til sin bruger
konklusion
det er alt, hvad der er til det. Sådan skabte Philip en kompatibel brugermanual med hjælp fra skabelonen brugervejledninger og de andre tilgængelige værktøjer, som jeg leverede.
den bedste del af alt dette er, at du kan få de samme resultater som Philip gjorde ved at følge denne trinvise proces om, hvordan du opretter en brugermanual.