Trinn 1 for å Få Generell Kunnskap om Brukerhåndbok Mal

Før du faktisk bruker Brukerveiledning Mal og andre verktøy som jeg utviklet for Philip, jeg ønsket å sørge for at vi har samme utgangspunkt. Jeg ga ham litt generell informasjon om bruksanvisningen og med noen gode eksempler på eksisterende brukerhåndbøker.

jeg har listet opp denne informasjonen nedenfor.,

Hva er definisjonen av en bruksanvisning?

En brukerveiledning er en teknisk kommunikasjon dokumentet er ment å gi hjelp til folk om hvordan å bruke et produkt. En god brukerveiledning hjelper brukere på hvordan du bruker et produkt trygt, sunt og effektivt.,

Andre navn, eller andre former for en bruker manuell, kan være:

  • Brukerveiledning
  • Teknisk dokumentasjon
  • bruksanvisningen
  • Operativ manual
  • Opplæring manuell
  • Quick Start Guide
  • manuell Installasjon
  • Vedlikehold manuell
  • brukerhåndboken for Programvaren

I tillegg til det primære målet for en brukerveiledning (for å hjelpe en bruker), sekundære mål kan være å skape en bedre brukeropplevelse og møte-rettslige krav.

En brukerveiledning består av tekst-visuell informasjon (illustrasjoner, skjermbilder, tabeller etc.,) for å hjelpe brukeren i å fullføre spesifikke oppgaver.

brukeren spiller en sentral rolle når du tegner opp en brukerveiledning. En godt skrevet brukerveiledning bare gir den informasjonen som er relevant for den tiltenkte brukeren av produktet.

brukerhåndboken må inneholde både prosessuelle informasjon (trinn-for-trinn-instruksjoner) og konseptuelle informasjon (informasjon brukeren trenger for å forstå prosessuelle informasjon).

En god brukerveiledning er konsis og bruker sjargong gratis språket. En god brukerhåndbok skal svare på HVORDAN og HVA spørsmål., De skal inneholde informasjon om hva som skjer hvis en oppgave ikke blir gjort riktig.

I noen tilfeller, et produkt som er ment å bli brukt av forskjellige typer brukere. Typiske brukeren typer er sluttbrukeren, installer, vedlikehold ingeniør og operatør. Hver bruker trenger en annen tilnærming i form av språket som skal brukes, tone av stemme og gitt konseptuelle informasjon.

Hva slags informasjon som bør være i en bruksanvisning?

Forskjellige slags produkter trenger en brukerveiledning. Et produkt kan være et system, verktøy, utstyr, et instrument, en programvare eller en app.,arnings

  • instruksjoner for Installasjon
  • Beskrivelse av hvordan å bruke/betjene produktet
  • avsnittet om Feilsøking og instruksjoner om hvordan du kan løse problemer
  • Vedlikehold
  • informasjon om Reparasjon
  • Informasjon om avhending av produktet og emballasjen

  • Tekniske spesifikasjoner
  • Tabell for innhold
  • Indeks
  • Ordliste
  • Garanti informasjon
  • Kontakt detaljer

    • ved Hjelp av en brukerhåndbok mal

    Det viktigste verktøyet for at jeg er utviklet for å hjelpe Philip trekke opp sin brukerveiledning er en Brukerveiledning Mal., Malen inneholder alle opplysninger og mer fra listen ovenfor. Det er i samsvar med kravene for sitt produkt.

    Brukerveiledning Malen kan brukes for å lage din bruksanvisningen for systemet, verktøy, utstyr, apparat, eller for å lage en installasjon manuell, programvare manuell, operativ manual, vedlikehold manuell eller opplæringen manuell.

    Basert på den første malen for Philip, har vi utviklet maler for følgende produktgrupper:

    • Medisinsk Utstyr
    • Leker
    • Maskiner
    • Elektronikk

    Hva formater gjør en brukerveiledning har?,

    brukerveiledninger kan gis enten i papir-format eller som et elektronisk dokument (PDF eller plasseres på nettet eller på enheten i HTML). Det brukerveiledning mal er et MS Word-dokument som kan skrives ut eller plassert på nettet.

    brukerveiledninger kan bli laget ved å bruke en rekke verktøy. Kvart verktøy har sine egne fordeler og ulemper., innhold mulig

    Indesign Høy grad av design frihet Innhold endringer kan kreve mange ekstra DTP timer CMS (teknisk redigering & publiseringsløsninger) Gjenbruk av innhold
    Alt-i-ett-løsning
    Omni-plattform publikasjoner
    Inneholder standard brukerveiledning maler Høy læringskurve

    brukerveiledning eksempler

    Mens utarbeide en brukerveiledning med hjelp av brukerhåndboken Mal, det kan være nyttig å ha noen gode eksempler., Gjennom de følgende koblingene, kan du laste ned en brukerveiledning for eksempel dokumentasjon:

    • IKEA instruksjoner for installasjon
    • Jura brukerveiledning

    Trinn 2 Identifisere Bruker(e) Din Brukerveiledning Mal

    Ok, så nå Philip har litt grunnleggende kunnskap om brukerhåndbøker. La oss dykke inn i detaljene og handlinger.

    Når du ønsker å skrive en håndbok som hjelper brukeren til å løse problemer, må du først definere hvem brukeren er. Dette kan gjøres ved å opprette en brukerprofil, også kalt en avatar.,

    Med en person, kan du gjøre noen rimelige forutsetninger om egenskapene til brukeren. Dette er ikke bare nyttig for å lage din instruksjoner, men det er et viktig element i starten av utviklingen av produktet! Som en utdannet industriell design ingeniør, dette er hvordan vi startet alle våre design oppdrag.

    Når du kontrollerer ISOVOX nettstedet, jeg visste ikke engang finne en klar beskrivelse av sine tiltenkte brukerne. Det er derfor jeg spurte Philip til å definere hans brukere og svare på spørsmål som:

    • Hvem er brukeren av produktet?,
    • Er et produkt brukt profesjonelt eller hovedsakelig privat?
    • Hva andre tekniske erfaringer har de? Hva beskriver brukeren?

    jeg har laget en mal som inneholder spørsmål. Jeg spurte Philip til å fylle ut malen.

    Du kan bruke malen selv å avgjøre hvem brukeren er. Vær oppmerksom på at den andre kategorien inneholder også Philip ‘ s svar, så har du et eksempel på hvordan arket kan brukes.

    Handling: Bruk mal for å beskrive user(s).

    jeg er en STOR fan av å visualisere ting., Så hvis du ønsker å ta definere din bruker ett steg videre, jeg ville foreslå at du visualisere brukeren i form av en personlighet. Når du oppretter en persona gir du bruker et navn, alder, et cetera, så det blir en ekte person som representerer din bruker.

    jeg gjorde dette for Philip., Dette er resultatet:

    Følgende: Opprette en visualisering av din bruker –

    – >

    Hvis du ønsker å vite mer om å definere målgruppen og å lage personas:

    Trinn 3 Oppretting av Emner for Brukerens Problemer

    Start med å identifisere problemer som brukeren(s) kan støte på i løpet av hele livssyklusen til produktet, og at hun/han ønsker å løse. Typiske problemer kan omfatte: installere produktet, og bruk av produktet, og bruk produktet trygt, vedlikeholde produktet og avhending av produktet.,

    Hvis problemet er for komplisert, kan du bryte det ned i biter.

    jeg spurte Philip til å identifisere problemer og løsninger som hans brukeren kan støte på i løpet av produktets levetid. For å gjøre dette, laget jeg en annen mal for Philip. I den venstre kolonnen i Livssyklusen kategorien, ulike stadier av livssyklusen til produktet, er nevnt. Disse er avledet fra den internasjonale standard for instruksjoner, IEC/IEEE 82079. Vår brukerveiledning maler er kompatible med denne standarden.

    På Livssyklus-fanen kan du se hvordan Philip justert livssyklusen til sitt eget produkt.,

    Følgende: Bruk denne malen, og instruksjonene på den første fanen for å identifisere problemer med din bruker har kanskje i løpet av hele livssyklusen til produktet og presentere sine løsninger.,

    Hvis du ønsker å vite mer om hvordan du definerer dine brukerens problemer og skape emner:

    • Emne-basert authoring
    • Minimalisme
    • Informasjon kartlegging
    • Chunking

    Trinn 4 Angi Oppbygging av Brukerveiledningen Mal

    Philip har nå identifisert problemene en bruker kan ha med sine produkter i løpet av sin livssyklus, og nå har han tenkt på løsningen for å løse problemet. Med andre ord: Philip har definert de emner for sin brukerveiledning., Hvert emne kan bare være om ett bestemt emne, har en identifiserbar formål, og må være i stand til å stå alene.

    En emnet skal gi svar på bare én brukerens spørsmål. En bruker ønsker å løse et problem på en gang. Når en bruker ikke har løst problemet, kan han/hun vil gå og løse det neste problemet.

    Et emne vil bli en del i brukerhåndboken. Det kan være et kapittel eller en (sub-)avsnitt. Så snart brukeren er på jakt etter et svar til hans problem, han vil bruke innholdsfortegnelsen for å finne ut hvordan du kan navigere til det svaret.,

    jeg spurte Philip til å strukturere tema og definere sin plass i brukerhåndboken, ved å tilordne et bestemt emne til et bestemt kapittel eller (sub-)avsnitt. Resultatet kan sees på Innholdsfortegnelsen kategorien.

    Handling: Å definere struktur i brukerhåndboken:

    1. Kopiere innhold fra Lifecycle tab for å Innholdsfortegnelsen kategorien.
    2. På ToC-fanen, og bytt navn på produkt med ditt eget produkt navn.
    3. Legg til en kolonne til venstre. Name it ‘Avsnitt’.
    4. Hvis det er aktuelt, organisere deler logisk.
    5. Avgjøre hvilke emner vil bli kapitler ved å legge til kapittel tall., Start nummerering FORBEREDELSE-PRODUKT FOR BRUK med nummer 4. Vi vil legge til noen flere kapitler i neste trinn.
    6. Avgjøre hvilke emner vil bli avsnitt ved å legge til den delen tall.
    7. Avgjøre hvilke emner vil bli sub-avsnittene ved å legge til den første ledd tall.

    Du har nå opprettet en Innholdsfortegnelse (ToC). Innholdsfortegnelsen er omrisset av brukerhåndboken. Senere vil vi legge til noen flere emner/deler, som Innledning, Sikkerhet, Informasjon osv. så ikke bekymre deg for å legge til det nå.,

    Trinn 5 Skape Meningsfulle Overskrifter

    Hvert emne i brukerhåndboken får sin egen vei. Overskriftene er (sub-)titler som er forut for den faktiske teksten. De vises i Innholdsfortegnelsen, slik at brukeren kan navigere til nødvendig informasjon.

    Så, Philip har nettopp opprettet (sub-)titler for sine emner.

    Fordi Innholdsfortegnelsen oppføringer spille en så viktig rolle i å hjelpe brukeren til å finne sin måte, og å hjelpe dem til å hoppe over det som IKKE er viktige, de trenger litt mer oppmerksomhet.

    i Utgangspunktet, bør du prøve å jobbe med tre nivåer av overskrifter: første-, andre – og tredje-nivå overskrifter.,

    første nivå overskriften beskriver det hele kapitlet eller avsnittet er om (f.eks. INSTALLASJON AV PRODUKTET). Det andre nivået overskrifter bør bruke ‘hvordan’ stil av formuleringer (for eksempel Hvordan man setter Sammen Produktet og Hvordan du skal Gjøre den Elektriske Installasjonen). Et tredje nivå overskriften bruker substantiv-setninger (f.eks. Emballasje innhold og Verktøy som skal brukes).

    jeg spurte Philip til å omdirigere sine overskrifter og å ta varsel av følgende generelle retningslinjer:

    • Bruk strukturen som vist ovenfor for første, andre og tredje nivå overskriften.,
    • Kontroller at overskriftene er selvforklarende. Overskriften å Gjøre Pannekaker er mye mer brukerorientert enn å Bruke MagicCook5000.
    • Påse at overskriften dekker hele emnet. Hvis den delen dekker vedlikehold og reparasjon av produktet, overskriften Vedlikehold vil være ufullstendig.
    • Hvis det er mulig, prøve å utelate artikler i begynnelsen av overskrifter

    Følgende: Skrive nye overskrifter for Innholdsfortegnelsen oppføringer.

    Philips ‘ s ToC med meningsfulle overskrifter kan bli funnet på Innholdsfortegnelsen w. Meningsfulle Overskrifter kategorien.,

    Trinn 6 Bestemme det Rettslige Innholdet

    Avhengig av markedet hvor produktet er plassert i eller satt inn i tjeneste, og avhengig av varegruppe produktet tilhører, spesifikk lovgivning som gjelder for ditt produkt.

    I den generelle lovgivningen krever at produktet er «trygge», og derfor gir de generelle sikkerhetskravene for produktet ditt skal møte.

    Disse kravene omfatter også krav til innholdet av din bruker-håndboken og sikkerhetsinstruksjonene.,

    for å selge produktet i et bestemt marked, bør du sørge for at din brukerveiledning samsvar med disse kravene.

    Disse to artiklene nedenfor vil fortelle deg hvordan du kan finne ut nøyaktig hvilke støtteordninger som gjelder for produktet ditt for det Europeiske og AMERIKANSKE markedet, og hva som kreves for brukerveiledning. Pro tip: hvis det er en Erklæring av Samsvar tilgjengelig allerede, kan du finne det gjeldende direktiver i det.,

    • Hvordan å Lage Kompatible Håndbøker for EU
    • Hvordan å Lage Kompatible Håndbøker for OSS

    Philip ikke trenger å utføre disse trinnene, som mal han brukte inneholdt lovlig innhold som kreves av de relevante direktiver.

    For sitt produkt, det betyr at følgende informasjon er nødvendig for brukerveiledning for sitt produkt:

    EU (relevante CE-merking direktiver: LVD, EMC, RoHS WEEE, REACH):

    • brukerhåndboken må være oversatt til det språk(s) i det landet der produktet selges.,
    • brukerhåndboken må beskrive tiltenkt bruk av produktet.
    • brukerhåndboken må beskrive rimelig forutsett ikke tiltenkt bruk av produktet.
    • Hvis det er aktuelt, ikke-samsvar i boligområder bør nevnes.
    • type, batch eller serienummer eller et annet element slik at produktet identifikasjon bør være nevnt på produktet. Hvis produktet er for liten, kan dette være plassert i brukerhåndboken.
    • navn, registrert varemerke eller et registrert varemerke og postadresse bør være nevnt på produktet., Hvis produktet er for liten, kan dette være plassert i brukerhåndboken.
    • En risikoanalyse bør være utført for å bestemme den gjenværende risikoer knyttet til bruk av produktet. Sikkerheten skal det gis opplysninger for å informere brukeren av tiltak for å bli tatt.
    • WEEE-informasjon skal inkluderes
    • Informasjon om emballasje avfall skal være inkludert.

    i Tillegg til denne lovgivning, skal det også er en internasjonal standard for bruksanvisninger, IEC/IEEE 82079-1:2019. Denne standarden har blitt harmonisert i EU., Samsvar med harmoniserte standarder gir en antagelse om samsvar med den tilsvarende lovgivning!

    brukerveiledning malen er i samsvar med denne standard.

    jeg har også laget en IEC 82079 sjekkliste som kan brukes til å dobbeltsjekke at brukerhåndboken er i samsvar med denne standard.

    for å opprette et internasjonalt kompatibel brukerveiledning, bør du alltid sørge for at manuell oppfyller EU, USA og 80279 krav.,

    Handling: Å avgjøre rettslige krav på din brukerveiledning:

    1. Følg trinn 1 og 2 fra EU-garanti og/eller trinn 1-6 fra OSS samsvar artiklene for å fastslå det juridiske rammeverket for din instruksjoner.
    2. Studere IEC 82079 sjekkliste for å sikre at håndboken er i samsvar med 82079 standard.

    I denne videoen vil jeg forklare hvordan du kan lage en manual som er i samsvar med 82079 standard:

    TIL BUTIKKEN

    Trinn 7 Laste ned og Forberede Brukerveiledning Mal

    Nå Philip kan starte selve etableringen av hans brukerveiledning.,

    jeg ba ham om å justere innholdsfortegnelse av malen i henhold til sin egen innholdsfortegnelse. Uten å fjerne og obligatoriske elementer i kurset…

    husker du fra trinn 4, som jeg bedt om å starte nummereringen av kapitlene med kapittel 4? Når du laste ned brukerveiledning mal doc deg selv, vil du se at noen standard kapitlene har blitt lagt til, samt noen bilag.,

    Handling: for Å justere brukerveiledning mal:

    Hvis du ønsker å jobbe med gratis mal:

    1. Last ned gratis brukerveiledning mal i Word 2013 eller 2007
    2. Endre overskriftene i henhold til din egen Innholdsfortegnelsen. Varsel! Ikke juster Innholdsfortegnelse. Innholdsfortegnelse kan bli oppdatert automatisk når du har justert overskriftene.
    3. Legg til obligatorisk innhold som fastsettes i trinn 6 av din bruksanvisning.
    4. Hvis det er aktuelt, endre deler 1-3 og bilag i henhold til dine egne behov.,

    Eller bruk en av våre betalt maler som inneholder alle obligatoriske innhold, som Philip gjorde:

    • Medisinsk Utstyr EU
    • Medisinske Enheter OSS
    • Maskiner EU
    • Maskiner OSS
    • Elektronikk EU
    • Leker EU

    Trinn 8 Opprette Innhold for Din Brukerveiledning Mal

    Skriv den Tiltenkte Bruken

    Hensikten med produktet, eller bedre: den er tiltenkt, er hjertet av en brukerhåndbok og danner grunnlaget for å sikre trygg og sunn bruk av produktet.,

    Den måten den tiltenkte bruk er beskrevet bestemmer også ditt ansvar og påvirker den videre innholdet i brukerhåndboken.

    Den mest lovgivning krever at du skal inneholde en beskrivelse av den planlagte bruk i bruksanvisningen.

    Den internasjonale standarden for instruksjoner, IEC 82079-1, gir følgende definisjon for tiltenkt bruk:

    Et komplett utvalg av funksjoner eller forutsett programmer definert og utviklet av leverandøren av produktet

    Ved å beskrive den tiltenkte bruken, bestemmer du trygt konvolutt av produktet., Og når du har bestemt deg for den tiltenkte bruken, kan du fokusere på å gi bare de sikkerhets-og bruksanvisningen for hvordan du bruker produktet innen gitt konvolutt.

    i Tillegg til tiltenkt bruk, mange flere standarder, forskrifter og regelverk krever også at du skal inneholde en beskrivelse av rimelig forutsigbart misbruk.

    For eksempel, er det rimelig forutsigbart misbruk av en aggressiv såpe kan være bruken av det i en food processing miljø.

    å Betale for lite oppmerksomhet til å beskrive rimelig forutsigbart misbruk vil påvirke selskapets ansvar.,

    produktansvar lover/forskrifter hold en produsent ansvarlig for et defekt produkt. Hvis defectiveness av et produkt må være bestemt, alle omstendigheter tatt i betraktning. Som inkluderer rimelig forutsigbart bruk av produktet.

    beskrivelsen av den tiltenkte bruken, bestemmer hvilke instruksjoner som er gitt i resten av håndboken. For eksempel, hvis et kjølesystem er bare brukt til kjøling visse medisiner, så er det bare disse prosedyrene må være beskrevet.,
    Når det rimelighet kunne forutses at kjølesystemet kan bli brukt som et system for å kjøle organer, bør dette være beskrevet i instruksjonene. Ved å gjøre dette, du, som produsent, vil begrense ansvar og du kan fokusere på å bare beskrive hvordan du bruker systemet for å kjøle legemidler.

    Følgende: skrive den hadde til hensikt å bruke, og rimelig forutsigbart misbruk av produktet.


    Figur 1. Rimelig forutsigbart misbruk?,

    Skriv sikkerhet advarsler basert på risikoanalyse

    Selv om den tiltenkte bruken har nå vært klart definert, dette betyr ikke at du bruker et produkt som er helt uten risiko.

    for Å identifisere farer som kommer med bruken av et produkt, kan du gjennomføre en risikoanalyse. En risikoanalyse kan også være obligatorisk for visse varegrupper, slik som lav-spenning utstyr, leker, maskiner og utstyr for bruk i eksplosive atmosfærer.

    Standarder, som ISO 12100, har blitt utviklet på hvordan gjennomføre en risikoanalyse., ISO 12100 gir også en metode for å ta avbøtende tiltak: de Tre-Trinns Metode. I henhold til denne metoden, er det følgende hierarki av risikoreduserende tiltak:

    1. Iboende trygt design tiltak
    2. Ivareta og utfyllende beskyttende tiltak
    3. Informasjon for bruk

    Dette betyr at brukerveiledningen bør advare om gjenværende risikoer knyttet til bruk av produktet. Dette er gjort med sikkerhet advarsler.,

    KJØP NÅ

    En god sikkerhet advarsel beskriver arten av en farlig situasjon, og konsekvensene av ikke å unngå en farlig situasjon og metode(r) for å unngå det.

    for Å angi graden av fare som kan oppstå av brukeren, signal ord som «Fare», «Advarsel» og «Forsiktig» bør brukes.

    ta en titt på følgende sikkerhet meldinger:

    ADVARSEL! Roterende deler. Risiko for alvorlige skader. Hold hendene klart. Lockout/Tagout før service.

    Så du ønsker å advare brukeren hvor en farlig situasjon kan oppstå. ANSI Z535.,6 standard beskriver følgende steder i bruksanvisningen, der dette kan være:

    • Gruppert i et eget kapittel.
    • I den første delen av den spesifikke delen:
    • Innebygd i en fremgangsmåte:

    1. Gjøre dette.
    2. Gjøre det. ADVARSEL! Dette er innebygd sikkerhet meldinger. Generell tekst generell tekst generell tekst.
    3. Gjøre dette.,

    • I Forordet noen supplerende direktiver kan plasseres, for eksempel Les alle instruksjonene før bruk eller Oppbevar disse instruksjonene for fremtidig referanse, og kan plasseres i innføringen av en brukerveiledning.

    I EU, avhengig av type produkt, det kan være tillatt å gi bare sikkerhetsinformasjonen i trykt form og resten av opplysninger på nettet.

    for å hjelpe Philip opprette og plassere en sikkerhet melding, jeg har opprettet en ny mal.

    Tiltak: gjennomføre en risikoanalyse, og lag din sikkerhet meldinger ved hjelp av denne malen.,

    Opprett alt annet innhold

    Nå er jeg spurte Philip til å lage alt annet innhold, for eksempel prosedyrer, tekniske spesifikasjoner og juridisk informasjon.

    jeg ga følgende tips:

    • Utelat unødvendig materiale for å unngå informasjon overbelastning (for eksempel salg forfremmelse, omfattende gjentakelse etc.).
    • sørge for at vilkårene er kjent for brukeren, tekniske funksjoner og termer som er godt forklart og bruker vilkårene konsekvent.
    • Beskrive noen forutsetninger som bør være oppfylt før det faktiske instruksjonene start., Dette kan også være å beskrive spesielle verktøy eller plass for vedlikehold og reparasjon.
    • Sørge for konseptuelle informasjon når informasjon er nødvendig for en adekvat forståelse og utførelse av oppgaver.
    • Alltid skrive emnet bygger på.
    • Bruk en fet skrift for alle produkt-elementer.
    • Bruk en style guide for å hjelpe deg med å skrive og formatere dokumentasjon på en klarere måte.
    • Angi når du vil legge til et bilde for bedre å forstå senere.
    • sørge for at ord og uttrykk er ikke altfor komplisert eller over-sofistikert.,
    • Bruke enkle/standardisert og korte setninger: en setning-én kommando.
    • ikke legg for mye informasjon inn i en setning.
    • Bruke direkte, aktiv og selvsikker stemme kommandoer.
    • Bruke ord som substantiv og verb konsekvent å unngå tvetydighet.
    • for Å skrive bedre instruksjoner, kan du bruke Prinsippene i Minimalismen i Teknisk Kommunikasjon og Forenklet Teknisk engelsk.

    Følgende: lage alt annet innhold for din brukerveiledning.

    Igjen, for de fleste varegrupper som det er betalt maler tilgjengelig som kan gjøre arbeidet lettere., Disse malene inneholder alle juridiske tekster, obligatorisk disposisjon informasjon, copyright uttalelser og i samsvar med IEC 82079 standard på bruksanvisningen.

    Legg sikkerhet advarsler i riktig posisjon

    Når du bruker malen for å skape sikkerhet meldinger, jeg spurte Philip til å indikere hvorvidt en sikkerhet meldingen er en supplerende direktiv, eller bør være plassert som et gruppert, delen eller innebygd sikkerhet melding.

    Nå er all tekst har blitt opprettet, sikkerhetsmeldinger, og kan plasseres på rett sted.,

    Følgende: plasser alle sikkerhetsmeldingene på riktig sted i brukerhåndboken.

    Trinn 9 Legge til Navigasjon til Din Brukerveiledning Mal

    En brukerveiledning som skal gi hjelp til folk ved å gi informasjon om hvordan du bruker et produkt. Å finne den rette informasjonen som løser brukerens problem bør ta så lite tid som mulig.

    laging av meningsfulle overskrifter er en av de verktøy som hjelper brukere med å finne informasjon., Det er imidlertid flere andre verktøy for å hjelpe brukeren å finne den informasjonen han/hun ønsker, for eksempel:

    • innholdsfortegnelse
    • sidetall
    • Indeks

    jeg spurte Philip for å oppdatere innholdsfortegnelsen og legge til sidetall og en indeks.

    Følgende: Legge til eller oppdatere innholdsfortegnelsen, sidetall og stikkordregister.

    Trinn 10 Har Din Brukerveiledning Anmeldt

    Philip har nå opprettet utkast versjon av sin brukerveiledning, med brukerveiledning mal. Vi kaller denne versjonen tekstinnholdet design.,
    Som Philip har et business partner og en utvikler med bred faglig kjennskap til produktet, jeg spurte Philip til å la dem gå gjennom arbeid så langt.
    Både for hans business partner og developer gitt tilbakemelding. Philip brukt denne tilbakemeldinger for å optimalisere brukerveiledning.
    Handling: Sende utkast versjon av brukerveiledningen til alle som er med i teamet som kan være i stand til å levere tilbakemelding. Be dem om å slå sammen alle tilbakemeldingene i ett dokument før du sender det tilbake til deg. Dette stimulerer til diskusjon i teamet og hindrer uenighet på et senere tidspunkt.,

    Trinn 11 Skape Bilder

    Når brukerveiledning har blitt gjennomgått og optimalisert, tekstene er mer eller mindre klar. Dette betyr at alle bilder kan nå bli opprettet og lagt til innholdet.

    Det grunn til å vente til de tekstene som er klar er at du oppretter eller redigerer bilder kan være tidkrevende. Som bildene skal støtte, erstatte eller utfylle teksten, du vil vente med å opprette dem til tekster er endelige.

    Bilder i bruksanvisninger kan inneholde illustrasjoner, bilder, skjermbilder, tabeller, diagrammer og skjemaer.,

    Det er mange gode verktøy som kan hjelpe deg å lage dine bilder, for eksempel:

    • Snagit eller Adobe Photoshop for redigering skjermbilder eller bilder
    • Solidworks Komponist eller Google Sketchup for å skape linje tegninger
    • Lucidchart eller Microsoft Visio for diagrammer og skjemaer

    jeg oppmerksom på Philip ikke til å bruke bildene som en billig alternativ for illustrasjoner. Ofte, bilder er ikke så lærerikt, fordi de inneholder for mye informasjon. I tillegg til at bilder kan gjøre en brukerveiledning ser rotete.,

    derfor, Philip brukt Google Sketchup for å opprette hans illustrasjoner.

    Følgende: Lage bilder for dine brukerveiledning.

    Hvis du ønsker å vite mer om hvordan du oppretter bilder:

    • ved Hjelp av tekst, bilder eller video
    • Opprette IKEA-ish håndbøker

    Trinn 12 Siste Sjekk i brukerhåndboken Mal

    Før vi begynner å gjøre det ser fin og oversette innholdet, vi ønsker å være sikker på at innholdet er fullført.

    for å gjøre så, jeg spurte Philip å bruke en sjekkliste.,

    Følgende: l sørg for at bruker-håndboken er i samsvar med alle relevante krav fra IEC 82079-1:2012 ved hjelp av denne sjekklisten.

    Trinn 13 Designe Din Brukerveiledning Mal

    En godt utformet manuell bidrar til en bedre merkevare og brukeropplevelse.

    Du kan justere Brukerveiledning Mal i MS Word ved å legge til en firmalogo og justere fonter, farger, et cetera, men det kan ha begrensninger.

    Når du vet hvordan du skal arbeide med Adobe Indesign, eller er villig til å lære å jobbe med det, at dette vil gi deg mye større muligheter for design.,

    jeg opprettet denne malen i Indesign og spurte Philip å tilpasse det til å matche sin merkevare identitet.

    Følgende: Justere Brukerveiledning Malen til å passe din merkevare identitet, eller laste ned InDesign brukerveiledning mal og justere det.

    Trinn 14 DTP Fungerer

    DTP står for Desktop Publishing og Wikipedia beskriver det som «opprettelse av dokumenter ved hjelp av side-layout ferdigheter på en personlig datamaskin først og fremst for print’.

    Philip nå har både innhold av hans brukerveiledning (Word-fil) og brukerveiledning mal (InDesign-fil)., Innholdet behov for å bli satt inn i InDesign-mal. Dette kalles Desktop Publishing.

    Følgende: plasser innhold fra Word-filen inn i Indesign-mal. Hvis du bestemte deg for ikke å bruke InDesign-mal, men fast til Word-fil, så kan du hoppe over dette trinnet.

    Trinn 15 Oversette og Publisere dine Bruksanvisninger

    Avhengig av markedet i som du kommer til å selge produktet ditt, trenger du kanskje å oversette brukerveiledning.

    Noen generelle tips:

    • Se etter en oversetter med lignende erfaring., Dette kan være en oversetter som er erfarne i å oversette tekniske innhold, med lignende produkter eller med å oversette brukerhåndbøker.
    • Hvis du trenger å oversette til flere språk, og arbeider med en oversettelse byrå kan spare deg for mye tid.
    • Spør oversetteren eller organ om deres kvalitet prosedyrer, og som kommer til å revidere teksten etter oversettelse.
    • Som du vet produktet ditt beste, og hvem målgruppen din er, kan det være en god idé å gi oversetteren eller byrået en ordliste eller en liste med ord som du ønsker å bruke.,
    • Se etter en oversetter som kan jobbe direkte i Word-eller InDesign-fil eller finne et byrå som kan gjøre DTP fungerer så godt. Alternativt, kan du gjøre dette selv, selvfølgelig.

    Som Philip vil selge sitt produkt i både USA og EU, bestemte han seg for å jobbe med et byrå.

    Følgende: Finn en oversetter eller byrå som passer dine behov og din brukerveiledning oversatt.

    generelt er det en brukerveiledning bør være tilgjengelig i et format som er lett tilgjengelig for brukeren. Som kan skrives ut eller brukes på nettet eller på enheten.,

    Som en bruker ønsker informasjon i det øyeblikk han/hun har behov for det, og dermed tror ikke på tv, er den beste tilnærmingen ville være å gi instrukser omni-plattformen.

    I den Europeiske Union, for noen varegrupper, det er fortsatt begrenset til å gi brukerveiledning trykt med produktet.
    Men som av April 2016, instruksjonene for mange varegrupper kan leveres i et annet format i stedet for på papir. Det er ett unntak.

    Sikkerhetsinformasjon skal fortsatt leveres i papir form, sammen med produktet., I tillegg til at, på forespørsel fra en forbruker, et papir brukerhåndboken må gjøres tilgjengelig for forbrukeren.

    Philip besluttet følgende:

    • Han gir en trykt full manuell med produktet, inkludert sikkerhetsanvisningene.
    • Han opprettet en egen quick start guide til å være som følger med produktet så vel.
    • Han plassert en pdf-versjon av den fullstendige brukerveiledningen på nettet.
    • Han vil opprette en online-hjelp-delen på hans hjemmeside med HTML-versjonen av brukerhåndboken. Her kan han legge til videoer, så vel., Og ved å optimalisere HTML-versjon for søkemotorer han gjør det enklere for brukeren hans for å finne informasjon til brukeren hans

    Konklusjon

    Det er alt det er til det. Det er hvordan Philip opprettet en kompatibel brukerveiledning med hjelp fra Brukerhåndbøker Mal og andre tilgjengelige verktøy som jeg følger.

    Den beste av alt dette er at du kan få de samme resultatene som Filip gjorde ved å følge denne trinn-for-trinn på hvordan å lage en brukerveiledning.