Handleidingen maken. Reader voor het DrentheCollege, MBO-ICT

Handleidingen maken

Reader voor het DrentheCollege, MBO-ICT.

Inhoud 1 Handleidingen schrijven

3

Kenmerken van een handleiding . . . . . . . . . . . . . . . . . . . . . . . . 3 De doelgroep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Soorten handleidingen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Structuur. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Inhoudsopgave. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Opbouw: beginpunt en eindpunt . . . . . . . . . . . . . . . . . . . . . . 5 Opmaak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Alineafuncties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Woordfuncties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Afbeeldingen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Opmaken in Word of OOO . . . . . . . . . . . . . . . . . . . . . . . . 9 Tips over schrijven en opmaken . . . . . . . . . . . . . . . . . . . . . . 9 Taal en tekst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Neutraal Nederlands . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Leesbaar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Duidelijk en eenduidig . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Jargon en verboden woorden . . . . . . . . . . . . . . . . . . . . . . . 11 Proeflezen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Naspelen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2 Handleidingen Opdracht 1

13

Een eenvoudige handleiding . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1

Handleidingen schrijven

De kwaliteit van software, een website of een apparaat hangt in grote mate af van de informatie die erbij verstrekt wordt. De nieuwe eigenaar heeft niets aan een apparaat met veel knoppen als hij of zij niet weet waarvoor de knoppen dienen. De handleiding dient ervoor om het apparaat of programma toegankelijk te maken.

Kenmerken van een handleiding Een handleiding moet aan enkele essentiële eisen voldoen: H passend bij de doelgroep H de juiste soort handleiding H herkenbare en duidelijke structuur H herkenbare opmaak H veel afbeeldingen H lekker leesbaar actief Nederlands H de juiste vaktermen op de juiste plek

(In het hoofdstuk over Stijl komen veel van deze aspecten aan de orde.)

De doelgroep Een handleiding wordt altijd gemaakt voor een specifieke doelgroep. Bij software voor algemeen gebruik moet de handleiding dus de meest eenvoudige eindgebruiker op weg kunnen helpen. Software voor een specifieke doelgroep, bijvoorbeeld procesbesturing of een boekhoudprogramma, gaat uit van bepaalde vakmatige kennis bij de gebruiker. Een boekhouder of procesmanager weet misschien veel van zijn eigen vak, maar is niet per definitie thuis in computers of software. Ook daarvoor gelden dus dezelfde eisen zoals hiervoor genoemd. Vakinhoudelijk jargon is bij zo’n handleiding onvermijdelijk maar moet tot een minimum beperkt blijven.


4

Aan de hand van doelgroep kan een aantal keuzes worden bepaald: H soort taalgebruik H u of jij (jij alleen voor kinderen) H gebruikte voorbeelden H snelheid van de handleiding – hoeveel stappen nodig zijn om een bepaalde handeling

uit te leggen H afbeeldingen – hoe eenvoudiger de doelgroep, hoe meer afbeeldingen nodig zijn H vormgeving – deze moet de doelgroep aanspreken

Soorten handleidingen Elke handleiding heeft een beginpunt en een eindpunt. Ook hier is de vergelijking met een routebeschrijving op z’n plek. Bepaal dus eerst wat de doelstelling van een handleiding is. Moeten alle functies van een programma worden beschreven, of alleen maar de kortste of eenvoudigste weg om een eindresultaat te bereiken. Grofweg kan gekozen worden uit drie soorten handleidingen: H quickstart – een stappengids die de kortste of eenvoudigste weg van A tot Z toont H manual – stappenidsen en veel info die alle functies tonen binnen een programma H projecten – aan de hand van een of meer projecten die geproduceerd worden, komen

de functies van een programma of apparaat aan de orde Veel handleidingen en met name boeken over software zijn een combinatie van deze drie. Zo bevatten veel mobiele telefoons een Quickstart (snel aan de slag) en een Manual (alle functies op een rij). Handboeken bij software zijn meestal manuals, terwijl leerboeken bij software meestal aan de hand van projecten werken. Eenvoudige boeken met een specifiek doel (LP’s op CD zetten) bevatten één project met enkele quickstart-achtige handleidingen om met de gebruikte programma’s snel en eenvoudig een einddoel te bereiken. Kies vooraf wat voor soort handleiding gemaakt moet worden.

Structuur De lezer moet op elke plek in de handleiding precies weten waar hij of zij mee bezig is en waar de paragraaf over gaat. Structuur breng je met drie hulpmiddelen aan: H inhoudsopgave H opbouw


5

Inhoudsopgave Zoals elk boekwerk – dik of dun – heeft ook een handleiding een inhoudsopgave. De inhoudsopgave zorgt ervoor dat de lezer snel een paragraaf kan vinden die hij of zij nodig heeft. Daardoor is de handleiding toegankelijk en kan ook als naslagwerk dienen. De inhoudsopgave geeft bovendien meteen een beeld van de opbouw van het apparaat of programma dat besproken wordt. Al in de inhoudsopgave ziet de lezer wat het apparaat of programma kan. Een inhoudsopgave wordt twee keer gemaakt. Voor het echte schrijven begint, wordt de eerste inhoudsopgave gemaakt om de structuur van de handleiding te bepalen. Deze inhoudsopgave kan natuurlijk tijdens het schrijven worden bijgesteld. Is de handleiding helemaal klaar, dan wordt een volledig nieuwe handleiding gemaakt, waarin alle koppen worden overgenomen uit de handleiding met het juiste paginanummer erbij.

Opbouw: beginpunt en eindpunt De opbouw van de handleiding moet natuurlijk meteen duidelijk zijn als de inhoudsopgave bekeken wordt. Denk daarom goed na over een logische en herkenbare indeling. Elke indeling moet natuurlijk een duidelijk beginpunt en een duidelijk eindpunt hebben. Dat eindpunt hangt natuurlijk weer samen met het leerdoel dat je stelt en dus met de soort handleiding.

Beginpunt Bij elke handleiding, dat geldt ook voor hoofdstukken binnen een manual of handleiding, moet bepaald worden wat het beginpunt is. Begint een handleiding bij een leeg bureaublad of bij een geopend venster dat al met allerlei data gevuld is. Bedenkt dat de lezer de beginsituatie snel en makkelijk moet kunnen begrijpen. Het is ongewenst dat een lezer op bladzijde 10 van een handleiding moet beginnen om een paragraaf van bladzijde 40 te kunnen uitvoeren. Herhaling van enkele stappen – bijvoorbeeld om een programma op te starten – op meerdere plekken in de handleiding is soms onvermijdelijk. Het beginpunt van een stappengids is dus altijd een stap met nummer 1.

Eindpunt Elke handleiding en elk deel van een handleiding kent ook een eindpunt. Meestal zal dat een bereikt resultaat zijn. Zorg in het algemeen dat elke genummerde stappengids een echt einde heeft. Zorg ook dat stappengidsen niet te lang zijn en uit teveel stappen bestaan. Dit is te voorkomen door uitgebreide functies in kleine deeltaken op te splitsen en deze stuk voor stuk met een stappengids te bespreken.


6

Opmaak Binnen een hoofdstuk of een paragraaf wil de lezer graag precies weten wat de bedoeling is. Dient een alinea om iets van te leren, moet er een handeling worden uitgevoerd, moet iets worden gekozen of getypt, begint er een nieuw onderwerp? Al deze vragen zijn meteen duidelijk als een duidelijke en consequente opmaak wordt gehanteerd. Aan de opmaak van een alinea of van een woord of groep woorden moet de lezer meteen herkennen wat de bedoeling is. Bij opmaak bestaat onderscheid tussen alinea-opmaak en woordopmaak. Alinea-opmaak dient om de functie van een alinea aan te duiden, woordopmaak dient om onderscheid te maken tussen gewone tekst, tekst die in het beeldscherm te zien is (zoals de naam van een knop) of tekst die extra moet opvallen. De functie van tekst bepaalt welke opmaak wordt gebruikt. Hoe minder verschillende soorten opmaak een handleiding heeft, hoe duidelijk deze is voor de lezer.

Alineafuncties Een handleiding mag in de tekst geen verrassingen voor de lezer hebben. De lezer moet zich volledig kunnen concentreren op het begrijpen van en leren werken met een nieuw programma of apparaat. Om dit te bereiken moet de handleiding worden opgebouwd uit logische tekstblokken – alinea’s – waarbij elk tekstblok een eigen functie en een eigen topic – onderwerp – heeft. Het aantal functies van tekstblokken in een handleiding is beperkt: H wegwijzer – koppen en tussenkoppen maken voor de lezer duidelijk ‘waar’ hij of zij H H H

H

zich in het verhaal bevindt informatie – tekstblokken die algemene of specifieke informatie verschaffen handeling – genummerde tekstblokken die de lezer opdracht geven een bepaalde handeling te verrichten, zoals ‘klik hier’, ‘kies dit of dat’, ‘typ zus of zo’ gebeurtenis – tekstblokken die vertellen wat er met het programma of apparaat gebeurt, bijvoorbeeld nadat een bepaalde handeling is verricht, zoals ‘Het venster ... verschijnt’ of ‘De muziek klinkt nu uit de luidsprekers’code – vaak moet een lezer iets exact overtypen uit de handleiding, in dat geval is het raadzaam deze tekst in een eigen alinea te zetten kader – kleine stukjes informatie die buiten de lijn van het verhaal vallen, vaak met een eigen kopje als Pas op, Waarschuwing, Tip


7

H overzichten – tabellen of opsommingen waarin allerlei mogelijkheden of functies

worden opgesomd en soms uitgewerkt De vormgeving van de tekstblokken maakt voor de lezer meteen duidelijk met wat voor tekst hij of zij te maken heeft. Zo zijn handelingen genummerd en hebben kaders een randje eromheen, een ander lettertype of ze zijn ingesprongen. Wees consequent met deze vormgeving. Vermijd het samenvoegen van meerdere functies in één tekstblok. Zo moet het niet: 1. Klik op de knop Opslaan en het venster Opslaan als verschijnt in beeld.

Zo moet het wel: 1. Klik op de knop Opslaan. Het venster Opslaan als verschijnt in beeld.

In het voorbeeld hierboven bevat de eerste alinea een handeling en de tweede alinea een gebeurtenis. Elke alinea heeft slechts één functie. Op deze manier zou een lezer alleen de handelingen kunnen nadoen zonder de andere alinea’s te lezen en toch bij een goed eindresultaat uitkomen. Door de verschillende opmaak is duidelijk wat de functie is van elke alinea in deze tekst.


8

Woordfuncties Ook woorden of uitdrukkingen binnen een alinea kunnen specifieke functies hebben. Bijvoorbeeld tekst die in de computer getypt moet worden, de naam van een knop of menu in het beeldscherm, of een tekst die in beeld zichtbaar is. Deze tekst moet duidelijk herkenbaar zijn in de zin. Voorbeeld: 1. Klik op de knop Opslaan. Het venster Opslaan als verschijnt in beeld. 2. Typ een naam voor het nieuwe document in het tekstvak Bestandsnaam. Cursief wordt alleen gebruikt om tekst die in beeld verschijnt te accentueren. Om eigen woorden te benadrukken dienen de enkele aanhalingstekens ‘en’.

Afbeeldingen Een handleiding kan in principe niet genoeg afbeeldingen bevatten. Het hangt af van het niveau van de lezer en van de soort handleiding (doelgroep en doelstelling) hoeveel afbeeldingen worden gebruikt. Eigenlijk zou bij een softwarehandleiding elk venster dat in beeld verschijnt en elke stap die wordt gezet getoond moeten worden met een afbeelding. Naast de afbeelding staat de alinea die vertelt wat er gebeurt of wat er gedaan moet worden. Afbeeldingen maken is vooral een technisch verhaal. Bij het bespreken van software moeten schermafdrukken worden getoond van de relevante vensters of van het gehele beeldscherm. Daarvoor zijn veel handige programmaatjes op de markt. De volgende zaken zijn bij het maken van afbeeldingen van belang: H maak schermafdrukken met de muisaanwijzer op de goede plek in het scherm H maak zoveel mogelijk schermafdrukken alleen van het venster waarin gewerkt wordt, H H H H

dus niet telkens van het volledige beeldscherm schermafdrukken opslaan als bmp zorg voor continuïteit – de foto’s moeten direct achter elkaar gemaakt worden (althans, zo moet het lijken) sla ze op in kleur, ook als ze voor z/w-drukwerk bestemd zijn Bewaar alle schermafdrukken van een handleiding in één map, zo nodig met een submap voor elk hoofdstuk.


9

Opmaken in Word of OOO Heb je teksten geschreven in bijvoorbeeld Word en heb je een map met afbeeldeingen klaar, dan zal dit – in de praktijk – vaak door een drukker of opmaakstudio worden verwerkt tot een echte handleiding. Is dat niet het geval, dan kun je zelf in Word, OOO of een andere tekstverwerker de zaak moeten opmaken. Let daarbij op de volgende zaken: H plaats de afbeelding naast de tekst die bij de afbeelding hoort – zie het voorbeeld

hieronder: 1. Klik dan op de knop Volgende.

Tips over schrijven en opmaken H schrijf je handleiding eerst zonder aandacht te besteden aan opmaak H maak een kopie van de geschreven tekst en maak daarin je opmaak H bewaar de afbeeldingen bij elkaar in een map, ook als deze al in je opmaakdocument H H H H

verwerkt zijn gebruik de tabelfunctie van Word of OOO om teksten en afbeeldingen netjes onder of naast elkaar te plaatsen gebruik zo min mogelijk verschillende opmaakkenmerken; hoe meer verschillende soorten opmaak, hoe minder duidelijk het verhaal is voor de lezer maak schermafdrukken van vensters en niet van het hele bureaublad (tenzij dit nodig is natuurlijk) zorg dat de muisaanwijzer zichtbaar is en zorg dat deze op de juiste plek in de afbeelding staat


10

Taal en tekst Natuurlijk wordt de handleiding geschreven met een tekstverwerker als OpenOffice.Org, Word of AbiWord. Let tijdens het tekstverwerken even op het volgende: H zet de functie voor automatische hyperlinks uit! In de tekst horen geen onderstreepte

hyperlinks te staan!

Neutraal Nederlands Elke doelgroep – jongeren, senioren, technici, leken, mannen, vrouwen – kan op een specifieke manier worden aangesproken. Hoewel de handleiding inhoudelijk moet aansluiten op de doelgroep waarvoor deze is bestemd, moet de taal voor iedereen begrijpelijk en aantrekkelijk zijn: H geen modewoorden H geen populair taalgebruik H spreek de lezer aan met u H spreek indien relevant van hij/zij en niet alleen van hij H geen vormelijk taalgebruik

Leesbaar Houd de taal lekker leesbaar, zodat de lezer zich niet op de handleiding hoeft te concentreren, maar zich kan richten op het ‘nieuwe en ingewikkelde’ apparaat of programma: H korte zinnen H geen tangconstructies H vermijd jargon H ter zake H geen grappen of bijdehante opmerkingen H tegenwoordige tijd H actief Nederlands


11

Duidelijk en eenduidig De lezer moet aan de hand van de handleiding maar één kant op kunnen. Beschouw de handleiding als een routebeschrijving en wijs de lezer de weg van A naar B. Gebruik de juiste opmaakprofielen (zie Alineafuncties) om voor de lezer duidelijk te maken wat de functie is van de tekst. Zorg ook voor eenduidig en eenvoudig taalgebruik: H gebruik steeds dezelfde woorden voor dezelfde elementen in de software H zorg dat de lezer in de handleiding ziet wat het apparaat of programma weergeeft H maak een woordenlijst en gebruik deze consequent H schrijf foutloos Nederlands H zorg voor direct en actief Nederlands

Jargon en verboden woorden Ook de computerbranche kent veel jargon – vaktaal. Zelfs eenvoudige woorden als hyperlink, afrolmenu en dubbelklikken zijn jargon. Het gebruik van jargon is onvermijdelijk. Je kunt er wel voor zorgen dat dit jargon zeer duidelijk en consequent gebruikt wordt. Zorg ook dat je geen foute uitdrukkingen gebruikt, zoals iets inbrengen in het beeldscherm. Een lijstje dat verre van compleet is, aanvullingen zijn dus welkom. H Je klik top een knop in het scherm, je drukt op een toets van het toetsenbord.

Je drukt dus niet met de muis in het scherm, je klikt niet op een toets. H Je kiest iets in een afrolmenu of je kiest iets in een menu.

Je kiest dus niet iets uit een afrolmenu. H Een afrolmenu heet niet: rolgordijn, afrollijst, combobox, of anders. H Je opent of je sluit een venster. Het venster wordt dan geopend of gesloten.

Dus niet: Het venster opent, want jij bent degene die het opent. Het opent niet zichzelf. H Je typt tekst in een tekstvak.

Je voert niets in, je brengt niets in, je geeft niets aan. H Je selecteert tekst, bestanden, of een optie in een menu. H Je geeft opdrachten.

Je geeft dus geen commando’s.


12

Pictogrammen Nog even dit: H Een ikoon is dus een beeltenis van een heilige uit de Russisch orthodoxe kerk. H Een icoon is een taalfout. H Een icon is het Engels woord voor pictogram H Een pictogram is een klein plaatje in het beeldscherm – dit laatste wordt meestal be-

doeld met bovenstaande woorden.

Proeflezen Geen enkele schrijver kan zijn of haar eigen tekst nakijken en beoordelen. Zorg dus dat jouw teksten altijd nauwkeurig door iemand anders worden gelezen en nagekeken. Niet alleen op taal- of typfouten, maar ook op de inhoud.

Naspelen De enige manier om een handleiding na te kijken is door deze na te spelen. Dus alles doen wat erin beschreven staat. Plaatjes en teksten goed bekijken en precies doen wat er staat. Zo ontdek je of er stappen worden overgeslagen, of de knopnamen wel correct in de tekst staan en of de alinea’s de juiste opmaak hebben. De proeflezer leest en corrigeert net zolang jouw versies van de handleiding, tot jullie er beiden tevreden over zijn.

2

Handleidingen Opdracht 1

Een eenvoudige handleiding De tweede opdracht van de module handleidingen behoort bij een klein programma dat waarschijnlijk Engelstalig is. Je docent Nederlands verstrekt je de hyperlink waar je een klein (freeware-)programma kunt downloaden. Je zult daarvan je zelf moeten uitzoeken wat het allemaal kan en hoe het werkt. Maak vervolgens een handleiding bij dit programma. Let daarbij op de volgende zaken: H De handleiding moet een quickstarthandleiding worden. Dus: wat is de kerntaak

van het programma en hoe voert de gebruiker die kerntaak zo snel en vooral zo eenvoudig mogelijk uit. Alle extra functies zijn dus (minder) van belang. H De doelgroep is de eenvoudige eindgebruiker – leeftijd, opleidingsniveau en geslacht zijn onbekend – die gewoon eenvoudig en snel met het stukje software uit de voeten wil kunnen. H Stel zelf vast wat het kerndoel van de software is en omschrijf dit ook aan het begin van je handleiding. H De handleiding mag full colour worden gemaakt en moet geschikt zijn om te printen.

Lever het volgende in: H De naam van het programma en een hyperlink naar de downloadlocatie. H Een Word-document met daarin de handleiding, netjes opgemaakt met de afbeelding-

en erbij. H Vergeet niet je naam in het Word-document te zetten. LET OP: HET KOPIEREN OF VERTALEN VAN BESTAANDE HANDLEIDING STAAT GELIJK AAN EXAMENFRAUDE. NIET DOEN DUS!

Handleidingen maken. Reader voor het DrentheCollege, MBO-ICT

Recommend Documents