Als eerste bedankt voor het aanschaffen van deze PDF waarin ik je handige tips en trucs zal geven over het schrijven van een handleiding

Bedankt! Als eerste bedankt voor het aanschaffen van deze PDF waarin ik je handige tips en trucs zal geven over het schrijven van een handleiding. Graag zou ik je willen vragen mij een email te sturen en mij verteld wat deze PDF voor invloed heeft gehad op het schrijven van een handleiding. Mail dit dan naar [email protected]. Hierdoor kan ik mijn informatie misschien aanpassen (verbeteren). Alvast bedankt!

Hoe schrijf ik een handleiding | door Allan de Bruin | IZEE SERVIC ES Eerste druk april 2013 | www.izee.nl

Inhoud van dit e-book Waar zal ik allemaal tips over gaan geven? .........................................................................................3 Inleiding..............................................................................................................................................4 Het doel van de handleiding ...............................................................................................................4 Op welk moment schrijf je een handleiding?.......................................................................................4 Verzamelen van informatie om de handleiding te schrijven. ...............................................................4 Soorten handleidingen........................................................................................................................5 In welke vorm beschrijf je een handleiding .........................................................................................5 Structuur in een handleiding ...............................................................................................................6 Blijf bij het onderwerp ........................................................................................................................6 Taalgebruik in een handleiding ...........................................................................................................6 Uitleggen met voorbeelden ................................................................................................................6 Afbeeldingen gebruiken in de handleiding ..........................................................................................7 Screenshots maken met FireShot ....................................................................................................7 Laten controleren van de handleiding .................................................................................................7 Tot slot ...............................................................................................................................................7


Waar zal ik allemaal tips over gaan geven? Ik heb hieronder een overzicht gemaakt van de onderwerpen die ik wil gaan behandelen in deze PDF. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10.

Het doel van een handleiding Op welk moment schrijf je een handleiding Het verzamelen van informatie voor de handleiding Soorten handleidingen In welke vorm zal je de handleiding opleveren De structuur in een handleiding Het taalgebruik in een handleiding Uitleggen met voorbeelden Het gebruik van afbeeldingen in een handleiding Het laten controleren van de handleiding


Inleiding Het schrijven van een handleiding kan veel tijd in beslag nemen. Er zullen voorbeelden moeten worden gegeven van de werking van (een) bepaalde functie(s) en er moeten ook nog eens afbeeldingen worden weergegeven in de handleiding. Daarom dit e-book waarin ik tips en trucs zal geven

Het doel van de handleiding Als ontwikkelaar of producent mag je er niet vanuit gaan dat de klant of afnemer het product zomaar begrijpt. Daarom is het maken van een handleiding nuttig. In een handleiding zullen dan voorbeelden worden gegeven van hoe een onderdeel of een functie zal werken en wat de gebruiker er mee kan. Het doel van de handleiding is dus om de gebruiker van het afgenomen product te ondersteunen bij het gebruik. De handleiding heeft ook de functie van een vangnet zodat de gebruikers niet zo snel de supportafdeling zullen bellen. Naast dat het de gebruikers informeert geeft het ook aan de ontwikkelaar of producent een goed beeld van wat zij opleveren en of ze niets vergeten zijn. Zie het maar als een controletool.

Op welk moment schrijf je een handleiding? Het meest verstandig is om direct na het maken van een onderdeel of een functie te beschrijven hoe iets werkt. Dit hoeft maar een heel klein stukje te zijn, als er maar beschreven is wat de functie doet en wat je er mee kan. Eventueel aan de hand van een voorbeeld. Dan, als het programmaonderdeel of functie klaar is voor oplevering, zal je de gehele handleiding kunnen gaan schrijven hiervoor.

Verzamelen van informatie om de handleiding te schrijven. Er zijn veel bronnen waar informatie gevonden kan worden bij het schrijven van een handleiding. -

Als eerste jijzelf kan al een bron zijn De specificaties die opgesteld zijn door de functioneel en/ of technisch ontwerper De ontwikkelaar(s) De tester(s)


Soorten handleidingen Er zijn verschillende soorten en vormen handleidingen en uitlegbronnen. Vroeger had je handleidingen die meegeleverd werden met de software als een programmaatje of boek. Nu is het meestal het geval dat je een op een link moet klikken om dan naar een online handleiding te gaan of de handleiding is een PDF bestand en deze staat dan lokaal. Maar hoe benader je een online handleiding als je geen toegang hebt tot internet? Dan zal je een toch de gegevens moeten kunnen benaderen via een handleiding die meegeleverd is en lokaal staat. In dit e-book word er van twee soorten handelingen uit gegaan : -

Een online handleiding De lezer zal verbinding moeten hebben met het internet Een lokale handleiding De lezer kan de handleiding op de computer bekijken

Een online handleiding biedt veel voordelen die ik graag wil benoemen. -

Bij een online handleiding kan je als eigenaar van de handleiding altijd de gegevens automatisch updaten en hebben de alle lezers altijd de laatste versie. Je kan de gebruikers van de handleiding aanbieden om een laatste versie te downloaden in PDF.

In welke vorm beschrijf je een handleiding Als je een handleiding gaat schrijven is het verstandig om te kiezen in welke vorm de handleiding geschreven zal worden. Dus in welke vorm ga je uitleggen hoe iets werkt. Bijvoorbeeld: Ga je per scherm uitleggen wat er gebeurt Als je per scherm gaat vertellen wat er moet gebeuren dan kan je dat snel en simpel uitleggen. Bijvoorbeeld: Het toevoegen van een gebruiker Ga je in de vorm van vragen iets uitleggen Dus je noemt een functie / handeling en je gaat daar verder op in. Je kan ook een combinatie maken van deze twee vormen. Een voorbeeld is dan dat je een vraag beantwoord en dan aan het einde van het antwoord verwijst naar de schermen die hier voor nodig zijn. Bijvoorbeeld: hoe kan ik een gebruiker toevoegen?


Structuur in een handleiding De inhoud van de handleiding moet je gestructureerd houden. Daarom is het verstandig om eerst een lijst te maken met wat je allemaal wil vertellen in een handleiding. Daarna kan je dit ordenen en deze lijst in een index plaatsen. Aan de hand van deze lijst kan je gestructureerd de handleiding gaan opstellen. Beschrijf de onderdelen per categorie als je kiest voor de vorm “Vraag en antwoord” of maak een index op basis van schermnamen.

Blijf bij het onderwerp Als er een uitleg is over een bepaalde functie is het noodzakelijk om daar niet van af te wijken. Dus ga bijvoorbeeld niet opeens in de uitleg van de ene functie naar de andere. Het beste is om echt het verhaal bij het betreffende onderwerp te houden. Na deze uitleg kan je altijd nog de verwijzing(en) maken naar een ander onderwerp. Of je kan na het betreffende stukje tekst een link/ verwijzing maken naar het gerelateerde onderwerp.

Taalgebruik in een handleiding Het is de bedoeling dat een handleiding door iedereen gelezen kan worden. Daarom is het goed om zo min mogelijk jargon te gebruiken. De lezer zal dan sneller en beter begrijpen wat er bedoeld wordt en kan dan sneller uit de voeten met het afgenomen product. Mocht het toch voorkomen dat je jargon moet gebruiken, kan je aan het einde van de handleiding een trefwoorden overzicht maken waar de begrippen en definities uitgelegd worden. Maak dan van het betreffende woord in de tekst een link / verwijzing naar de uitleg in het overzicht. Ga er vanuit dat de lezer iemand is die helemaal niets weet van het afgenomen product en er voor het eerst mee moet werken.

Uitleggen met voorbeelden Meestal zal iemand de handleiding raadplegen als deze niet weet hoe iets werkt. Maak daarom van bepaalde functies een soort tutorial / voorbeeld van een bepaalde handeling. Aan de hand van voorbeelden maakt het de handleiding prettiger om te lezen en zullen de gebruikers sneller de handleiding raadplegen alvorens ze de supportdesk zullen benaderen.


Afbeeldingen gebruiken in de handleiding Als je een handleiding schrijft is het verstandig om bij de uitleg ook een afbeelding te plaatsen. Zo kan je het stuk tekst visueel toelichten. Mensen zijn visueel ingesteld en pakken dan dingen sneller op. Bij het toevoegen van afbeeldingen kunnen de volgende tips je helpen: -

Gebruik afbeeldingen die duidelijk aangeven wat er gebeurt Gebruik afbeeldingen die echt te maken hebben met het stuk tekst/ uitleg. Plaats afbeeldingen aan de linkerzijde van de tekst: mensen lezen namelijk van links naar rechts. Daarom staan logo’s op websites ook aan de linkerkant. Beschrijf bij een afbeelding wat daar gebeurt Bij een online handleiding kan je gebruik maken van kleine afbeeldingen waar de lezer op kan klikken om deze te vergroten Plaats eventueel pijltjes of kaders om een locatie in een afbeelding te benadrukken.

Screenshots maken met FireShot Mozilla Firefox en Chrome hebben verschillende add-ons (plugins) die je kunt toevoegen aan de browser. Een handige add-on om screenshots te maken van een webpagina is FireShot. Zie http://getfireshot.com/

Laten controleren van de handleiding Het is verstandig om de handleiding te laten controleren door anderen. Laat de persoon die de handleiding doorneemt letten op de wijze hoe dingen beschreven zijn. Dus is het duidelijk wat er staat? Heb je het doel behaalt met de uitleg? Laat de handleiding ook controleren op spelling en grammatica.

Tot slot Ik hoop dat je veel hebt kunnen leren, gebruiken of zal gaan toepassen wat ik hier allemaal heb beschreven. Graag zou ik je willen vragen mij een email te sturen en mij verteld wat deze PDF voor invloed heeft gehad bij het opstellen van een handleiding. Dit kan dan naar [email protected]. Hierdoor kan ik mijn informatie misschien aanpassen (verbeteren). Alvast bedankt!


Als eerste bedankt voor het aanschaffen van deze PDF waarin ik je handige tips en trucs zal geven over het schrijven van een handleiding

Recommend Documents