Notities:
- Dit hoofdstuk, evenals de rest van dit tekstboek over technisch schrijven, richt zich op technische schrijfvaardigheden. De technische inhoud hier is niet gegarandeerd succesvol, nauwkeurig of actueel.
- Klik alstublieft hier om te helpen David McMurrey betaal voor webhosting: Doneer elk bedrag dat je kunt! Online Technical Writing blijft gratis.
De focus van dit hoofdstuk is een van de belangrijkste toepassingen van technisch schrijven—instructies. Zoals je weet, instructies zijn dat stapsgewijze instructies over hoe je iets moet doen: hoe je dingen bouwt, bedient, repareert of onderhoudt.
Zorg ervoor dat je de voorbeelden.
Een set instructies schrijven voor werk of voor een cursus technisch schrijven? Probeer dit instructies planning gids.
Instructies voor schrijven
Een van de meest voorkomende en een van de belangrijkste toepassingen van technisch schrijven is instructions—die stapsgewijze uitleg over hoe je dingen moet doen: iets in elkaar zetten, iets bedienen, iets repareren, of routinematig onderhoud aan iets uitvoeren. Maar voor iets dat schijnbaar zo eenvoudig en intuïtief is, behoren instructies tot de slechtst geschreven documenten die je kunt vinden. Net als ik heb je waarschijnlijk veel frustrerende ervaringen gehad met slecht geschreven instructies. Wat volgt in dit hoofdstuk is misschien geen waterdichte, volkomen onfeilbare handleiding voor het schrijven van instructies, maar het zal je laten zien wat professionals beschouwen als de beste technieken.
Uiteindelijk vereist het goed schrijven van instructies:
- Duidelijk, eenvoudig schrijven
- Een grondig begrip van de procedure in al haar technische details
- Je vermogen om jezelf in de plaats van de lezer te plaatsen, de persoon die probeert jouw instructies te gebruiken
- Uw vermogen om de procedure tot in de kleinste details te visualiseren en dat bewustzijn op papier vast te leggen
- Tot slot, je bereidheid om net dat stapje extra te zetten en je instructies te testen op het soort persoon waarvoor je ze hebt geschreven.
Intussen heb je waarschijnlijk koppen, lijsten en speciale mededelingen—het schrijven van een reeks instructies met deze hulpmiddelen lijkt waarschijnlijk voor de hand liggend. Breek de bespreking gewoon op in genummerde verticale lijsten en voeg op de voor de hand liggende punten wat speciale mededelingen toe en je bent klaar! Nou, niet helemaal, maar dat is een prima begin. Dit hoofdstuk onderzoekt enkele kenmerken van instructies die ze complexer kunnen maken. Je kunt deze overwegingen op je beurt gebruiken om je eigen instructies te plannen.
NotebookLM-gegenereerde infographic van dit hoofdstuk
Enkele inleidende opmerkingen
Aan het begin van een project om instructies te schrijven, is het belangrijk om de structuur of kenmerken van de specifieke procedure waarover je gaat schrijven vast te stellen.
Publiek en situatie. Vroeg in het proces, definieer de doelgroep en de situatie van uw instructies. Onthoud dat het definiëren van een doelgroep betekent dat u het niveau van vertrouwdheid met het onderwerp en andere dergelijke details moet aangeven. Zie de discussie over publiek en stappen om te gebruiken bij het definiëren van doelgroepen.
Het belangrijkste is dat, als je een schrijfcursus volgt, je een beschrijving van je doelgroep moet schrijven en die aan je instructies moet toevoegen. Dit stelt je docent in staat om je instructies te beoordelen op hun geschiktheid voor de beoogde doelgroep. En onthoud ook dat het in een cursus technisch schrijven de voorkeur heeft om voor niet-specialistische doelgroepen te schrijven—veel meer een uitdaging voor jou als schrijver.
Aantal taken. Hoeveel taken zijn er in de procedure waar je over schrijft? Laten we de term procedure om te verwijzen naar de gehele reeks activiteiten die uw instructies beogen te bespreken. Een taak is een semi-onafhankelijke groep handelingen binnen de procedure: bijvoorbeeld, het instellen van de klok op een magnetron is één taak in de grote, overkoepelende procedure voor het bedienen van een magnetron.
Een eenvoudige procedure zoals het verversen van de olie in een auto bevat slechts één taak; er zijn geen semi-onafhankelijke groeperingen van activiteiten. Een meer complexe procedure zoals het gebruik van een magnetron bevat veel van dergelijke semi-onafhankelijke taken: het instellen van de klok; het instellen van de vermogensstand; het gebruiken van de timer; het schoonmaken en onderhouden van de magnetron, onder andere. (De instructies voor het gebruik van een camera zijn georganiseerd op basis van taken.)
fase dan is er een groep van soortgelijke stappen binnen een procedure voor één taak. In het voorbeeld van de schommelset zou het opzetten van het frame een fase zijn; het verankeren van het ding in de grond zou een andere zijn; het monteren van de bakschommel zou weer een andere zijn.
Gebruik een taakgerichte aanpak. Richt je op de taken die je lezers willen uitvoeren; gebruik 'how to' of –ing formuleringen in koppen.
Beste aanpak voor de stapsgewijze discussie. Een andere overweging, die je misschien in een vroeg stadium niet kunt vaststellen, is hoe je je instructies moet richten. Voor de meeste instructies kun je je richten op taken, of op hulpmiddelen (of op functies van hulpmiddelen).
In een aanpak van de taak (ook wel taakoriëntatie genoemd) voor instructies over het gebruik van een telefonische antwoordservice, zou je deze secties hebben:
- je begroeting opnemen
- je berichten afspelen
- je berichten opslaan
- je berichten doorsturen
- je berichten verwijderen, enzovoort
Dit zijn tasks—de typische dingen die we met de machine zouden willen doen. Voor nadere bespreking, zie het hoofdstuk over taakanalyse.
Aan de andere kant, in een aanpak met hulpmiddelen Bij instructies voor het gebruik van een kopieerapparaat zouden er deze onwaarschijnlijke secties zijn:
- kopieerknop
- annuleerknop
- vergroten/verkleinen knop
- sorteer/niet-knop
- copy-size-knop, enzovoort
Als je een set instructies volgens dit plan zou ontwerpen, zou je stappen schrijven voor het gebruik van elke knop of functie van de kopieermachine. Instructies volgens deze hulpmiddelenbenadering zijn moeilijk goed te laten werken. Soms komt de naam van de knop niet helemaal overeen met de taak waarmee die geassocieerd is; soms moet je meer gebruiken dan die ene knop om de taak uit te voeren. Toch kunnen er momenten zijn waarop de hulpmiddelen/functiebenadering de voorkeur verdient.
Groeperingen van taken. Het opsommen van taken is misschien niet alles wat u moet doen. Er kunnen zoveel taken zijn dat u ze moet groeperen, zodat lezers individuele taken gemakkelijker kunnen vinden. De volgende taakgroeperingen komen bijvoorbeeld vaak voor in instructies:
- uitpakken en installatietaken
- installeren en aanpassen van taken
- basisbedieningstaken
- reguliere onderhoudstaken
- probleemoplossingstaken; enzovoort
Veelvoorkomende secties in instructies
Het volgende is een overzicht van de secties die je gewoonlijk in instructies zult aantreffen. Neem niet aan dat elk van hen moet niet dat ze in de daadwerkelijke instructies die u schrijft moeten voorkomen, noch dat ze in de hier gepresenteerde volgorde hoeven te staan, noch dat dit de enige mogelijke secties zijn in een set instructies.
Terwijl je het volgende over veelvoorkomende secties in instructies leest, kijk eens naar de voorbeeld instructies.
Schematische weergave van instructies. Onthoud dat dit een typisch of veelvoorkomend model is voor de inhoud en organisatie—veel andere zijn mogelijk.
Inleiding. Plan de introductie van je instructies zorgvuldig. Zorg ervoor dat de introductie een of meer van de volgende zaken doet (maar niet noodzakelijkerwijs in deze volgorde) die van toepassing zijn op jouw specifieke instructies:
- Geef de specifieke taken of procedure aan die uitgelegd moeten worden evenals de reikwijdte van de dekking (wat zal niet gedekt worden).
- Geef aan welke kennis en achtergrond het publiek nodig heeft om de instructies te begrijpen.
- Geef een algemeen idee van de procedure en wat deze bereikt.
- Geef aan onder welke omstandigheden deze instructies wel (of niet) gebruikt moeten worden.
- Geef een overzicht van de inhoud van de instructies.
Zie de sectie over introducties voor verdere bespreking.
Algemene waarschuwingen, voorzichtigheidsmeldingen, gevaarmeldingen. Instructies moeten lezers vaak waarschuwen voor de mogelijkheid dat ze hun apparatuur beschadigen, de procedure verknoeien en zichzelf verwonden. Ook moeten instructies vaak belangrijke punten of uitzonderingen benadrukken. Voor deze situaties gebruikt u bijzondere mededelingen—opmerking, waarschuwing, voorzichtigheids- en gevaarmeldingen. Let op hoe deze speciale meldingen worden gebruikt in de hierboven weergegeven voorbeeldinstructies.
Technische achtergrond of theorie. Aan het begin van bepaalde soorten instructies (na de introductie, natuurlijk) heb je mogelijk een bespreking van de achtergrond met betrekking tot de procedure nodig. Voor bepaalde instructies is deze achtergrond essentieel—anders hebben de stappen in de procedure geen zin. Bijvoorbeeld, je hebt misschien enige ervaring met die softwareapplets waarin je je eigen kleuren definieert door de schuifregelaars voor rood, groen en blauw te verschuiven. Om echt te begrijpen wat je doet, heb je wat achtergrond over kleur nodig. Evenzo kun je je voorstellen dat voor bepaalde instructies met camera's ook enige theorie nodig kan zijn.
Apparatuur en benodigdheden. Merk op dat de meeste instructies een lijst bevatten van de dingen die je moet verzamelen voordat je met de procedure begint. Dit omvat apparatuur, de gereedschappen die je in de procedure gebruikt (zoals mengkommen, lepels, broodvormen, hamers, boormachines, en zagen) en benodigdheden, de dingen die bij de procedure verbruikt worden (zoals hout, verf, olie, bloem en spijkers). In instructies worden deze meestal vermeld in een eenvoudige verticale lijst of in een twee-kolomslijst. Gebruik de twee-kolomslijst als je specificaties aan sommige of alle items moet toevoegen—bijvoorbeeld merknamen, maten, hoeveelheden, typen, modelnummers, enzovoort.
Bespreking van de stappen. Wanneer je bij het daadwerkelijke schrijven van de stappen komt, zijn er verschillende dingen om in gedachten te houden: (1) de structuur en het formaat van die stappen, (2) aanvullende informatie die mogelijk nodig is, en (3) het perspectief en de algemene schrijfstijl.
Structuur en formaat. Normaal gesproken stellen we ons een reeks instructies voor als geformatteerd als verticale genummerde lijsten. En de meeste zijn dat in feite. Normaal gesproken formatteer je je daadwerkelijke stapsgewijze instructies op deze manier. Er zijn echter enkele variaties, evenals enkele andere overwegingen:
- Stappen in vaste volgorde zijn stappen die in de aangegeven volgorde moeten worden uitgevoerd. Bijvoorbeeld, als je de olie van een auto ververst, is het aftappen van de olie een stap die moet komen voordat je de nieuwe olie erin doet. Dit zijn genummerde lijsten (meestal, verticale genummerde lijsten).
- Stappen met variabele orde zijn stappen die in praktisch elke volgorde kunnen worden uitgevoerd. Goede voorbeelden zijn die probleemoplossingsgidsen die je vertellen dit te controleren, dat te controleren wanneer je iets probeert te repareren. Je kunt dit soort stappen in praktisch elke volgorde uitvoeren. Bij dit type is een opsomming met opsommingstekens het geschikte formaat.
- Alternatieve stappen zijn die gevallen waarin twee of meer manieren om hetzelfde te bereiken worden gepresenteerd. Alternatieve stappen worden ook gebruikt wanneer verschillende omstandigheden kunnen bestaan. Gebruik bij dit type opsommingstekens, met OF tussen de alternatieven, of een inleidende zin die aangeeft dat alternatieven gepresenteerd zullen worden.
- Geneste stappen. In sommige gevallen kunnen individuele stappen binnen een procedure op zichzelf behoorlijk complex zijn en moeten ze worden opgesplitst in substappen. In dat geval gebruik je extra inspringing en nummer je de substappen als a, b, c, enzovoort.
- "Stepless" instructies. En tenslotte bestaan er instructies die echt geen genummerde verticale lijst kunnen gebruiken en die weinig, zo niet helemaal geen, rechttoe-rechtaan instructieve aanwijzingen aan de lezer geven. Sommige situaties moeten zo algemeen of zo variabel zijn dat er geen stappen kunnen worden vermeld.
Zie het hoofdstuk over lijsten voor de stijl en het formaat van deze mogelijkheden.
Aanvullende discussie. Vaak is het niet genoeg om lezers simpelweg te vertellen dit of dat te doen. Ze hebben aanvullende verklarende informatie nodig, zoals hoe het ding eruit zou moeten zien voor en na de stap; waarom ze zich zouden moeten bekommeren om het uitvoeren van deze stap; welk mechanisch principe ten grondslag ligt aan wat ze doen; zelfs meer micro-niveau uitleg van de stap—bespreking van de specifieke handelingen die deel uitmaken van de stap.
Het probleem met aanvullende toelichting is echter dat het de daadwerkelijke stap kan verbergen. Je wilt dat de daadwerkelijke stap—de specifieke handelingen die de lezer moet uitvoeren—opvalt. Je wilt niet dat het allemaal bedolven raakt onder een hoop woorden. Er zijn ten minste twee technieken om dit probleem te voorkomen: je kunt de instructie van de toelichting in aparte alinea's scheiden; of je kunt de instructie vet drukken.
Het vetgedrukt weergeven van daadwerkelijke gebruikersstappen in instructies. Vetgedrukte tekst helpt de daadwerkelijke handeling te onderscheiden van de aanvullende informatie.
Vermijd telegraphisch schrijven—door het weglaten van "understood" artikelen (the, a, an). Inderdaad, robots schrijven zo, maar dat hoeven wij niet.)
Schrijfstijl.
Een ander typisch probleem met schrijfstijl in instructies is dat mensen de neiging lijken te hebben lidwoorden weg te laten: "Druk op de pauzeknop op het voorpaneel om tijdelijk de weergave van informatie te stoppen" of "Aardbewoner, geef alstublieft het adres van het dichtstbijzijnde pizzarestaurant." Waarom doen we dit? Willen we stiekem allemaal robots zijn? Hoe dan ook, zorg ervoor dat je alle lidwoorden opneemt (een, een, de) en andere dergelijke woorden die we normaal gesproken in instructies zouden gebruiken.
Afbeeldingen in instructies
Waarschijnlijk meer dan in welke andere vorm van schrijven ook (behalve misschien bij stripboeken), zijn afbeeldingen cruciaal voor instructies. Soms kunnen woorden een stap simpelweg niet uitleggen. Illustraties zijn vaak essentieel voor het vermogen van lezers om te visualiseren wat ze moeten doen.
In een cursus technisch schrijven, kunnen instructies vereisen dat je illustraties of andere soorten grafische afbeeldingen—wat normaal gesproken in de instructies gebruikt zou worden. Het probleem kan natuurlijk zijn dat je geen toegang hebt tot grafische afbeeldingen die geschikt zouden zijn voor jouw specifieke instructies, en dat je je niet bepaald zelfverzekerd voelt over je artistieke vaardigheden. Er zijn manieren om deze problemen te overwinnen! Bekijk de suggesties in grafische afbeeldingen. In dat hoofdstuk zie je niet alleen suggesties voor het maken van afbeeldingen, maar ook eisen met betrekking tot hun formaat.
Opmaak in Instructies
Koppen. Maak in uw instructies goed gebruik van koppen. Normaal gesproken wilt u koppen voor elke achtergrondsectie die u heeft, voor de sectie 'apparatuur en benodigdheden', voor een algemene kop voor de eigenlijke instructiesectie, en voor subkoppen voor de individuele taken of fasen binnen die sectie. Bekijk de voorbeelden aan het begin van dit hoofdstuk. Zie koppen voor veelvoorkomende vereisten.
Lijsten. Evenzo, instructies maken doorgaans veelvuldig gebruik van lijsten, met name genummerde verticale lijsten voor de daadwerkelijke stap-voor-stap uitleg. Eenvoudige verticale lijsten of lijsten met twee kolommen zijn meestal goed voor de sectie apparatuur en benodigdheden. Lijsten binnen een zin zijn goed wanneer je een overzicht geeft van wat komen gaat. Zie lijsten voor veelvoorkomende vereisten.
Speciale mededelingen. In instructies moet u de lezers waarschuwen voor mogelijkheden waarin zij hun apparatuur kunnen beschadigen, voorraden kunnen verspillen, ervoor kunnen zorgen dat de hele procedure faalt, zichzelf of anderen—zelfs ernstig of dodelijk verwonden. Bedrijven zijn gedagvaard wegens het ontbreken van deze speciale waarschuwingen, wegens slecht geschreven speciale waarschuwingen, of wegens speciale waarschuwingen die op de verkeerde plaats stonden. Zie speciale mededelingen voor een volledige bespreking van het juiste gebruik van deze speciale mededelingen alsook van hun formaat en plaatsing binnen instructies.
Nummer, afkortingen en symbolen. Instructies gebruiken ook veel cijfers, afkortingen en symbolen. Voor richtlijnen op deze gebieden.
Inspringing van meldingen in instructies. In het eerste voorbeeld, let op hoe de melding is ingesprongen tot de tekst van de voorgaande stap. In het tweede voorbeeld, merk op dat de ernstige melding aan het begin vóór een van de stappen is geplaatst.
AI-prompts voor instructies
Checklists, die doorgaans ongelezen blijven, kunnen met enige aanpassing als bron voor AI-prompts worden gebruikt. Kopieer het volgende, plak het in een AI-systeem zoals Google's Gemini, en kijk wat je mogelijk gemist hebt.
Opmerking: Alle verwijzingen naar de inhoud, het formaat, de stijl van instructies of hun componenten zijn te vinden in de online leerboek technisch schrijven.
Wanneer je AI wilt gebruiken om een schrijfproject te evalueren, stel jezelf voor, vertel de AI wie je bent en wat je wilt. Geef de AI een referentiepunt voor het uitvoeren van evaluaties, zoals een online leerboek. Plaats daarna wat je wilt dat de AI controleert in de evaluatie.
Pas de introductie aan zodat deze bij jouw identiteit past.
|
Instructies voor AI-prompts Hallo, AI. Ik verzoek je de instructies te evalueren die zijn geschreven door een tweedejaarsstudent aan een Amerikaanse universiteit. Hieronder staat een samenvatting van hoofdstukken uit het leerboek over instructies en mededelingen om te gebruiken als basis voor uw beoordeling. (Identificerende informatie verborgen):
|
Gerelateerde informatie
Leesquiz. Gebruik deze quiz om je begrip van dit hoofdstuk te testen.
Quizzen: grammatica, gebruik, interpunctie.
Hoe kan ik effectieve instructiehandleidingen maken
De verborgen kosten van zo intuïtief dat het geen handleiding nodig heeft
Dragen operationele handleidingen bij aan bedrijfsprestaties?
Hoe instructies te schrijven. techschrijver
Ik zou uw gedachten, reacties en kritiek met betrekking tot dit hoofdstuk op prijs stellen: jouw antwoord—David McMurrey.
