Bel mij terug > Bel ons: +31 (0) 20 2050333

Handleiding ontwerpen

 

U wilt een handleiding ontwerpen?

Wellicht spelen de volgende vragen:

 

  • Welke norm(en) kan ik gebruiken?
  • Welke structuur dien ik aan te houden?
  • Hoe moet ik de inhoud presenteren?
  • Hoe formuleer ik mijn teksten?

Uw handleiding uitbesteden? Vraag direct een offerte aan >


Handleiding ontwerpen?

 

Het leveren van een handleiding als integraal onderdeel van het product is voor vele producten verplicht.  Deze verplichting komt voort uit het gegeven dat wij in Europa, maar ook in de rest van de wereld, het belangrijk vinden om afspraken te maken over producten, zodat de veiligheid van de gebruiker gewaarborgd wordt. Deze afspraken worden vastgelegd in richtlijnen. Richtlijnen stellen essentiële eisen aan veiligheid, gezondheid, milieu en consumentenbescherming voor producten die binnen de Europese Economische Ruimte (EER: de Europese Unie plus Liechtenstein, Noorwegen en IJsland) in de handel worden gebracht. Richtlijnen kunnen de producent verplichten ervoor te zorgen dat de gebruiker de nodige inlichtingen krijgt voor het goed en veilig kunnen gebruiken van een product. Onder de richtlijnen hangen als het ware de normen. De normen beschrijven hoe de eisen uit de richtlijn (technisch) gerealiseerd kunnen worden. In Nederland bestaat er voor het schrijven van gebruikershandleidingen de NEN5509 (een internationale norm is de IEC 82079). Gaat u een handleiding ontwerpen? Zorg ervoor dat u op de hoogte bent van de voor u van toepassing zijnde verplichtingen.

 

NEN5509 Gebruikershandleidingen

 

De NEN5509 ziet gebruikershandleidingen als een middel tot informatie en instructie. Een handleiding kan apart worden gebruikt of in combinatie met andere instructies, zoals tekens, etiketten, symbolen, tabellen, figuren, enzovoort. Het doel van een handleiding is volgens deze norm het instrueren van de gebruiker, zodat deze handelingen verricht volgens de instructies van de producent. Hierdoor wordt de gebruiker gestuurd om het product veilig en juist te gebruiken. De handleiding wordt gezien als onderdeel van het product. Indien de producent tot de conclusie komt dat het nodig is om de gebruiker te instrueren tijdens een fase van de levensduur van het product (bijvoorbeeld tijdens transport, montage, installatie, ingebruikname, gebruik, onderhoud, storing of sloop), dan moet hij een handleiding ontwerpen waarin dit wordt aangegeven.

 

Deze norm, die binnenkort wordt herzien, geeft een minimum aan eisen met betrekking tot de informatieve inhoud, de structuur, de formulering en de presentatie voor gebruikershandleidingen voor de Nederlandse markt. Deze aanwijzingen en aanbevelingen geven uitleg, informatie en opdrachten aan de gebruikers van zowel consumentenproducten als gebruikers van ingewikkeldere systemen en machines. Een reden voor de herziening van de norm is overigens dat deze onvoldoende aansluiting vindt met de Machinerichtlijn.


Inhoud handleiding

 

In haar meest complete vorm bevat een handleiding volgens de NEN5509 de volgende onderdelen:

  • Technische specificaties
  • Voorzorgsmaatregelen en veiligheidsinstructies
  • Beschrijving van het product
  • Montage, installatie en ingebruikname
  • Beschrijving van de bediening
  • Onderhoud en onderhoudsschema
  • Buitenbedrijfstelling
  • Demontage, sloop; opslag en transport
  • Storing en reparatie
  • Milieu
  • Afdanken

De ‘Technische specificaties’ beschrijven de werkingskarakteristieken, de prestaties, de omgevingsinvloeden en belangrijke constructiegegevens van het product. De ‘Voorzorgsmaatregelen en veiligheidsinstructies’ waarschuwen voor mogelijke gevaarlijke situaties die bij te voorzien gebruik van het product kunnen optreden. Ook geven ze waarschuwingen van gevaarlijke situaties die kunnen optreden bij redelijkerwijs te voorzien onjuist gebruik. De constructie of samenstelling van het product wordt beschreven in een apart deel dat gaat over de beschrijving van het product. In het onderdeel ‘Montage, installatie en ingebruikname’ wordt alle informatie gegeven die betrekking heeft op de beschreven handelingen. Het daadwerkelijke gebruik wordt in het deel ‘Beschrijving van de bediening’ beschreven. Instructies over eventueel onderhoud moeten in het hoofdstuk ‘Onderhoud’ worden geplaatst. ‘Buitenbedrijfstelling’ gaat over de handelingen nodig voor het buitenbedrijfstellen van, vaak grote, complexe installaties. ‘Demontage, sloop; opslag en transport’ beschrijft voorzorgsmaatregelen en instructies om het product klaar te maken voor demontage, sloop, opslag, transport en herinstallatie in een veranderde omgeving of op een andere plaats. Het onderdeel ‘Storingen en reparatie’ vermeldt de ingrepen en reparaties die de gebruiker zelf kan uitvoeren. Zaken met betrekking tot milieuaspecten (zoals de gevolgen van de WEEE-richtlijn), energiebesparing en hergebruik worden in het onderdeel ‘Milieu’ beschreven. Tot slot biedt het hoofdstuk ‘Afdanken’ de mogelijkheid om handelingen die de gebruiker moet verrichten bij het levenseinde van een product te omschrijven.

 

Structuur handleiding

 

De hierboven beschreven inhoud van de handleiding moet worden aangevuld met de onderstaande onderdelen. Tezamen vormen zij de complete handleiding.

  • Titelpagina
  • ‘Woord vooraf’ of ‘Gids voor de gebruiker’
  • Inhoudsopgave
  • Inleiding
  • Register
  • Verklarende woordenlijst (glossarium)
  • Verkorte instructie
  • Bijlagen

Op de ‘Titelpagina’ moeten zaken staan zoals de naam van de handleiding, de versie en datum, de naam van het product en de uitgevende instantie. In het ‘Woord vooraf’ worden de gebruikers beschreven, de plaats van de handleiding in het totaal van informatie over het product en de gebruikte symbolen nodig om de tekst of figuren te kunnen begrijpen. Een ‘Inhoudsopgave’ wordt aangeraden voor iedere handleiding van meer dan vijf pagina’s. De ‘Inleiding’ beschrijft met name het doel en de functie van het product. Het opnemen van zaken zoals een ‘Register’, ‘Verklarende woordenlijst’, ‘Verkorte instructie’ en ‘Bijlagen’ spreken voor zich.

 

Presentatie handleiding

 

Wat betreft de presentatie van de handleiding zijn de volgende aspecten van belang:

  • Presentatie en opmaak van de gebruikershandleiding
  • Lettertype en lettergrootte
  • Markeringen
  • Paginanummering
  • Bekopping
  • Gebruik van kleuren
  • Losbladige of vastbladige bindingen
  • Tekst en figuren (ook op uitslaande pagina)
  • Plaats van aanwijzingen

 

De formulering van een handleiding

 

Bij het ontwerpen van de handleiding is het belangrijk dat er kennis over de doelgroep aanwezig is. Teksten moeten dusdanig geformuleerd worden dat de gebruiker deze kan begrijpen. Jargon moet verklaard worden. Gebruik alleen genormaliseerde begrippen en gebruik alleen SI-grootheden en -eenheden.

 

De instructies die nodig zijn voor het schrijven van een juiste handeling moeten beschreven worden met opdrachten die alleen bij een enkele handeling horen. Gebruik verwijzingen naar instructies, beschreven in een ander deel van de handleiding, indien deze ingewikkeld zijn of terugkeren.

Iedere instructie kan uit de volgende onderdelen bestaan:

  • Nummer van de instructie
  • Formulering
  • Toelichting (het waarom)
  • Effect

Het ontwerpen van een handleiding moet met veel zorg gebeuren en er zijn verschillende normen die hierbij kunnen helpen. Een goede vraag blijft echter: schrijft u de handleiding zelf of schakelt u hiervoor een specialist in? Enkele voorbeelden van handleidingen zijn te vinden via deze link.

 


Wilt u ook uw handleiding door ons laten maken? Vraag direct een offerte aan >


Bel mij terug > Bel ons: +31 (0) 20 2050333

Heeft u vragen omtrent onze diensten? Wij beantwoorden uw vragen graag persoonlijk.