Technisch schrijven voor technici

Een van de meest voorkomende en belangrijkste toepassingen van technisch schrijven zijn instructies – stap-voor-stap wordt uitgelegd hoe je iets moet doen: iets in elkaar zetten, iets bedienen, iets repareren, of een persoonlijk proces uitleggen (je inschrijven voor de universiteit bijvoorbeeld) zodat lezers het beter begrijpen en het eventueel zelf kunnen gebruiken.

Procesteksten zijn uiterst gebruikelijk op school en in beroepen. Op school geven leraren vaak procesopdrachten. Professoren geesteswetenschappen kunnen bijvoorbeeld vragen om een beschrijving van hoe een artistieke of literaire periode zich heeft ontwikkeld; professoren geschiedenis, de bijdragen van de leiders van een cultuur in de loop der tijd; professoren sociale wetenschappen, de chronologie van uitvindingen; professoren techniek, uitleg over hoe geluid wordt omgezet in elektrische signalen; professoren bedrijfskunde, hoe de Federal Reserve werkt of hoe een product te verkopen.

Op dagelijkse basis lezen we beschrijvende processen, waaronder recepten, gebruikershandleidingen voor nieuwe software, of advies columns over hoe om gewicht te verliezen of hoe om te slagen in school of een beroep. Deze teksten richten zich op het beantwoorden van een van de volgende vragen:

• “Hoe wordt dit gedaan?”
• “Hoe kan ik dit doen?”

Hoewel de onderwerpen van een procesverslag of een set instructies kunnen variëren, delen vele overeenkomsten: de meeste zijn geschreven om uit te leggen hoe iets werkt, de meeste zijn gestructureerd in chronologische volgorde met behulp van genummerde stappen, en de meeste maken uitgebreid gebruik van visuals. Bij het schrijven van instructies voor het leren van een nieuw softwareprogramma, bijvoorbeeld, kunnen schrijvers schermafbeeldingen en/of schermvideo’s gebruiken om gebruikers door de handleiding te leiden.

Over het algemeen is het goed om zowel tekst als beeldmateriaal in uw instructies te gebruiken, omdat uw publiek waarschijnlijk bestaat uit mensen met verschillende leerstijlen. Echter, het gebruik van visuals kan variëren, afhankelijk van uw publiek en het beoogde gebruik van de instructies. Visuals helpen om een concept te verduidelijken dat moeilijk uit te leggen is met alleen woorden. Afbeeldingen kunnen worden gebruikt om te laten zien hoe iets eruit ziet, hoe iets eruit moet zien als de stap is voltooid, hoe iets wordt gedaan of opgebouwd, trends of relaties te laten zien, levendigheid aan het project toe te voegen, of gewoon helpen informatie te ordenen. Grafieken zijn nuttig omdat bijna iedereen (ook kinderen en anderen met een andere taal) visuele instructies kan begrijpen en precies kan zien wat ze moeten voltooien.

Typen instructies

Er zijn drie hoofdtypen procesteksten:

• • • Beschrijvende processen: deze geven antwoord op de vraag: “Hoe wordt dit gedaan?” Deze teksten beschrijven hoe een proces verloopt, zodat lezers het beter kunnen begrijpen. Als u bijvoorbeeld een beschrijvend proces schrijft over hoe u zich online hebt ingeschreven voor een cursus in plaats van persoonlijk, kan dat nuttig zijn voor iemand die nog nooit online heeft ingeschreven.

• • • Prescriptieve processen: deze zijn verklarend van aard; ze schrijven voor hoe iets wordt gedaan (of zou moeten worden gedaan), zodat lezers het zelf kunnen doen. Dit zijn de meest voorkomende soorten instructieve documenten. Je zou bijvoorbeeld een prescriptieve procesgids kunnen schrijven voor gebruikers waarin wordt uitgelegd hoe ze basisonderhoud aan hun auto kunnen uitvoeren, zoals het verversen van hun eigen olie, het controleren van bougies, of het vervangen van remblokken. *De voorbeelden hieronder zijn voorbeelden van prescriptieve processen.

• • • Gemengde beschrijvende en prescriptieve processen maken dat de hoofdgedachte van het document een beschrijvend proces is terwijl er een paar secties zijn waarin wordt samengevat hoe de lezers het proces kunnen uitvoeren. Met andere woorden, schrijvers kunnen zowel “Hoe kan ik dit doen?” als “Hoe wordt dit gedaan?” in verschillende delen van één tekst behandelen. Een andere mogelijkheid is dat ze verschillende versies van hetzelfde document ontwikkelen voor twee doelgroepen: een publiek van gebruikers en een publiek van belangstellenden.

Getting Started

Aan het begin van een project of opdracht voor het schrijven van instructies is het belangrijk om rekening te houden met uw publiek en de kenmerken (het aantal taken en stappen) te bepalen van de specifieke procedure waarover u wilt schrijven.

Doelgroep en situatie: Vroeg in het proces, definieer het publiek en de situatie van uw instructies. Vergeet niet dat het definiëren van een publiek betekent dat het kennisniveau en de bekendheid met het onderwerp moeten worden vastgesteld. Het is soms nuttig om uw publiek eerst voor uzelf te beschrijven, en dat dan te gebruiken om uw boodschap aan het eind te beoordelen om er zeker van te zijn dat deze geschikt is voor uw publiek.

Aantal taken: Een belangrijke overweging is hoeveel taken er zijn in de procedure waarvoor u instructies schrijft. De term procedure kan worden gebruikt om te verwijzen naar het geheel van activiteiten die uw instructies bespreken, terwijl taak kan worden gebruikt om een semi-onafhankelijke groep van acties binnen de procedure te definiëren. Bijvoorbeeld, het instellen van je modem is één taak in de totale procedure van het aansluiten van een computer op het internet.

Een ander voorbeeld, een eenvoudige procedure zoals het verversen van de olie van een auto bevat slechts één taak; er zijn geen semi-onafhankelijke groeperingen van andere activiteiten. Een meer complexe procedure, zoals het gebruik van een magnetron, bevat tal van semi-onafhankelijke taken, zoals het instellen van de klok, het instellen van het vermogen, het gebruik van de timer, het schoonmaken en onderhouden van de magnetron, en nog veel meer.

Sommige instructies hebben slechts een enkele taak, maar hebben vele stappen binnen die enkele taak. Stel je bijvoorbeeld een reeks instructies voor het in elkaar zetten van een schommel voor kinderen voor. Een effectieve aanpak zou zijn om soortgelijke en verwante stappen te groeperen in fasen, en dan de stappen bij elke nieuwe fase te hernummeren. Een fase is een groep van gelijksoortige stappen binnen een procedure met één taak. In het voorbeeld van de schommelset zou het opzetten van het frame één fase zijn; het verankeren van het ding in de grond een andere; en het in elkaar zetten van de schommeldoos weer een andere.

Focussen van instructies

Een andere overweging, die je misschien niet in een vroeg stadium kunt bepalen, is hoe je je instructies moet richten. Voor de meeste instructies kunt u zich richten op de taken die erbij komen kijken, of op de hulpmiddelen die nodig zijn.

• • • In een taakgerichte benadering van instructies voor het gebruik van een telefoonantwoordapparaat, zou u hoofdstukken hebben over het inspreken van uw begroeting, het afspelen van uw berichten, het opslaan van uw berichten, het doorsturen van uw berichten en het verwijderen van uw berichten. Dit zijn taken – de typische dingen die gebruikers met het apparaat willen doen.

• • • Aan de andere kant zou een instructie voor het gebruik van een fotokopieerapparaat secties bevatten over de kopieerknop, de annuleerknop, de vergroten/verkleinen-knop, de vergaar/vernietig-knop, de papierlade, de knop voor het kopieerformaat, enzovoort. Als je een instructieset over dit plan zou ontwerpen, zou je waarschijnlijk stappen schrijven voor het gebruik van elke knop of functie van het kopieerapparaat.

Instructies Inhoud

Lees eerst het gedeelte “Documentontwerp” voordat je je instructies maakt. Neem de volgende onderdelen op:

Inleiding: Zorg bij het zorgvuldig plannen van de inleiding van uw instructies voor:

• • • • Geef aan wat de specifieke taken of procedure zijn die moeten worden uitgelegd.
      • Geef aan wat het publiek aan kennis en achtergrond nodig heeft om de instructies te begrijpen.
      • Geef een algemeen idee van de procedure en wat ermee wordt bereikt.
      • Geef aan onder welke omstandigheden deze instructies wel (of niet) moeten worden gebruikt.
      • Geef een overzicht van de inhoud van de instructies.

Algemene waarschuwingen, voorzorgsmaatregelen, gevarenaanwijzingen: In de instructies moeten de lezers ook worden gewezen op de mogelijkheid dat zij hun apparatuur ruïneren, de procedure verknoeien en/of zichzelf verwonden. Ook moeten instructies belangrijke punten of uitzonderingen benadrukken. Voor deze situaties moet je speciale mededelingen gebruiken, zoals Opmerking, Waarschuwing, Voorzichtig, en/of Gevaar.

Technische achtergrond of theorie: Aan het begin van sommige instructies (meestal na de inleiding), kan het nodig zijn dat u een bespreking geeft van de achtergrond met betrekking tot de procedure. Voor bepaalde instructies is deze achtergrond van cruciaal belang – anders hebben de stappen in de procedure geen zin. In sommige gevallen moeten schrijvers van instructies veel tijd besteden aan het uitleggen van dingen aan lezers voordat ze overgaan tot de eigenlijke stappen in het proces.

Uitrusting en benodigdheden: De meeste instructies bevatten een lijst van de dingen die u moet verzamelen voordat u met de procedure begint. Hieronder vallen uitrusting, het gereedschap dat u bij de procedure gebruikt (zoals mengkommen, lepels, broodpannen, hamers, boren en zagen) en benodigdheden, de dingen die bij de procedure worden verbruikt (zoals hout, verf, olie, meel en spijkers). In een gebruiksaanwijzing worden deze zaken meestal vermeld in een eenvoudige verticale lijst of in een lijst met twee kolommen aan het begin van de gebruiksaanwijzing. Gebruik de lijst met twee kolommen als u aan sommige of alle artikelen specificaties moet toevoegen – bijvoorbeeld merknamen, maten, hoeveelheden, soorten, modelnummers, enzovoort.

Discussie van de stappen: Wanneer u aan het eigenlijke schrijven van de stappen toekomt, moet u zorgvuldig nadenken over de structuur en de opmaak van die stappen, over eventuele aanvullende informatie die nodig kan zijn, en over het gezichtspunt en de algemene schrijfstijl van de instructies. Een gezichtspunt dat bij het technisch schrijven wordt gebruikt is de tweede persoon, waarbij het publiek als uzelf wordt aangesproken.

* Over het algemeen moeten schrijvers van instructies het volgende nastreven:

• • • Gebruik waar mogelijk een duidelijke, eenvoudige schrijfwijze.

• • • Heb een grondige kennis van het proces in al zijn technische details.

• • • Probeer uzelf in de plaats te stellen van de lezer die uw instructies zal gebruiken.

Studenteninstructievoorbeelden

• Lasinstructievoorbeeld (studentenvoorbeeld)

• Mechatronica-instructievoorbeeld – Diodes testen & Transistors (leerlingvoorbeeld)

• Auto/Diesel Instructies – Hoe vervang ik een achterste stabilisatorstang op een Toyota Corolla (leerlingvoorbeeld)

• Bed Overzetinstructies (leerlingvoorbeeld)

• Gitaarsnaren verwisselen (leerlingvoorbeeld)

Professionele instructievoorbeelden

• Lasinstructies monster 1 (professioneel voorbeeld)

Professionele instructievoorbeelden

• Instructiemonster 1 (professioneel monster)

• Barbie Droomhuis (professioneel monster)

• Trampoline in elkaar zetten (professioneel monster)