Hoe een gebruikershandleiding te maken

Gebruikershandleidingen zijn handleidingen die zijn geschreven in gedrukte formulieren (op papier) of in elektronische documenten (PDF of XPS) die instructies bevatten over het maken of gebruiken van iets. Terwijl over het algemeen beschouwd als de "handleidingen" zoals handleidingen voor computersoftware, kunnen gebruikershandleidingen computers en andere elektronische apparaten, zoals televisies, stereo radio, telefonie en MP3-spelers, evenals apparaten te begeleiden en tuingereedschap. Goede gebruikershandleidingen leiden de gebruiker op over de functies van het product en leren hem deze effectief te gebruiken en zijn zo gerangschikt dat ze gemakkelijk kunnen worden gelezen en geraadpleegd. Vervolgens zal dit artikel enkele zaken bevatten waarmee rekening moet worden gehouden bij het maken van een effectieve inhoud en het ontwerpen van de lay-out voor een gebruikershandleiding.

Inhoud

Stappen

Deel 1maak de juiste gebruikersdocumentatie
Deel 2onderdelen van de gebruikershandleiding
Deel 3ontwerp een leesbare gebruikershandleiding

Tips
Dingen die je nodig hebt

stappen

Deel 1
Maak de juiste gebruikersdocumentatie

Titel afbeelding Create a User Manual Stap 1

Bepaal wie de gebruiker is Om een succesvolle handleiding te schrijven, moet je een profiel van uw gebruiker te ontwikkelen, hetzij formeel, het creëren van een schriftelijk of informeel profiel, de tijd neemt om redelijke veronderstellingen over de eigenschappen gebruiker. Een dergelijk profiel is handig als u deel uitmaakt van een team dat de gebruikersdocumentatie schrijft en ook kan helpen het product zelf van een concept naar de uiteindelijke vorm te brengen. De dingen die u in gedachten moet houden wanneer u een gebruikersprofiel maakt, zijn:

De plaats waar gebruikers de gebruikershandleiding zullen gebruiken, zoals thuis, op kantoor, op een externe werkplek of in de auto. Dit kan niet alleen de inhoud bepalen, maar ook de stijl die de gebruikershandleiding bepaalt.
De manier waarop gebruikers de gebruikershandleiding gebruiken. Als gebruikers de handleiding een paar keer raadplegen of alleen om informatie te zoeken, moet dit in de indeling van een querydocument zijn. Als de gebruikers in het begin de handleiding vaak raadplegen, moet het deel over raadplegen vergezeld gaan van een sectie met de titel "Hoe te beginnen" en instructies voor de eenvoudigste taken waarvoor het product zal worden gebruikt.
De ervaring die gebruikers hebben met het product of met andere vergelijkbare producten. Als uw product nieuw is of aanzienlijk afwijkt van andere soortgelijke producten, moet u een uitleg geven over hoe het anders is in vergelijking met andere producten en ook instructies over hoe u het kunt gebruiken. Als het product gerelateerd is aan iets dat vaak problematisch is voor gebruikers, zoals bij veel computerprogramma`s, moet u op begrijpelijke wijze adequate en gedetailleerde informatie verstrekken.

Titel afbeelding Create a User Manual Stap 2

Schrijf om de behoeften van de gebruiker te helpen op een manier die hij kan begrijpen. Tenzij de gebruiker een technische achtergrond heeft, kan het beter zijn om een zeer technische taal te vermijden om duidelijkere en eenvoudigere uitleg te krijgen. De tekst moet op dezelfde manier worden georganiseerd als de gebruiker zelf denkt - vaak is het zinvoller om de kenmerken van de producten gegroepeerd op basis van hun functies te vermelden dan alleen die te vermelden die het vaakst worden gebruikt.

Soms is het onvermijdelijk om technische termen te gebruiken, bijvoorbeeld voor een computerprogramma dat is ontworpen om afbeeldingen te maken met afbeeldingen van Fibonacci, naast de balk en cirkelvormige diagrammen, die vaker voorkomen. In dit geval is het handig om de term te definiëren en enige basisinformatie hierover te geven, zoals uitleggen wat een Fibonacci-diagram is en waarvoor het wordt gebruikt in financiële analyse.

Titel afbeelding Create a User Manual Step 3

Verklaart het probleem dat de gebruiker probeert op te lossen en biedt vervolgens een oplossing voor dat probleem. Het aanbieden van een productfunctie als oplossing voor een veel voorkomend probleem werkt goed wanneer het product wordt gepromoot, maar zodra de gebruiker het heeft, moet hij weten hoe die functie moet worden gebruikt. Bepaal de specifieke problemen waarmee de gebruiker te maken krijgt, vermeld deze in de gebruikershandleiding en voeg vervolgens de instructies toe om ze op te lossen.

Als het probleem complex is, scheid het dan in kleinere delen. Maak een lijst van elk van de delen met de instructies om het op te lossen of ermee om te gaan en voeg vervolgens achtereenvolgens elk volgend onderdeel toe. Verdeel de informatie op deze manier wordt "fragment" genoemd.

Deel 2
Onderdelen van de gebruikershandleiding

Inclusief de hoes en de juiste hoesjes. U moet een afdekking voor meer gebruikers geleiden Een verwijzingspagina en een deksel maakt handmatige die meer dan het oppervlak van een gevouwen blad (4 of meer pagina`s).

Als de handleiding auteursrechtelijk is beschermd, moet een vermelding op het voorblad en op de omslagpagina worden vermeld.
Als er termen en voorwaarden zijn om de handleiding en het bijbehorende product te gebruiken, plaatst u deze op de binnenkant van de omslag.

Titel afbeelding Create a User Manual Stap 5

Maak verwijzingen naar de gerelateerde documentatie in het voorwoord. Als de gebruikersdocumentatie meer dan één handleiding is, plaatst u de verwijzingen naar de andere documenten hier met hun bijbehorende versienummers. Het voorwoord is ook de plaats waar u (indien aanwezig) een sectie moet plaatsen met de naam "Hoe deze gids te gebruiken".

Titel afbeelding Create a User Manual Step 6

Als de handleiding meer dan 10 pagina`s bevat, bevat deze een inhoudsindex.

Titel afbeelding Create a User Manual Step 7

Zet de instructies of procedures en het referentiemateriaal in de hoofdtekst van de handleiding. In de meeste gevallen hebben de procedures en referentiematerialen hun eigen secties, hoewel u binnen een sectie de gebruiker kunt instrueren specifieke inhoud van de andere te raadplegen. Op deze manier kan de gebruiker sneller de informatie vinden waarnaar hij op zoek is.

Procedures moeten met een consistente structuur worden geschreven in het gedeelte over de instructies in de handleiding. Begin met een samenvatting van de taak en beschrijf wat de gebruiker moet doen en welke resultaten moeten worden gevolgd. De stappen moeten worden genummerd en beginnen met verbale acties op dezelfde manier waarop de stappen in elke sectie van dit artikel worden geschreven.

De referentiematerialen kunnen een lijst met opties bevatten, tips voor het oplossen van problemen en veelgestelde vragen. Woordenlijsten en indexen kunnen aan het einde van de handleiding worden toegevoegd, hoewel een lijst met vaak gebruikte termen aan het begin kan worden geplaatst. De index kan worden weggelaten als de handleiding minder dan 20 pagina`s bevat.

Titel afbeelding Create a User Manual Step 8

Gebruik grafische afbeeldingen om indien nodig een back-up van de tekst te maken. Grafische afbeeldingen of screenshots illustreren enkele punten beter dan een tekst, vooral als het complexe procedures waarin de gebruiker een visuele bevestiging dat u het uitvoeren van de stappen de juiste handleiding nodig heeft. Grafische afbeeldingen kunnen worden gemaakt met behulp van programma`s voor computer-aided design (CAD, voor de afkorting in het Engels) of grafisch ontwerp programma`s, digitale camera`s en bewerkingsprogramma`s foto`s of, in het geval van screenshots, kunt u gebruik maken van de van capture die op de computer is geïnstalleerd, of een programma voor het afhandelen van grafieken met een functie voor het vastleggen van schermen.

Nadat u een grafische afbeelding hebt gemaakt, slaat u deze op in een indeling die zo gecomprimeerd is als uw tekstverwerker of kunt u uw bureaubladpublicatieprogramma gebruiken. U dient ook de fysieke grootte van de afbeelding te verkleinen tot een afbeelding die gemakkelijker op de pagina past en tegelijkertijd de noodzakelijke details voor de gebruiker te bieden (eventueel moet u de afbeelding in delen splitsen om de relevante delen naast de tekst weer te geven die ze ondersteunen). ).

Als u veel grafische afbeeldingen in de procedures gebruikt, moet u ze van een consistent formaat maken, hetzij in dezelfde breedte- en hoogtemetingen, hetzij in dezelfde verkleiningspercentage ten opzichte van de oorspronkelijke grootte. Hierdoor zullen de afbeeldingen er aantrekkelijker uitzien voor de gebruiker. Evenzo, wanneer u schermafbeeldingen maakt op een computer, moet u ervoor zorgen dat de computer hetzelfde kleurenschema weergeeft wanneer u foto`s maakt, voor het geval de gebruikershandleiding deze in kleuren weergeeft.

Hoewel grafische ontwerpprogramma`s zoals Photoshop of Paint Shop Pro fatsoenlijke functies voor het vastleggen van schermen bieden, kunt u met speciale vastlegprogramma`s zoals Snagit ook eenvoudig screenshots wijzigen, catalogiseren en becommentariëren.

Deel 3
Ontwerp een leesbare gebruikershandleiding

Titel afbeelding Create a User Manual Step 9

Kies een aantal leesbare bronnen. Hoewel op computers veel verschillende bronnen kunnen worden gebruikt, is het doel van een gebruikershandleiding om gemakkelijk leesbaar te zijn. Om dit te bereiken, is het het beste om een klein aantal bronnen te kiezen die er samen goed uitzien. De bronnen kunnen in twee groepen worden verdeeld: serif-lettertypen en schreefloze lettertypen

De serif-lettertypen hebben kleine lijnen met decoratie aan het einde van de hoofdlijnen die de letter vormen. Sommige serif-lettertypen zijn Times New Roman, Baskerville en Book Antiqua. Serif-lettertypen werken het best op grote stukken tekst die in de hoofdtekst van de gebruikershandleiding worden afgedrukt in een grootte van 10 of 12 punten.
De schreefloze lettertypen hebben alleen maar streken die de letters vormen, zonder verfraaiingen. Sommige schreefloze lettertypen zijn Arial, Calibri en Century Gothic. Schreefloze lettertypen kunnen worden gebruikt in grote stukken tekst in de maten van 8 tot 10 punten in een PDF of een handleiding op het internet, hoewel het ontbreken van schreven maakt geschreven in de maten van 12 punten of meer zinnen zijn moeilijk te lezen . Ze kunnen echter effectief worden gebruikt in grotere formaten voor titels en koppen, en ze zijn ook erg goed in kleinere formaten voor voetnoten en cijfers in kolommen en tabellen.
Over het algemeen moet u eenvoudige lettertypen kiezen zoals Arial of Times New Roman voor uw gebruikershandleiding, hoewel u een decoratief lettertype voor verre aanhalingstekens of titels kunt kiezen als u een gebruikershandleiding voor een fantasy- of sci-fi-videogame schrijft (in het geval van dating buiten, vaak kunt u een aantal van de eenvoudige bronnen te gebruiken en weer te geven het citaat weg cursief).
Nadat u de bronnen hebt gekozen die u gaat gebruiken, maakt u een voorbeeldpagina om te controleren of de bronnen er op papier goed uitzien. U moet dit voorbeeld ook laten zien aan de persoon die het uiterlijk van de handleiding moet goedkeuren voordat u verder gaat met het schrijven ervan.

Titel afbeelding Create a User Manual Step 10

Denk goed na over de distributie. Nadat u de bronnen van de gebruikershandleiding hebt gekozen, moet u beslissen waar u alles op de pagina`s plaatst.

Over het algemeen is het handig om de titel van de handleiding of het hoofdstuk in de koptekst of in het voetgedeelte te plaatsen, de titel van de handleiding op de linkerpagina te plaatsen en de titel van het hoofdstuk op de rechterpagina. Het is ook handig om het paginanummer in de koptekst of in het voetgedeelte te plaatsen, hetzij aan de externe kant (van de koptekst of voettekst) of in het midden (alleen in de voettekst). Het is handig om de eerste pagina van elke sectie of hoofdstuk van de andere pagina`s te onderscheiden door uw paginanummer in het midden van de voettekst en op de volgende pagina`s te plaatsen, zodat het in de buitenste hoek van de kop wordt geplaatst.

Het is handig om de tekst van de referenties van de afbeeldingen in kleuren of in kadervakken te plaatsen om deze van de rest van de tekst te scheiden. Zorg ervoor dat u een kleur- of schaduwniveau kiest waarmee u de tekst gemakkelijk kunt lezen.

Laat redelijk brede marges achter op de zijkanten, met extra ruimte aan de randen waarop u alle pagina`s gaat samenvoegen.

Titel afbeelding Create a User Manual Step 11

Kies het type binding voor de gebruikershandleiding. Als de gebruikershandleiding meer dan 4 pagina`s bevat, moet u de pagina`s op de een of andere manier koppelen. Hoewel documenten voor intern gebruik op de hoeken kunnen worden geniet, kunnen gebruikershandleidingen voor extern gebruik die met een product worden geleverd, op een van de volgende drie manieren worden gebonden:

Nieten aan de zijkanten is geschikt voor handleidingen bestaande uit gevouwen vellen papier van 21 x 27,5 cm (8,5 x 11 inch), 21 x 35 cm (8,5 x 14 inch) of 27,5 x 42, 5 cm (11 x 17 inch). De meeste goedkope handleidingen van 48 pagina`s of minder zijn op deze manier gebonden.

Het is gebruikelijker om te naaien op een paard voor naslaggidsen voor derden dan voor gebruikershandleidingen die worden geleverd met andere producten dan auto`s, hoewel sommige langere gebruikershandleidingen op deze manier worden gebonden (in eerste instantie met JASC-software produceerde de Paint Shop Pro, leverde gebonden gebruikershandleidingen door te borduren op een paard).

Het bindmiddel is meer geschikt voor spiraal handleidingen die zijn ontworpen voor meer vijandige omgevingen zoals buiten, waar de gebonden handleidingen geniet of genaaid paard ontwapenen. Sommige spiraalgebonden handleidingen kunnen ook gelamineerde pagina`s bevatten om te voorkomen dat de handleiding wordt verprutst als deze nat of vuil wordt.

Titel afbeelding Create a User Manual Step 12

Ontwerp een documentsjabloon voor uw gebruikershandleiding. Veel tekstverwerkers en desktop publishing-programma`s bieden de mogelijkheid om documentsjablonen voor gebruikershandleidingen te maken, dus tijdens het typen wordt de tekst automatisch weergegeven in het lettertype dat u hebt gekozen voor het deel van de handleiding waaraan u werkt. (In feite is dit artikel oorspronkelijk geschreven met behulp van een Microsoft Word-sjabloon). De meeste van deze programma`s bevatten ook een set van voorgedefinieerde sjablonen die u kunt aanpassen als je het nodig hebt, in plaats van het creëren van de sjabloon vanaf het begin.

Tekstverwerkers en desktop publishing programma`s bieden ook de mogelijkheid van het creëren van "stijlen", die vooraf gedefinieerde soorten en maten van het lettertype voor de rubrieken, footers, headers en body tekst zijn. U kunt kiezen uit een van de vooraf gedefinieerde stijl namen (bijvoorbeeld "Kop 1", "Normaal", "Quote") of maak uw eigen stijl met uw eigen naam. Als u veel stijlen voor hetzelfde teksttype gebruikt, volgt u de conventies voor stijlnamen zoveel mogelijk (bijvoorbeeld Microsoft Word roept tekststijlen aan voor titels als "Titel1", "Titel2", enz.), voor alle titels van het hoofdniveau naar verschillende ondertitelniveaus). Vroege pogingen om elke stijl die u nodig hebt, dus niet hoeft te stoppen om ze te maken, terwijl je in feite de handleiding te schrijven.

tips

Gebruik waar mogelijk veldcodes of tekstvariabelen. U kunt ze waarden, zoals de naam van het product, de handleiding of de titel van het hoofdstuk, toewijzen en deze in het document gebruiken in plaats van de eigenlijke tekst te schrijven. Wanneer u de handleiding bekijkt of afdrukt, verschijnt de tekst in plaats van de variabele. Als de naam van het product verandert of als u de naam van de handleiding of het hoofdstuk wijzigt, is het eenvoudiger om de informatie aan te passen door de waarde van de gewenste tekstvariabele te wijzigen en de woorden in het document te vervangen.