Een gebruikershandleiding maken: 12 stappen

De gebruikershandleiding is een paperbook op een papieren of digitale media (in PDF of XPS-indeling), waarin de instructies voor het gebruik van iets of de juiste procedure voor het uitvoeren van een proces beschrijft. Hoewel wanneer een persoon de zin hoort "gebruikershandleiding", Het vertegenwoordigt meestal een gids voor het gebruik van een specifiek programma, bedieningsinstructies voor computer- en huishoudelijke apparaten (tv`s, stereosystemen, telefoons, MP3-spelers, tuinapparatuur en en t.NS.). Een goede gebruikershandleiding vertelt over de basisfuncties van het apparaat of het programma en wordt uitgelegd hoe u ze correct kunt gebruiken en de informatie is meestal goed gestructureerd. Dit artikel vertelt over wat belangrijk is om te onthouden bij het maken en uitvoeren van de gebruikershandleiding.

Stappen

Deel 1 van 3:

Documentatie maken

een. Bepaal wie uw lezer. Om een goede gebruikershandleiding te maken, moet u begrijpen welke persoon het apparaat zal kopen waarop u instructies maakt. Je kunt je gedachten opnemen, maar je kunt je deze persoon gewoon voorstellen. Het is handig om te doen als u als een team werkt om documentatie te maken en als u deelneemt aan productontwikkeling vanaf het begin tot het einde. Denk aan het volgende:

Waar een persoon de handleiding zal gebruiken: thuis, op het werk, in de auto, op internet? Dit bepaalt niet alleen de inhoud, maar ook de stijl van documentatie.
Zoals een persoon de instructies zal gebruiken? Als een persoon er slechts af en toe in de gebruikershandleiding moet worden onderzocht, betekent dit dat de instructie in een gecomprimeerd formulier moet worden ingelijst. Als de handleiding vaak wordt gebruikt, vooral aan het begin, moet u een geheel sectie opnemen over het gebruik van het apparaat of het softwareproduct en beschrijven alle belangrijke functies.
Hoeveel ervaring zou een persoon moeten hebben? Als uw product relatief nieuw is of aanzienlijk anders dan vergelijkbare producten, moet u informatie opnemen over hoe dit product verschilt van analogen en de gebruiker gedetailleerde instructies op te geven. Als de goederen geassocieerd zijn met frequente problemen (bijvoorbeeld met een groot aantal programma`s), beschrijf dan wat moet worden gedaan wanneer het probleem zich voordoet.

Titel afbeelding Maak een handleiding Stap 2

2. Schrijf zo dat de lezer je begrijpt. Als alleen uw product geen smalle kennis van de gebruiker impliceert, is het beter om technische termen te voorkomen en alles te beschrijven, een eenvoudige, begrijpelijke taal. De tekststructuur moet voldoen aan de volgorde van vragen die door de gebruiker kunnen optreden. Het is correcter om de functies van het apparaat te groeperen, afhankelijk van de taken die het uitvoert en het idee van verenigen in één groep van de meest populaire functies uitvoeren.

Soms is het onmogelijk om de technische termen volledig uit te sluiten (bijvoorbeeld als u instructies aan het programma maakt voor het maken van grafieken en diagrammen, waar naast standaardfondsen, worden ook Fibonacci grafische instrumenten gebruikt). In dit geval is het nuttig om de term en een korte beschrijving te definiëren (wat is, wat is Fibonacci-graphics en hoe ze worden gebruikt in de analyse van financiële indicatoren).

Titel afbeelding Maak een handleiding Stap 3

3. Beschrijf het probleem waarmee de gebruiker kan tegenkomen en bied dan een oplossing aan. Wanneer u een soort van product adverteert, zinsdelen over hoe hij een bepaald probleem kan oplossen, zal ongetwijfeld veel aandacht trekken. Maar wanneer de gebruiker dit product koopt, moet hij uitleggen wat ermee moet doen. Beschrijf, met welke problemen de gebruiker tijdens de werking kan tegenkomen en in de handmatige instructies voor de lopende problemen opnemen.

Als het probleem ingewikkeld is, breekt het in verschillende delen. Maak een lijst en begeleid elke item-instructies. Dit wordt blokken genoemd.

Deel 2 van 3:

Composiet delen van de gebruikershandleiding

een. Overweeg de dekking en het ontwerp van de eerste pagina`s van secties. U moet een hoes maken als de instructie meerdere pagina`s maakt. Het is ook nodig om pagina`s te plaatsen met de secties Naam voor instructies, waar het totale aantal informatie meer dan 4 pagina`s duurt.

Als de handleiding door het auteursrecht wordt beschermd, moet de bijbehorende indicatie op het deksel en op partitiepagina`s staan.
Als de gebruikershandleiding bepaalde voorwaarden biedt voor het gebruik van het product en de instructies, plaatst u deze informatie van de binnenkant van de kap.

Titel afbeelding Maak een handleiding Stap 5

2. Links naar extra documentatieplaats in de introductie. Als de handleiding uit verschillende brochures bestaat, geef dan het aantal brochures aan aan het begin. Bovendien moet het ook een sectie plaatsen "Hoe deze gebruikershandleiding te gebruiken", Als u besluit dat een dergelijke sectie noodzakelijk is.

Titel afbeelding Maak een handleiding Stap 6

3. Als het aantal pagina`s hoger is dan 10 stuks, hebt u een inhoudsopgave nodig.

Titel afbeelding Maak een handleiding Stap 7

4. De basis van de handleiding moet instructies en informatie over de componenten van de goederen zijn. In de regel worden de instructies in blokken verbroken en in elk blok kunt u opgeven in welke secties de gebruiker dit of die informatie moet zoeken. Dus de gebruiker zal gemakkelijker en sneller zijn om de informatie die ze nodig hebben te vinden.

Processen moeten duidelijk en consequent worden beschreven. Begin met de algemene beschrijving van de taak, verklaar dan dat de gebruiker moet doen en welk resultaat zal het moeten krijgen. Alle stappen moeten worden genummerd en de voorstellen moeten beginnen met de werkwoorden.

Referentiematerialen moeten een lijst met functies bevatten, methoden voor het diagnosticeren van fouten en veelgestelde vragen. Aan het einde van de gebruikershandleiding kunt u een kort woordenboek van termen en alfabetische wijzer plaatsen, hoewel de hoofdvoorwaarden vaak aan het begin worden gemaakt. De alfabetische wijzer wordt aanbevolen voor instructies waarvan het volume groter is dan 20 pagina`s.

Titel afbeelding Maak een handleiding Stap 8

vijf. Gebruik afbeeldingen en schema`s. Tekeningen en schermafbeeldingen kunnen bepaalde processen beter beschrijven dan de tekst, vooral wanneer het komt van complexe processen, waar u een visuele bevestiging moet hebben dat de persoon alles goed doet. Grafische afbeeldingen kunnen worden gemaakt in speciale programma`s: in de systemen van twee- en driedimensionale tekening, in grafische editors, in toepassingen met fotoverwerking, enz.NS. Als screenshots moeten worden gemaakt, kunnen ze worden verkregen met behulp van het personeel van de concurrentie en het grafische programma met de mogelijkheid om schermafbeeldingen op te slaan.

Nadat u een grafisch beeld hebt ontvangen, bewaar deze in een gecomprimeerd formaat. Mogelijk moet u ook de grootte van het beeld verminderen, zodat deze op de pagina wordt geplaatst, maar de grootte mag niet te klein zijn, omdat anders de gebruiker niet in staat is om te overwegen hoe en wat moet worden gedaan. Indien nodig kunt u het beeld in verschillende delen breken en elk van hen beschrijven.

Als u meerdere afbeeldingen gebruikt, moeten ze dezelfde grootte, verhoudings en resolutie hebben. Dergelijke afbeeldingen zullen begrijpelijker en aangenaam zijn voor de lezer. Zorg er bij het maken van screenshots ervoor dat u het standaardkleurenschema gebruikt (voor gevallen wanneer de handleiding in kleur is afgedrukt).

Hoewel grafische editors (bijvoorbeeld Photoshop en Paint Shop Pro) handig zijn om screenshots te maken, is het beter om speciale programma`s te gebruiken (bijvoorbeeld Snagit), omdat ze toestaan dat ze onmiddellijk snel en gemakkelijk te bewerken, opslaan en ondertekenen afbeeldingen.

Deel 3 van 3:

Registratie van handleiding

een. Selecteer leesbaar lettertype. Hoewel computers verschillende lettertypen ondersteunen, moet de gebruikershandleiding goed leesbaar zijn, dus geef de voorkeur aan de eenvoudigste. Het is het beste om een paar lettertypen te kiezen die er goed uitzien. Er zijn twee soorten lettertypen: met serifs en geen sneakers.

Lettertypen met SERIF`s hebben kleine streepjes langs de randen van de lijnen. Dergelijke lettertypen zijn Times New Roman, Baskerville en Book Antiqua. Dergelijke lettertypen passen bij grote hoeveelheden tekst afgedrukt met 10 of 12-formaat en component van de gebruikershandleiding.
Fonts zonder sneakers hebben eenvoudige lijnen zonder decoraties. Dit zijn lettertypen zoals Arial, Calibri en Century Gothic. Lettertypen zonder SERIF`s zijn beter uitzien in teksten gedrukt met 8 of 10 lettertypen in de handleidingen van de PDF- of Web Document. Hoe groter het lettertype, hoe moeilijker het is om het te lezen zonder sneakers. Deze lettertypen kunnen echter worden gebruikt voor grote tekst - bijvoorbeeld voor een reeks headers. Sunling-lettertypen zijn geschikt voor cijferaanwerving in tafels en kolommen.
Je moet eenvoudige lettertypen kiezen zoals Arial of Times New Roman, hoewel een aantal complexere lettertype geschikt is voor het citeren. Als u een gebruikershandleiding schrijft voor een fantasyspel, kunt u markeren met een titel van een weeshuizen. Het is ook toegestaan om citaat in cursief te naaien.
Na het selecteren van lettertypen, maak een testpagina om ervoor te zorgen dat deze lettertypen met elkaar op papier worden gecombineerd. Toon deze pagina aan een persoon die lay-outs goedkeurt voordat u de gebruikershandleiding geeft om af te drukken.

Titel afbeelding Maak een handleiding Stap 10

2. Denk aan het locatieregeling van informatieblokken. In dit stadium moet u beslissen welke bestelinformatie wordt geplaatst.

In de regel wordt de naam van de gebruikershandleiding en hoofdstuknamen op de boven- of onderkant van de pagina geplaatst, samen met nummeringspagina`s. Cijfers kunnen aan de buitenkant worden geplaatst (voor de boven- en onderkant van de pagina) of in het midden (voor NIZA). De eerste pagina van elke sectie kan afwijken van de rest, dus u kunt het aantal pagina`s in het midden van de bodem plaatsen, en de nummers van alle andere pagina`s - van buitenaf.

Afzonderlijke tekstfragmenten kunnen door kleur worden geïsoleerd door ze in speciale blokken te plaatsen. Het is belangrijk om een dergelijke schaduw te kiezen die de tekst niet zou scoren.

Laat vrij grote streepjes van alle kanten achter. Van de binding van het streepje moet breder zijn.

Titel afbeelding Maak een handleiding Stap 11

3. Denk aan het type binding. Als er meer dan 4 pagina`s in uw gebruikershandleiding zijn, hebt u een binding nodig. Documenten voor intern gebruik worden meestal de nietmachine in de hoek bevestigd, maar als u uw gids in de doos met een grondstof investeert, moet u deze kwestie verantwoordelijker benaderen. Er zijn drie soorten binding:

Bonding beugel. Dit type is geschikt voor brochures met dimensies 21x 27.5 cm, 21x35 cm of 11 x 27.5x42.5 cm. Meest goedkope instructies voor gebruik, die op deze manier uit 48 pagina`s en minder verweven zijn.

Bindend vnakidka. Dus intertwine de meeste gebruikelijke gebruiksaanwijzing, het tellen van de instructies voor auto`s, hoewel sommige lange leiders op deze manier ook met elkaar verweven zijn. Paint Shop Pro is oorspronkelijk bij een dergelijke gebruikershandleiding geleverd.)

Bindend met draadspiraal. Op deze manier zijn de handleidingen die in meer ernstige omstandigheden worden gebruikt met elkaar verweven, bijvoorbeeld op straat, waar de nietjes gemakkelijk kunnen breken of verspreiden. In sommige instructies voor gebruik met een dergelijke binding worden ook gelamineerde pagina`s gevonden, wat niet nat is en niet vuil in het vuil.

Titel afbeelding Maak een handleiding Stap 12

4. Het document innemen. De meeste sms-editors en -programma`s voor het publiceren van tekst op internet Er is een kans voor lay-out. Zoals u de tekst typt, wordt deze automatisch weergegeven in het geselecteerde lettertype. (Dit artikel is oorspronkelijk geschreven met behulp van een sjabloon in Microsoft Word.) Deze programma`s hebben ook kant-en-klare sjablonen die u kunt wijzigen, rekening houdend met uw behoeften, in plaats van een patroon van nul te maken.

In tekstredacteuren en programma`s voor het publiceren van tekst op internet is er ook een functie van het maken "stijlen", Besparing van lettertypen en taken voor tabellen en voetteksten en basistekst. U kunt kiezen uit reeds bestaande stijlen ("Titel1", "Gebruikelijk", "Citaat") of maak je eigen stijl en geef het je naam. Het wordt aanbevolen om stijlen langs hetzelfde systeem te bellen als in het programma. (Microsoft Word maakt bijvoorbeeld dergelijke namen als "Titel1", "Titel2"- Bovendien zijn er nog steeds ondertitels.) Configureer het programma van tevoren, zodat u er niet naar hoeft terug te keren wanneer u tekstschrijven.

Tips

Gebruik indien mogelijk codes van velden of tekstvariabelen. U kunt hun waarden (bijvoorbeeld de naam van het product, de naam van het hoofd van de gebruikershandleiding) wijzigen en ze in het document in de plaats plaatsen waar u meestal handmatig naar de woorden verhuist. Wanneer u een voorbeeld van het document maakt of het voorbereidt voor het afdrukken, zal de gewenste tekst in variabelen instellen. Als de naam van de goederenwijziging of als u besluit om de naam van het hoofdstuk te wijzigen, bent u gemakkelijker om de tekst te wijzigen door de waarde van de variabele te vervangen.