Eisen aan gebruiksaanwijzingen voor installaties eisen aan documentatie
Enkele specifieke aanbevelingen zijn:
1. Breng op het voorblad een goede afbeelding aan van de machine of installatie. Als er problemen zijn wordt meestal direct de gebruiksaanwijzing geraadpleegd. Deze afbeelding verkleint de kans dat iemand de verkeerde gebruiksaanwijzing gebruikt.
2. Hou de gebruiksaanwijzing overzichtelijk. Plaats op de binnenkant van het voorblad een kader voor een "noodtelefoonnummer". De gebruiker heeft dan, in geval van niet te verhelpen storingen, altijd het telefoonnummer van de reparateur bij de hand.
3. Laat de handleiding eens door een onafhankelijke, niet deskundige lezen en van commentaar voorzien. Gebruik de kritiek om de gebruiksaanwijzing aan te passen. Dan zal ook duidelijk worden hoe moeilijk het is een goede gebruiksaanwijzing te schrijven.
4. Laat bij complexe machines of installaties een documentalist de handleiding uitwerken. Tegen een geringe meerprijs wint de gebruiksaanwijzing aan kwaliteit en wordt de tekst sterk bekort. Dit levert bij export een kostenbesparing op in het vertaalwerk.
5. Sluit het onbedoelde gebruik uit door vermelding van de tekst "Deze machine is uitsluitend bestemd voor....... . Bij wijziging van het gebruiksdoel vervalt de geldigheid van de CE markering." Eventueel kan worden aangegeven dat, op verzoek van de klant, wordt uitgezocht wat gedaan moet worden om in dat geval de CE markering te behouden. Dit houdt niet in, dat in de risico analyse het onbedoelde gebruik mag worden overgeslagen!
6. Soms wordt onderscheid gemaakt tussen het gebruik (bevoegdheden) door bedieningspersoneel en gebruik (bevoegdheden) van technisch personeel. Zorg dan wel voor twee aparte gebruiksaanwijzingen. Op deze manier wordt het risico ontlopen dat juist de duidelijke voorschriften voor een bediener de aanleiding vormen een eventueel defect zelf op te lossen. Indien bepaalde werkzaamheden uitsluitend door de dealer of uw eigen personeel mag worden uitgevoerd, vermeld dit dan expliciet in de gebruiksaanwijzing. Neem in een gebruiksaanwijzing alleen de gegevens op voor werkzaamheden op waartoe de gebruiker, waarvoor de gebruiksaanwijzing is bestemd, bevoegd is.
7. Voeg technische bijlagen toe voor zover deze nodig zijn om de machine veilig te kunnen gebruiken. Onder gebruik wordt in de richtlijnen ook verstaan het transport, de installatie, het onderhoud, de reparatie e.d. van de machine!
Bij het schrijven van een gebruiksaanwijzing, groter dan een A-4, is het raadzaam de norm NEN 5509 voor gebruiksaanwijzingen te volgen. In de CEdoc pakketten is deze norm standaard in de software verwerkt. Bij het invoeren en printen van gegevens volgt het pakket de richtlijn. Kiest u voor het printen van een gebruiksaanwijzing, dan volgt het pakket de NEN 5509. Andere softwarepakketten hebben deze mogelijkheden (nog) niet.
CEdoc is verkrijgbaar bij Technisch Bureau Integral. Voor nadere gegevens zie sheet CE software.
Gebruiksaanwijzing
Een installateur zal veel gebruiksaanwijzingen van derden geleverd krijgen. Zeker als hij uitsluitend samenbouwt zal hij vaak kunnen volstaan met een gebruiksaanwijzing, waarin hij verwijst naar de gebruiksaanwijzingen die hij toegeleverd heeft gekregen. Echter door het samenbouwen van bepaalde componenten kunnen nieuwe risico's ontstaan. Deze moeten wel worden opgenomen in de gebruiksaanwijzing van de installateur!
De installateur die zelf onderdelen maakt, of niet (duidelijk) wil laten weten waar hij inkoopt, zal zelf een complete gebruiksaanwijzing moeten schrijven. Dit is een vak op zich! Om een foutieve gebruiksaanwijzing te voorkomen dient rekening gehouden te worden met de volgende:
1. Voorkom gedachten sprongen in de tekst.
2. Stem taalgebruik af op de gebruiker.
3. Tekeningen geven vaak betere informatie dan tekst.
4. Zorg voor een goede vertaling.
5. Maak gebruik van attenderings tekens of vignetten in de tekst.
6. Geef een duidelijke inhoudsopgave.
7. Zorg voor een goede lay-out.
8. Schrijf actiegericht in plaats van beschrijvend.