Stap 1 Algemene kennis verwerven over de gebruikershandleiding sjabloon
voordat ik de gebruikershandleiding sjabloon en de Andere gereedschappen die ik voor Philip heb ontwikkeld, daadwerkelijk gebruik wilde ik er zeker van zijn dat we hetzelfde uitgangspunt hebben. Ik gaf hem wat Algemene informatie over gebruikersinstructies en enkele goede voorbeelden van bestaande gebruikershandleidingen.
Ik heb deze informatie hieronder opgesomd.,
Wat is de definitie van een gebruikershandleiding?
een gebruikershandleiding is een technisch communicatiedocument dat bedoeld is om mensen te helpen bij het gebruik van een product. Een goede gebruikershandleiding helpt gebruikers bij het veilig, gezond en effectief gebruiken van een product.,
Andere namen, of andere vormen van een gebruikershandleiding kan worden:
- User-guide
- Technische documentatie
- handleiding
- handleiding
- handleiding
- Quick Start Guide
- – Installatie handleiding
- handleiding
- Software handleiding kunt gebruiken
Naast het primaire doel van een gebruikershandleiding (om te helpen een gebruiker), secundaire doelen kunnen zijn het creëren van een betere gebruikerservaring en het voldoen aan de wettelijke eisen.
een gebruikershandleiding bestaat uit tekstuele visuele informatie (Illustraties, schermafbeeldingen, tabellen enz.,) om de gebruiker te helpen bij het voltooien van specifieke taken.
De gebruiker speelt de centrale rol bij het opstellen van een gebruikershandleiding. Een goed opgestelde gebruikershandleiding bevat alleen die informatie die relevant is voor de beoogde gebruiker van het product.
de gebruikershandleiding moet zowel procedurele informatie (stapsgewijze instructies) als conceptuele informatie (informatie die de gebruiker nodig heeft om procedurele informatie te begrijpen) bevatten.
een goede gebruikershandleiding is beknopt en gebruikt jargon-vrije taal. Een goede gebruikershandleiding moet beantwoorden hoe en welke vragen., Ze moeten informatie bevatten over wat er gebeurt als een taak niet correct wordt uitgevoerd.
in sommige gevallen is een product bedoeld om door verschillende soorten gebruikers te worden gebruikt. Typische gebruikerstypen zijn de eindgebruiker, installateur, onderhoudstechnicus en operator. Elk type gebruiker heeft een andere aanpak nodig in termen van de te gebruiken taal, de toon van de stem en de verstrekte conceptuele informatie.
welke informatie moet in een gebruikershandleiding staan?
verschillende soorten producten hebben een gebruikershandleiding nodig. Een product kan een systeem, Gereedschap, apparaat, instrument, Software of app zijn.,aarschuwingen
met Behulp van een handleiding sjabloon
Het belangrijkste instrument dat ik heb ontwikkeld om te helpen Philip stellen zijn handboek is een Handleiding Sjabloon., De sjabloon bevat alle informatie en meer uit de bovenstaande lijst. Het voldoet aan de eisen voor zijn product.
het sjabloon voor gebruikershandleidingen kan worden gebruikt voor het maken van uw handleiding voor uw systeem, Gereedschap, apparaat, instrument, of voor het maken van een installatiehandleiding, softwarehandleiding, bedieningshandleiding, onderhoudshandleiding of trainingshandleiding.
Op basis van het eerste sjabloon voor Philip hebben we sjablonen ontwikkeld voor de volgende productgroepen:
- medische hulpmiddelen
- Speelgoed
- Machines
- Elektronica
welke formaten heeft een gebruikershandleiding?,
gebruikershandleidingen kunnen worden verstrekt in papieren vorm of als een elektronisch document (PDF of online of op het apparaat in HTML). De handleiding sjabloon is een MS Word-document dat kan worden afgedrukt of online geplaatst.
gebruikershandleidingen kunnen worden gemaakt met behulp van een verscheidenheid aan hulpmiddelen. Elk gereedschap heeft zijn eigen voor-en nadelen., inhoud mogelijk
Alle-in-één oplossing
Omni-platform publicaties
Bevat de standaard handleiding sjablonen
gebruikershandleiding voorbeelden
Tijdens het opstellen van een gebruikershandleiding met behulp van de Handleiding Sjabloon, het kan handig zijn om een aantal goede voorbeelden., Via de volgende links kunt u een voorbeeld van een gebruikershandleiding downloaden voor documentatie:
- IKEA installatiehandleiding
- Jura gebruikershandleiding
Stap 2 Identificeer de gebruiker (s) van uw sjabloon voor gebruikershandleidingen
Ok, dus nu heeft Philip enige basiskennis over gebruikershandleidingen. Laten we duiken in de details en acties.
wanneer u een handleiding wilt schrijven die uw gebruiker helpt problemen op te lossen, moet u eerst bepalen wie uw gebruiker is. Dit kan worden gedaan door een gebruikersprofiel aan te maken, ook wel een persona genoemd.,
met een persona maak je een aantal redelijke veronderstellingen over de kenmerken van je gebruiker. Dit is niet alleen nuttig voor het maken van uw gebruiksaanwijzing, maar het is een essentieel element aan het begin van de ontwikkeling van elk product! Als opgeleid industrieel ontwerpingenieur zijn we zo begonnen met al onze ontwerpopdrachten.
bij het controleren van de ISOVOX website, vond ik niet eens een duidelijke beschrijving van hun beoogde gebruikers. Daarom vroeg ik Philip om zijn gebruikers te definiëren en vragen te beantwoorden als:
- Wie is de gebruiker van uw product?,
- wordt het product professioneel of hoofdzakelijk particulier gebruikt?
- welke andere technische ervaringen hebben zij? Wat beschrijft de gebruiker?
Ik heb een sjabloon gemaakt dat de vragen bevat. Ik vroeg Philip om het sjabloon in te vullen.
u kunt de sjabloon zelf gebruiken om te bepalen wie uw gebruiker is. Houd er rekening mee dat het tweede tabblad ook Philip ‘ s antwoorden bevat, dus je hebt een voorbeeld van hoe het blad zou kunnen worden gebruikt.
Actie: gebruik de sjabloon om uw gebruiker(s) te beschrijven.
Ik ben een grote fan van het visualiseren van dingen., Dus als je nog een stap verder wilt gaan met het definiëren van je gebruiker, stel ik voor dat je je gebruiker visualiseert in de vorm van een persona. Bij het creëren van een persona geef je je gebruiker een naam, leeftijd enzovoort, zodat het een echte persoon wordt die jouw gebruiker vertegenwoordigt.
Ik deed dit voor Philip., Dit is het resultaat:
actie: Maak een visualisatie van uw gebruiker
Als u meer wilt weten over het definiëren van uw doelgroep en het creëren van persona ‘ s:
Stap 3 onderwerpen maken voor de problemen van uw gebruiker
begin met het identificeren van de problemen die uw gebruiker(s) kunnen tegenkomen tijdens de levenscyclus van het product en die hij/zij wil oplossen. Typische problemen kunnen zijn: het installeren van het product, het gebruik van het product, het veilig gebruiken van het product, het onderhoud van het product en het verwijderen van het product.,
als het probleem te complex is, kunt u het in brokken opsplitsen.
Ik vroeg Philip om de problemen en oplossingen te identificeren die zijn gebruiker zou kunnen tegenkomen tijdens de levenscyclus van het product. Om dat te doen, heb ik een ander sjabloon gemaakt voor Philip. In de linkerkolom van het tabblad levenscyclus worden de fasen van de levenscyclus van een product vermeld. Deze zijn afgeleid van de internationale standaard voor gebruikersinstructies, de IEC/IEEE 82079. Onze sjablonen voor gebruikershandleidingen voldoen aan deze standaard.
op het tabblad levenscyclus ziet u hoe Philip de levenscyclus heeft aangepast aan zijn eigen product.,
actie: Gebruik dit sjabloon en de instructies op het eerste tabblad om de problemen te identificeren die uw gebruiker kan hebben tijdens de levenscyclus van uw product en hun oplossingen te presenteren.,
Als u meer wilt weten over het definiëren van uw gebruiker problemen en het creëren van onderwerpen:
- Item-based authoring
- Minimalisme
- Information mapping
- Chunking
Stap 4 Bepalen de Structuur van de Handleiding Sjabloon
Philip heeft nu vastgesteld dat de problemen een gebruiker kan met zijn product tijdens zijn levensduur en heeft hij nu dacht van de oplossing van het probleem op te lossen. Met andere woorden: Philip heeft de onderwerpen voor zijn gebruikershandleiding gedefinieerd., Elk onderwerp kan slechts over één specifiek onderwerp gaan, heeft een identificeerbaar doel en moet op zichzelf kunnen staan.
een onderwerp moet het antwoord geven op de vraag van slechts één gebruiker. Een gebruiker wil één probleem tegelijk oplossen. Wanneer een gebruiker het probleem heeft opgelost, zal hij / zij het volgende probleem gaan oplossen.
een onderwerp wordt een sectie in de gebruikershandleiding. Het kan een hoofdstuk of een (sub)alinea zijn. Zodra een gebruiker op zoek is naar een antwoord op zijn probleem, zal hij de inhoudsopgave gebruiken om erachter te komen hoe hij naar dat antwoord kan navigeren.,
Ik vroeg Philip om de onderwerpen te structureren en hun plaats in de gebruikershandleiding te definiëren, door een bepaald onderwerp toe te wijzen aan een specifiek hoofdstuk of (sub)paragraaf. Het resultaat is te zien op het tabblad ToC.
actie: om de structuur van uw gebruikershandleiding te definiëren:
- kopieer de inhoud van het tabblad Lifecycle naar het tabblad ToC.
- vervang op het tabblad ToC de productnaam door uw eigen productnaam.
- voeg een kolom aan de linkerkant toe. Noem het ‘sectie’.
- indien van toepassing, Organiseer uw secties logisch.
- Bepaal welke onderwerpen hoofdstukken worden door hoofdstuknummers toe te voegen., Start nummering voorbereiding PRODUCT voor gebruik met nummer 4. We zullen wat meer hoofdstukken toevoegen in de volgende stap.
- Bepaal welke onderwerpen alinea ‘ s worden door de sectienummers toe te voegen.
- Bepaal welke onderwerpen subparagrafen worden door de subsectienummers toe te voegen.
U hebt nu de inhoudsopgave (ToC) aangemaakt. De ToC is de omtrek van uw gebruikershandleiding. Later zullen we nog wat meer onderwerpen/secties toevoegen, zoals de introductie, veiligheidsinformatie etc. dus maak je geen zorgen over het toevoegen van dat nu.,
Stap 5 Maak betekenisvolle koppen
elk onderwerp in de gebruikershandleiding krijgt zijn eigen kop. De titels zijn de (sub)titels die aan de eigenlijke tekst voorafgaan. Ze verschijnen in de ToC, zodat de gebruiker kan navigeren naar de benodigde informatie.
dus, Philip heeft zojuist de (sub-)titels voor zijn onderwerpen gemaakt.
omdat de TOC-items zo ‘ n belangrijke rol spelen in het helpen van uw gebruiker om hun weg te vinden, en om hen te helpen overslaan wat niet belangrijk is, hebben ze wat meer aandacht nodig.
in principe moet je proberen te werken met drie niveaus van kopjes: kopjes op het eerste, tweede en derde niveau.,
de kop op het eerste niveau beschrijft waar het hele hoofdstuk of sectie over gaat (bijvoorbeeld de installatie van het PRODUCT). De titels van het tweede niveau moeten de ‘hoe wat’ – stijl van frasering gebruiken (bijvoorbeeld hoe het Product te monteren en hoe de elektrische installatie te doen). In een rubriek van het derde niveau worden zelfstandige naamwoorden gebruikt (bv. de inhoud van de verpakking en de te gebruiken hulpmiddelen).
Ik vroeg Philip om zijn headings om te buigen en de volgende algemene richtlijnen in acht te nemen:
- gebruik de structuur zoals hierboven getoond voor de heading van het eerste, tweede en derde niveau.,
- zorg ervoor dat de koppen voor zichzelf spreken. De rubriek pannenkoeken maken is veel gebruikersgerichter dan het gebruik van de MagicCook5000.
- zorg ervoor dat de kop het volledige onderwerp bestrijkt. Indien de afdeling het onderhoud en de reparatie van een product omvat, zou de rubriek onderhoud onvolledig zijn.
- indien mogelijk, probeer artikelen weg te laten aan het begin van headings
actie: schrijf nieuwe headings voor uw ToC-items.
Philips ToC met betekenisvolle koppen is te vinden op het tabblad ToC w. betekenisvolle koppen.,
Stap 6 Bepaal de wettelijke inhoud
afhankelijk van de markt waar uw product wordt geplaatst of in gebruik genomen, en afhankelijk van de productgroep waartoe uw product behoort, is specifieke wetgeving van toepassing op uw product.
in het algemeen vereist de wetgeving dat uw product ‘veilig’ is en geeft daarom algemene veiligheidseisen waaraan uw product moet voldoen.
deze eisen omvatten ook eisen met betrekking tot de inhoud van uw gebruikershandleiding en veiligheidsinstructies.,
om uw product op een specifieke markt te verkopen, moet u ervoor zorgen dat uw gebruikershandleiding aan deze vereisten voldoet.
deze twee artikelen hieronder vertellen u hoe u precies kunt achterhalen welke wetgeving van toepassing is op uw product voor de Europese en Amerikaanse markt en wat de vereisten zijn voor uw gebruikershandleiding. Tip voor experts: als er al een conformiteitsverklaring beschikbaar is, vindt u daar de toepasselijke richtlijnen.,
- How to Create Compliant Manuals for the EU
- How to Create Compliant Manuals for the US
Philip hoefde deze stappen niet uit te voeren, omdat het sjabloon dat hij gebruikte al de wettelijke inhoud bevatte zoals vereist door de relevante richtlijnen.
voor zijn product betekent dit dat de volgende informatie vereist is voor de gebruikershandleiding voor zijn product:
EU (relevante ce-markeringrichtlijnen: LVD, EMC, RoHS, AEEA, REACH):
- de gebruikershandleiding moet worden vertaald naar de taal of talen van het land waar het product wordt verkocht.,
- in de gebruikershandleiding moet het beoogde gebruik van het product worden beschreven.
- in de gebruikershandleiding moet het redelijkerwijs te verwachten onbedoelde gebruik van het product worden beschreven.
- indien van toepassing, moet de niet-naleving in woonwijken worden vermeld.
- het type -, partij-of serienummer of een ander element aan de hand waarvan het product kan worden geïdentificeerd, moet op het product worden vermeld. Als het product te klein is, kan dit in de gebruikershandleiding geplaatst worden.
- de naam, de geregistreerde handelsnaam of het geregistreerde handelsmerk en het postadres moeten op het product worden vermeld., Als het product te klein is, kan dit in de gebruikershandleiding geplaatst worden.
- Er moet een risicoanalyse worden uitgevoerd om de restrisico ‘ s van het gebruik van het product te bepalen. Er wordt veiligheidsinformatie verstrekt om de gebruiker te informeren over de te nemen maatregelen.
- AEEA-informatie moet worden opgenomen
- informatie over verpakkingsafval moet worden opgenomen.
naast deze wetgeving bestaat er ook een internationale standaard voor gebruikershandleidingen, de IEC / IEEE 82079-1: 2019. Deze norm is in de EU geharmoniseerd., Naleving van geharmoniseerde normen is een vermoeden van overeenstemming met de desbetreffende wetgeving!
het sjabloon voor de gebruikershandleiding voldoet aan deze standaard.
Ik heb ook een IEC 82079 checklist gemaakt die kan worden gebruikt om te controleren of uw gebruikershandleiding aan deze standaard voldoet.
om een internationaal conforme gebruikershandleiding te maken, moet u er altijd voor zorgen dat uw handleiding voldoet aan de EU -, VS-en 80279-vereisten.,
actie: om de wettelijke vereisten in uw gebruikershandleiding te bepalen:
- Volg stappen 1-2 van de EU-naleving en/of stappen 1-6 van de Amerikaanse nalevingsartikelen om het wettelijke kader voor uw instructies te bepalen.
- Bestudeer de checklist van IEC 82079 om er zeker van te zijn dat uw handleiding voldoet aan de 82079-norm.
In deze video leg ik uit hoe je een handleiding kunt maken die voldoet aan de 82079 standaard:
naar de STORE
Stap 7 Download en bereid de gebruikershandleiding sjabloon
nu kan Philip de eigenlijke creatie van zijn gebruikershandleiding starten.,
Ik vroeg hem de inhoudsopgave van het sjabloon aan te passen aan zijn eigen inhoudsopgave. Zonder het verwijderen en verplichte elementen natuurlijk…
weet u nog dat ik in Stap 4 gevraagd heb om de nummering van de secties te starten met hoofdstuk 4? Zodra u de gebruikershandleiding template doc zelf downloadt, zult u zien dat een paar standaard hoofdstukken zijn toegevoegd, evenals enkele bijlagen.,
actie: om de gebruikershandleiding aan te passen sjabloon:
Als u met de gratis sjabloon wilt werken:
- Download de gratis gebruikershandleiding Sjabloon Word 2013 of 2007
- Wijzig de sectiekoppen volgens uw eigen ToC. Let op! De inhoudsopgave niet aanpassen. De inhoudsopgave kan automatisch worden bijgewerkt zodra u de sectiekoppen hebt aangepast.
- voeg de verplichte inhoud toe zoals bepaald in Stap 6 van uw handleiding.
- indien van toepassing, wijzig de paragrafen 1-3 en de bijlagen volgens uw eigen behoeften.,
Of gebruik één van onze betaalde templates bevatten alle verplichte inhoud, zoals Philip deed:
- Medische Apparatuur EU –
- Medische Apparatuur ONS
- Machines EU –
- Machines ONS
- Elektronica EU –
- Speelgoed EU –
Stap 8 Maak de Content voor Uw Gebruiksaanwijzing Sjabloon
Schrijf de Beoogde Gebruik
Het doel van uw product, of beter: de beoogde gebruik, is de hart van een gebruikershandleiding en vormt de basis voor het waarborgen van een veilig en gezond gebruik van het product.,
de manier waarop het beoogde gebruik wordt beschreven bepaalt ook uw aansprakelijkheid en beïnvloedt de verdere inhoud van de gebruikershandleiding.
De meeste wetgeving vereist dat u een beschrijving van het beoogde gebruik in de gebruikersinstructies opneemt.
De internationale standaard voor gebruikersinstructies, IEC 82079-1, geeft de volgende definitie voor het beoogde gebruik:
een uitputtend scala aan functies of verwachte toepassingen gedefinieerd en ontworpen door de leverancier van het product
door het beoogde gebruik te beschrijven, bepaalt u de veilige envelop van het product., En zodra u het beoogde gebruik hebt bepaald, kunt u zich richten op het verstrekken van alleen die veiligheids-en gebruikersinstructies voor hoe u het product binnen de opgegeven envelop moet gebruiken.
naast het beoogde gebruik vereisen veel meer normen, richtlijnen en verordeningen ook een beschrijving van het redelijkerwijs te verwachten misbruik.
het redelijkerwijs te verwachten misbruik van een agressief detergens kan bijvoorbeeld het gebruik ervan in een voedselverwerkingsomgeving zijn.
te weinig aandacht besteden aan het beschrijven van het redelijkerwijs te verwachten misbruik zal van invloed zijn op de aansprakelijkheid van een onderneming.,
productaansprakelijkheid wetten / regelgeving stellen een fabrikant aansprakelijk voor een product met gebreken. Als de defectiviteit van een product moet worden bepaald, zal met alle omstandigheden rekening worden gehouden. Hieronder valt ook het redelijkerwijs te verwachten gebruik van het product.
de beschrijving van het beoogde gebruik bepaalt welke instructies in de rest van de handleiding worden gegeven. Bijvoorbeeld, als een koelsysteem alleen wordt gebruikt voor het koelen van bepaalde medicijnen, dan hoeven alleen deze procedures te worden beschreven.,wanneer redelijkerwijs kan worden verwacht dat het koelsysteem kan worden gebruikt als een systeem om organen te koelen, moet dit in de instructies worden beschreven. Door dit te doen, beperkt u als fabrikant uw aansprakelijkheid en kunt u zich alleen richten op het beschrijven hoe u het systeem kunt gebruiken om medicijnen te koelen.
actie: schrijf het beoogde gebruik en het redelijkerwijs te verwachten misbruik van uw product.
figuur 1. Redelijkerwijs voorzienbaar misbruik?,
schrijf de veiligheidswaarschuwingen op basis van de risicoanalyse
hoewel het beoogde gebruik nu duidelijk is gedefinieerd, betekent dit niet dat het gebruik van een product volledig zonder risico ‘ s is.
om de gevaren van het gebruik van een product te identificeren, kunt u een risicoanalyse uitvoeren. Een risicoanalyse kan ook verplicht zijn voor bepaalde productgroepen, zoals laagspanningsapparatuur, speelgoed, machines en apparatuur voor gebruik in explosieve omgevingen.
normen, zoals ISO 12100, zijn ontwikkeld voor het uitvoeren van een risicoanalyse., De ISO 12100 geeft ook een methode voor het nemen van mitigatiemaatregelen: de Driestapsmethode. Volgens deze methode is er de volgende hiërarchie van risicobeperkende maatregelen:
- inherent veilige ontwerpmaatregelen
- beschermings-en aanvullende beschermingsmaatregelen
- informatie voor gebruik
Dit betekent dat de gebruikershandleiding moet waarschuwen voor eventuele restrisico ‘ s in verband met het gebruik van het product. Dit gebeurt met veiligheidswaarschuwingen.,
koop nu
een goede veiligheidswaarschuwing beschrijft de aard van een gevaarlijke situatie, de gevolgen van het niet vermijden van een gevaarlijke situatie en de methode(n) om deze te vermijden.
om de mate van gevaar aan te geven die de gebruiker kan tegenkomen, moeten de signaalwoorden “gevaar”, “waarschuwing” en “voorzichtigheid” worden gebruikt.
bekijk de volgende veiligheidsberichten:
waarschuwing! Roterende onderdelen. Risico op ernstig letsel. Hou je handen vrij. Lockout / Tagout voor onderhoud.
dan wilt u de gebruiker waarschuwen wanneer zich een gevaarlijke situatie kan voordoen. De ANSI Z535.,6 standaard beschrijft de volgende locaties in de gebruikershandleiding waar dit zou kunnen zijn:
- gegroepeerd in een apart hoofdstuk.
- in het eerste deel van de specifieke sectie:
1. Deden.
2. Deden. Waarschuwing! Dit zijn ingebedde veiligheidsberichten. Algemene tekst algemene tekst algemene tekst.
3. Deden.,
- in het voorwoord kunnen aanvullende richtlijnen worden geplaatst, zoals alle instructies voor gebruik lezen of deze instructies bewaren voor toekomstig gebruik kunnen in de inleiding van een gebruikershandleiding worden geplaatst.
in de EU kan het, afhankelijk van het soort product, worden toegestaan om alleen de veiligheidsinformatie in gedrukte vorm en de rest van de informatie online te verstrekken.
om Philip te helpen een veiligheidsbericht te maken en te plaatsen, heb ik een ander sjabloon gemaakt.
actie: voer een risicoanalyse uit en maak uw veiligheidsberichten met behulp van dit sjabloon.,
Create all other content
nu vroeg ik Philip om alle andere content te maken, zoals de procedures, technische specificaties en juridische informatie.
Ik gaf de volgende tips:
- onnodig materiaal uitsluiten om overbelasting van informatie te voorkomen (bijvoorbeeld verkoopbevordering, uitgebreide herhaling, enz.).
- zorg ervoor dat termen bekend zijn bij de gebruiker, technische kenmerken en termen zijn goed uitgelegd en gebruik termen consistent.
- Beschrijf alle vereisten waaraan moet worden voldaan voordat de eigenlijke instructies beginnen., Dit kan ook het beschrijven van speciale gereedschappen of ruimte voor onderhoud en reparatie.
- geef conceptuele informatie wanneer informatie nodig is voor een adequaat begrip en de uitvoering van taken.
- schrijf altijd op onderwerp gebaseerd.
- gebruik een vet lettertype voor alle productelementen.
- gebruik een stijlgids om documentatie op een duidelijkere manier te schrijven en te formatteren.
- geef aan wanneer u een afbeelding wilt toevoegen voor een beter begrip later.
- zorg ervoor dat woorden en zinnen niet te ingewikkeld of te verfijnd zijn.,
- gebruik eenvoudige / gestandaardiseerde en korte zinnen: één zin-één commando.
- plaats niet te veel informatie in één zin.
- gebruik de direct active voice en assertive commando ‘ s.
- gebruik woorden zoals zelfstandige naamwoorden en werkwoorden consequent om dubbelzinnigheid te voorkomen.
- om betere instructies te schrijven, gebruik je de principes van minimalisme in technische communicatie en vereenvoudigd technisch Engels.
actie: maak alle andere inhoud aan voor uw gebruikershandleiding.
nogmaals, voor de meeste productgroepen zijn er betaalde sjablonen beschikbaar die het werk gemakkelijker kunnen maken., Deze sjablonen bevatten alle wetteksten, verplichte verwijderingsinformatie, auteursrechtverklaringen en voldoen aan de IEC 82079-standaard voor gebruikersinstructies.
plaats de veiligheidswaarschuwingen op de juiste positie
bij het gebruik van het sjabloon voor het opstellen van de veiligheidsberichten, vroeg ik Philip aan te geven of een veiligheidsbericht een aanvullende richtlijn is, of als een gegroepeerde, sectie-of ingesloten veiligheidsbericht moet worden geplaatst.
nu alle tekst is aangemaakt, kunnen de veiligheidsberichten op de juiste plaats worden geplaatst.,
actie: plaats alle veiligheidsberichten op de juiste plaats in de gebruikershandleiding.
stap 9 navigatie toevoegen aan uw sjabloon voor gebruikershandleidingen
een gebruikershandleiding moet mensen helpen door informatie te verstrekken over het gebruik van een product. Het vinden van de juiste informatie die het probleem van de gebruiker oplost moet zo weinig mogelijk tijd in beslag nemen.
het maken van betekenisvolle koppen is een van de tools die gebruikers helpen bij het vinden van informatie., Er zijn echter verschillende andere hulpmiddelen om de gebruiker te helpen de informatie te vinden die hij/zij wil, zoals:
- inhoudsopgave
- paginanummering
- Index
Ik vroeg Philip om de inhoudsopgave bij te werken en paginanummering en een index toe te voegen.
actie: inhoudsopgave, paginanummering en index toevoegen of bijwerken.
stap 10 Laat uw Gebruikershandleiding bekijken
Philip heeft nu de conceptversie van zijn gebruikershandleiding gemaakt met behulp van het sjabloon voor gebruikershandleidingen. We noemen deze versie de tekstuele inhoud ontwerp.,omdat Philip een zakenpartner en een ontwikkelaar heeft met diepgaande technische productkennis, vroeg ik Philip om het werk tot nu toe te laten beoordelen. zowel zijn zakenpartner als de ontwikkelaar gaven feedback. Philip gebruikte deze feedback om de gebruikershandleiding te optimaliseren.
actie: stuur de conceptversie van de gebruikershandleiding naar iedereen binnen uw team die mogelijk feedback kan geven. Vraag hen om alle feedback te combineren in één document voordat u het terug te sturen naar u. Dit stimuleert de discussie van uw teamleden en voorkomt onenigheid in een later stadium.,
stap 11 Maak de afbeeldingen
nadat de gebruikershandleiding is herzien en geoptimaliseerd, zijn de teksten min of meer definitief. Dit betekent dat alle afbeeldingen nu kunnen worden gemaakt en toegevoegd aan de inhoud.
de reden om te wachten tot de teksten klaar zijn, is dat het maken of bewerken van afbeeldingen tijdrovend kan zijn. Omdat afbeeldingen tekst moeten ondersteunen, vervangen of vergroten, wilt u wachten om ze te maken totdat de teksten definitief zijn.
afbeeldingen in gebruikershandleidingen kunnen illustraties, foto ‘s, schermafbeeldingen, tabellen, diagrammen en schema’ s bevatten.,
Er zijn veel leuke tools die u helpen bij het maken van uw foto, zoals:
- Snagit of Adobe Photoshop voor het bewerken van screenshots of foto ‘s
- Solidworks Composer of Google Sketchup voor het maken van lijntekeningen
- Lucidchart of Microsoft Visio voor diagrammen en schema’ s
ik adviseerde Philip niet te gebruiken foto ‘ s als een goedkoop alternatief voor illustraties. Vaak zijn foto ‘ s niet zo informatief omdat ze te veel informatie bevatten. Daarnaast kunnen foto ‘ s een gebruikershandleiding rommelig maken.,om die reden gebruikte Philip Google Sketchup om zijn illustraties te maken.
actie: maak de afbeeldingen voor uw gebruikershandleiding.
Als u meer wilt weten over het maken van afbeeldingen:
- met behulp van tekst, afbeeldingen of video
- IKEA-achtige handleidingen
stap 12 laatste controle van de gebruikershandleiding sjabloon
voordat we beginnen met het er mooi uit te laten zien en de inhoud te vertalen, willen we er zeker van zijn dat de inhoud compleet is.
om dit te doen, vroeg ik Philip om een checklist te gebruiken.,
actie: l controleer of uw gebruikershandleiding voldoet aan alle relevante eisen van IEC 82079-1:2012 met behulp van deze controlelijst.
stap 13 ontwerp uw sjabloon voor gebruikershandleidingen
Een goed ontworpen handleiding draagt bij aan een betere merk-en gebruikerservaring.
u kunt het sjabloon voor de gebruikershandleiding in MS Word aanpassen door een bedrijfslogo toe te voegen en het lettertype, de kleuren enzovoort aan te passen, maar dat kan beperkingen hebben.
wanneer u weet hoe u met Adobe Indesign moet werken of bereid bent ermee te leren werken, biedt dit u veel meer ontwerpmogelijkheden.,
Ik heb dit sjabloon gemaakt in Indesign en Philip gevraagd het aan te passen aan zijn merkidentiteit.
actie: pas het sjabloon voor de gebruikershandleiding aan op uw merkidentiteit, of download het sjabloon voor de InDesign-gebruikershandleiding en pas het aan.
stap 14 DTP Works
DTP staat voor Desktop Publishing en Wikipedia beschrijft het als “het maken van documenten met paginaopmaak vaardigheden op een personal computer voornamelijk voor afdrukken”.
Philip heeft nu zowel de inhoud van zijn gebruikershandleiding (Word-bestand) als de gebruikershandleiding (InDesign-bestand)., De inhoud moet in de InDesign template worden gezet. Dit heet Desktop Publishing.
actie: plaats de inhoud van uw Word-bestand in de Indesign-sjabloon. Als u hebt besloten om de InDesign-sjabloon niet te gebruiken, maar vast te zitten aan het Word-bestand, dan kunt u deze stap overslaan.
stap 15 vertaal en publiceer uw gebruikershandleidingen
afhankelijk van de markt waarin u uw product gaat verkopen, moet u mogelijk de gebruikershandleiding vertalen.
enkele algemene tips:
- zoek naar een vertaler met vergelijkbare ervaring., Dit kan een vertaler zijn die ervaring heeft met het vertalen van technische inhoud, met vergelijkbare producten of met het vertalen van gebruikershandleidingen.
- Als u naar meerdere talen moet vertalen, kan het werken met een vertaalbureau u veel tijd besparen.
- vraag de vertaler of het agentschap naar hun kwaliteitsprocedures en wie de tekst na de vertaling gaat herzien.
- omdat u uw product het beste kent en wie uw doelgroep is, is het misschien een goed idee om de vertaler of het bureau een woordenlijst of een lijst te geven met de terminologie die u wilt gebruiken.,
- zoek naar een vertaler die direct in uw Word-of InDesign-bestand kan werken of zoek een bureau dat ook de DTP-werken kan uitvoeren. Als alternatief kun je dit natuurlijk zelf doen.omdat Philip zijn product zowel in de VS als in de EU zal verkopen, besloot hij met een agentschap samen te werken.
actie: zoek een vertaler of bureau die aan uw behoeften voldoet en laat uw gebruikershandleiding vertalen.
in het algemeen moet een gebruikershandleiding beschikbaar zijn in een formaat dat gemakkelijk toegankelijk is voor de gebruiker. Die kunnen worden afgedrukt, of online of op het apparaat worden gebruikt.,
aangezien een gebruiker informatie wil op het moment dat hij/zij deze nodig heeft en dus niet denkt in kanalen, zou de beste aanpak zijn om de instructies op het omni-platform te geven.
in de Europese Unie is het voor sommige productgroepen nog steeds beperkt om de gebruikershandleiding bij het product te verstrekken.
vanaf April 2016 kunnen de instructies van veel productgroepen echter in een ander formaat worden geleverd dan in gedrukte vorm. Er is echter één uitzondering.veiligheidsinformatie moet samen met het product nog steeds op papier worden geleverd., Bovendien moet op verzoek van een consument een papieren gebruikershandleiding ter beschikking van de consument worden gesteld.
Philip besloot tot het volgende:
- hij geeft een gedrukte volledige handleiding met het product, inclusief de veiligheidsinstructies.
- hij creëerde een aparte Snelstartgids die ook bij het product moet worden geleverd.
- hij plaatste een pdf-versie van de volledige handleiding online.
- hij zal een online-help-sectie op zijn website maken met de HTML-versie van de gebruikershandleiding. Hier kan hij ook video ‘ s toevoegen., En door het optimaliseren van de HTML-versie voor zoekmachines maakt hij het makkelijker voor zijn gebruiker om informatie te vinden voor zijn gebruiker
conclusie
dat is alles wat er is. Zo creëerde Philip een gebruikershandleiding met behulp van het sjabloon voor gebruikershandleidingen en de andere beschikbare tools die ik heb verstrekt.
het beste deel van dit alles is dat je dezelfde resultaten kunt krijgen als Philip door dit stap-voor-stap proces te volgen over hoe je een gebruikershandleiding maakt.