Notities:
- Dit hoofdstuk, evenals de rest van dit technische schrijfboek, richt zich op technische schrijfvaardigheden. De technische inhoud hier is niet gegarandeerd succesvol, nauwkeurig of up-to-date.
- Klik hier om te helpen David McMurrey betaal voor webhosting: Doneer elk bedrag dat je kunt! Online Technisch Schrijven blijft gratis.
De focus van dit hoofdstuk is een van de belangrijkste toepassingen van technisch schrijven—instructies. Zoals je weet, instructies zijn dat stap-voor-stap uitleggen over hoe je iets doet: hoe je dingen bouwt, bedient, repareert of onderhoudt.
Instructies schrijven voor werk of voor een technische schrijfklasse? Probeer dit. instructies planningsgids.
Schrijfinstructies
Een van de meest voorkomende en een van de belangrijkste toepassingen van technisch schrijven zijn instructies—deze stapsgewijze uitleggen over hoe dingen te doen: iets monteren, iets bedienen, iets repareren of routineonderhoud aan iets uitvoeren. Maar voor iets dat schijnbaar zo eenvoudig en intuïtief is, zijn instructies enkele van de slechtst geschreven documenten die je kunt vinden. Zoals jij, heb ik waarschijnlijk veel frustrerende ervaringen gehad met slecht geschreven instructies. Wat volgt in dit hoofdstuk is misschien geen onfeilbare, foutloze gids voor het schrijven van instructies, maar het zal je laten zien wat professionals beschouwen als de beste technieken.
Uiteindelijk vereist goed instructieschrijven:
- Duidelijk, eenvoudig schrijven
- Een grondig begrip van de procedure in al zijn technische details
- Je vermogen om jezelf in de positie van de lezer te plaatsen, de persoon die jouw instructies probeert te gebruiken.
- Je vermogen om de procedure in grote details te visualiseren en dat bewustzijn op papier vast te leggen.
- Ten slotte, uw bereidheid om die extra afstand te gaan en uw instructies te testen op het soort persoon voor wie u ze heeft geschreven.
Tegenwoordig heb je waarschijnlijk koppen, lijsten en speciale mededelingen bestudeerd—het schrijven van een set instructies met deze hulpmiddelen lijkt waarschijnlijk voor de hand liggend. Breek de discussie gewoon op in genummerde verticale lijsten en voeg op de voor de hand liggende punten enkele speciale mededelingen toe, en je bent klaar! Nou, niet helemaal, maar dat is een prima begin. Dit hoofdstuk verkent enkele van de kenmerken van instructies die ze complexer kunnen maken. Je kunt deze overwegingen op hun beurt gebruiken om je eigen instructies te plannen.
NotebookLM-gegenereerde infographic van dit hoofdstuk
Enkele Voorbereidingen
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, te bepalen.
Publiek en situatie. Vroeg in het proces, definieer het publiek en de situatie van je instructies. Vergeet niet dat het definiëren van een publiek betekent dat je ook het niveau van bekendheid met het onderwerp en andere dergelijke details moet bepalen. Zie de bespreking van publieken en stappen om te gebruiken bij het definiëren van doelgroepen.
Het belangrijkste is dat als je in een schrijf cursus zit, je een beschrijving van je publiek moet schrijven en deze aan je instructies moet bevestigen. Dit stelt je instructeur in staat om je instructies te beoordelen op hun geschiktheid voor het bedoelde publiek. En herinner je ook dat het in een technische schrijf cursus de voorkeur heeft om te schrijven voor niet-specialistische publieken—veel meer van een uitdaging voor jou als schrijver.
Aantal taken. Hoeveel taken zijn er in de procedure waar je over schrijft? Laten we de term gebruiken procedure om te verwijzen naar de hele set activiteiten waar jouw instructies op gericht zijn. A taak is een semi-onafhankelijke groep van acties binnen de procedure: bijvoorbeeld, de klok instellen op een magnetron is één taak in de grote overkoepelende procedure van 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 complexere procedure zoals het gebruik van een magnetron bevat veel van zulke semi-onafhankelijke taken: de klok instellen; het vermogensniveau instellen; de timer gebruiken; de magnetron reinigen en onderhouden, onder andere. (De instructies voor het gebruik van een camera zijn georganiseerd per taken.)
Sommige instructies hebben maar één enkele taak, maar bevatten veel stappen binnen die enkele taak. Stel je bijvoorbeeld een set instructies voor het monteren van een schommelset voor kinderen voor. Uit mijn eigen ervaring waren er meer dan 130 stappen! Dat kan wat ontmoedigend zijn. Een goede aanpak is om gelijkaardige en gerelateerde stappen te groeperen in fasen, en de stappen opnieuw te nummeren bij elke nieuwe fase. Een fase dan is een groep van vergelijkbare stappen binnen een enkele-taak procedure. In het voorbeeld van de schommeling zou het opzetten van het frame een fase zijn; het verankeren van het ding in de grond zou een andere zijn; het samenstellen van de doos-schommel zou weer een andere zijn.
Gebruik taakgerichtheid. Focus op de taken die je lezers willen uitvoeren; gebruik "hoe te" of –-vorm in de koppen.
Beste aanpak voor de stapsgewijze discussie. Een andere overweging, die je misschien niet in het begin kunt bepalen, is hoe je je instructies kunt focussen. Voor de meeste instructies kun je je richten op taken, of je kunt je richten op hulpmiddelen (of functies van hulpmiddelen).
In een taak aanpak (ook bekend als taakoriëntatie) voor instructies over het gebruik van een telefoondiensten, zou je deze secties hebben:
- uw begroeting opnemen
- uw berichten afspelen
- je berichten opslaan
- je berichten doorsturen
- je berichten verwijderen, enzovoort
Dit zijn taken—de typische dingen die we met de machine zouden willen doen. Voor verdere discussie, zie het hoofdstuk over taakanalyse.
Aan de andere kant, in een tools benadering bij de instructies voor het gebruik van een fotokopieerapparaat zouden deze onwaarschijnlijke secties kunnen zijn:
- kopieer knop
- annuleerknop
- vergroten/verkleinen knop
- collate/ nietjesknop
- kopieer-grootte knop, enzovoort
Als je een set instructies voor dit plan zou ontwerpen, zou je stappen schrijven voor het gebruik van elke knop of functie van de copier. Instructies die deze toolsbenadering gebruiken zijn moeilijk te maken. Soms komt de naam van de knop niet precies overeen met de taak waarmee deze is geassocieerd; soms moet je meer dan alleen die ene knop gebruiken om de taak te voltooien. Toch kunnen er momenten zijn waarop de tools/functiebenadering te verkiezen is.
Groeperingen van taken. Het opsommen van taken is misschien niet alles wat je hoeft te doen. Er kunnen zoveel taken zijn dat je ze moet groeperen zodat lezers individuele taken gemakkelijker kunnen vinden. Bijvoorbeeld, de volgende zijn veelvoorkomende taakgroeperingen in instructies:
- uitpakken en opstellingstaken
- taken installeren en aanpassen
- basisbedrijfsactiviteiten
- routine onderhoudstaken
- probleemoplossingstaken; enzovoort
Veelvoorkomende Secties in Instructies
De volgende is een beoordeling van de secties die je vaak zult vinden in instructies. Neem niet aan dat elk van hen moet zijn in de daadwerkelijke instructies die je schrijft, noch dat ze in de volgorde gepresenteerd moeten worden, noch dat dit de enige secties zijn die mogelijk zijn in een set instructies.
Terwijl je het volgende over veelvoorkomende secties in instructies leest, kijk naar de voorbeeld instructies.
Schematische weergave van instructies. Vergeet niet dat dit een typisch of algemeen model is voor de inhoud en organisatie—veel anderen zijn mogelijk.
Inleiding. Plan de inleiding van je instructies zorgvuldig. Zorg ervoor dat het een van de volgende dingen doet (maar niet noodzakelijk in deze volgorde) die van toepassing zijn op jouw specifieke instructies:
- Geef de specifieke taken of procedure aan die moeten worden uitgelegd, alsook de reikwijdte van de dekking (wat zal niet bedekt zijn).
- Geef aan welke kennis en achtergrond het publiek nodig heeft om de instructies te begrijpen.
- Geef een algemeen idee van de procedure en wat het bereikt.
- Geef de voorwaarden aan wanneer deze instructies gebruikt (of niet gebruikt) moeten worden.
- Geef een overzicht van de inhoud van de instructies.
Zie de sectie over introducties voor verdere discussie.
Algemene waarschuwingen, voorzorgsmaatregelen, gevarenmeldingen. Instructies moeten lezers vaak waarschuwen voor de mogelijkheid om hun apparatuur te ruïneren, de procedure te verpesten en zichzelf te verwonden. Ook moeten instructies vaak de nadruk leggen op belangrijke punten of uitzonderingen. Voor deze situaties gebruik je speciale mededelingen—notitie, waarschuwing, voorzichtigheid, en gevaarsmeldingen. Let op hoe deze speciale meldingen worden gebruikt in de bovenstaande voorbeeldinstructies.
Technische achtergrond of theorie. Aan het begin van bepaalde soorten instructies (natuurlijk na de inleiding) kan het nodig zijn om een discussie te hebben over de achtergrond die verband houdt met de procedure. Voor bepaalde instructies is deze achtergrond essentieel—anders maken de stappen in de procedure geen zin. Bijvoorbeeld, je hebt misschien enige ervaring gehad met die software-applicaties waarin je je eigen kleuren definieert door de schuifbalken voor rood, groen en blauw te verschuiven. Om echt te begrijpen wat je doet, heb je wat achtergrondinformatie over kleur nodig. Evenzo kun je je voorstellen dat, voor bepaalde instructies met camera's, ook wat theorie nodig zou kunnen zijn.
Uitrusting 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 uitrusting, de gereedschappen die je gebruikt in de procedure (zoals mengkommen, lepels, broodvormen, hamers, boren en zagen) en benodigdheden, de dingen die in de procedure worden verbruikt (zoals hout, verf, olie, meel en spijkers). In instructies worden deze meestal in een simpele verticale lijst of in een twee-kolomlijst weergegeven. Gebruik de twee-kolomlijst als je enkele specificaties aan sommige of alle items—moet toevoegen, bijvoorbeeld merknamen, maten, hoeveelheden, types, modelnummers, enzovoort.
Bespreking van de stappen. Wanneer je begint met het daadwerkelijke schrijven van de stappen, zijn er verschillende dingen om in gedachten te houden: (1) de structuur en indeling 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 set instructies voor als een verticale genummerde lijst. En de meeste zijn dat ook. Normaal gesproken formatteer je je eigen stapsgewijze instructies op deze manier. Er zijn echter enkele variaties, evenals andere overwegingen:
- Vaste volgorde stappen zijn stappen die in de gepresenteerde volgorde uitgevoerd moeten worden. Bijvoorbeeld, als u de olie in een auto vervangt, is het af laten lopen van de olie een stap die moet kom vóór het nieuwe olie erin te doen. Dit zijn genummerde lijsten (meestal verticale genummerde lijsten).
- Variabele-ordestappen zijn stappen die in praktisch elke volgorde kunnen worden uitgevoerd. Goede voorbeelden zijn die probleemoplossingsgidsen die je vertellen om dit te controleren, dat te controleren waar je iets probeert te fixen. Je kunt dit soort stappen in praktisch elke volgorde uitvoeren. Bij dit type is de opsomming met bullet points het juiste formaat.
- Alternatieve stappen zijn die waarbij twee of meer manieren om hetzelfde te bereiken worden gepresenteerd. Alternatieve stappen worden ook gebruikt wanneer verschillende voorwaarden kunnen bestaan. Gebruik opsommingstekens met dit type, met OF tussen de alternatieven, of de inleiding die aangeeft dat er alternatieven worden gepresenteerd.
- Nestor stappen. In sommige gevallen kunnen individuele stappen binnen een procedure vrij complex zijn en moeten ze worden opgedeeld in substappen. In dit geval maak je verder inspringen en nummer je de substappen als a, b, c, enzovoort.
- "Traploos" instructies. En ten slotte zijn er instructies die echt geen genummerde verticale lijsten kunnen gebruiken en die weinig tot geen duidelijke instructieve richtlijnen voor de lezer bieden. Sommige situaties moeten zo algemeen of zo variabel zijn dat stappen niet kunnen worden gesteld.
Zie het hoofdstuk over lijsten voor de stijl en opmaak van deze mogelijkheden.
Aanvullende discussie. Vaak is het niet genoeg om lezers alleen maar te vertellen dit of dat te doen. Ze hebben aanvullende uitleg nodig zoals hoe het eruit moet zien voor en na de stap; waarom ze om deze stap zouden moeten geven; welk mechanisch principe erachter zit wat ze doen; zelfs een nog gedetailleerdere uitleg van de stap—bespreking van de specifieke acties die de stap vormen.
Het probleem met aanvullende discussies is echter dat het de werkelijke stap kan verbergen. Je wilt dat de werkelijke stap—de specifieke acties die de lezer moet ondernemen—opvalt. Je wilt niet dat alles verzuipt in een hoop woorden. Er zijn minstens twee technieken om dit probleem te vermijden: je kunt de instructie van de aanvulling in aparte alinea's splitsen; of je kunt de instructie vetgedrukt maken.
Vetgedrukte daadwerkelijke gebruikersstappen in instructies. Vet gedrukte tekst helpt om de werkelijke actie van de aanvullende informatie te onderscheiden.
Vermijd telegraphisch schrijven—het weglaten van "begrepen" artikelen (de, een, een). Het is waar, robots schrijven zo, maar dat hoeven wij niet te doen.)
Schrijfstijl. De manier waarop je daadwerkelijk instructies schrijft, zin voor zin, lijkt misschien in tegenspraak met wat eerdere schrijfcursussen je hebben geleerd. Maar let op hoe "echte"instructies zijn geschreven—ze gebruiken veel imperatieven (opdrachten of directe aanspreekvormen); ze gebruiken veel "je." Dat is helemaal gepast. Je wilt in het gezicht van je lezer komen, haar of zijn volledige aandacht trekken. Om die reden klinken instructiestijlzinnen als deze: "Druk nu op de Pauze-knop op het voorpaneel om de weergave tijdelijk te stoppen" en "Je moet oppassen dat je niet ..."
Een bepaald probleem betreft het gebruik van de lijdende vorm in instructies. Om een vreemde reden klinken sommige instructies als volgt: "De pauzeknop moet ingedrukt worden om de weergave tijdelijk te stoppen." Niet alleen maken we ons zorgen om de mentale gezondheid van de pauzeknop, maar we vragen ons af wie dat ding zou moeten indrukken (bedoel je mij?). Of overweeg dit voorbeeld: "De timerknop wordt dan ingesteld op 3:00." Nogmaals, als de persoon die deze instructies volgt, kun je dit missen; je zou kunnen denken dat het simpelweg een verwijzing is naar een bestaande toestand, of je vraagt je af, "Spreken ze tegen mij?" Bijna even erg is het gebruik van de derde persoon: "De gebruiker moet dan op de pauzeknop drukken." Weer is het de oude dubbele blik: je kijkt om je heen en vraagt je af, "Ik?" (Voor meer details, zie passieve-woordvorm probleem.)
Een ander typisch probleem met schrijfstijl in instructies is dat mensen lijken te willen weglaten artikelen: "Druk op de pauzeknop op het frontpaneel om de weergave van informatie tijdelijk te stoppen" of "Aardewezen, 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 artikelen toevoegt (a, een, de) en andere dergelijke woorden die we normaal gesproken in instructies zouden gebruiken.
Grafieken in Instructies
Waarschijnlijk meer dan in elke andere vorm van schrijven (behalve misschien voor stripboeken), zijn graphics cruciaal voor instructies. Soms kunnen woorden eenvoudigweg de stap niet uitleggen. Illustraties zijn vaak essentieel voor de mogelijkheid van lezers om zich voor te stellen wat ze supposed te doen zijn.
In een technische schrijf cursus kunnen instructies vereisen dat je illustraties of andere soorten graphics moet opnemen—wat normaal gesproken in de instructies zou worden gebruikt. Het probleem kan natuurlijk zijn dat je geen toegang hebt tot graphics die geschikt zijn voor jouw specifieke instructies, en dat je je niet bijzonder zeker voelt over je artistieke vaardigheden. Er zijn manieren om deze problemen te overwinnen! Kijk naar de suggesties in graphics. In dat hoofdstuk vind je niet alleen suggesties voor het maken van graphics, maar ook eisen aan hun formaat.
Format in instructies
Kopjes. In uw instructies, maak goed gebruik van koppen. Normaal gesproken wilt u koppen voor elke achtergrondsectie die u mogelijk heeft, de sectie apparatuur en materialen, een algemene kop voor de daadwerkelijke instructiesectie, en subkoppen voor de individuele taken of fasen binnen die sectie. Kijk naar de voorbeelden aan het begin van dit hoofdstuk. Zie kopjes voor algemene vereisten.
Lijsten. Op dezelfde manier maken instructies meestal veelvuldig gebruik van lijsten, vooral genummerde verticale lijsten voor de feitelijke stapsgewijze uitleg. Eenvoudige verticale lijsten of twee-kolomlijsten zijn meestal goed voor de sectie over apparatuur en benodigdheden. In-zin lijsten zijn goed wanneer je een overzicht geeft van wat komen gaat. Zie lijsten voor algemene vereisten.
Speciale kennisgevingen. In instructies moet je lezers waarschuwen voor mogelijkheden waarin ze hun apparatuur kunnen beschadigen, voorraden kunnen verspillen, de gehele procedure kunnen laten mislukken, zichzelf of anderen — zelfs ernstig of fataal kunnen verwonden. Bedrijven zijn aangeklaagd wegens gebrek aan deze speciale meldingen, voor slecht geschreven speciale meldingen, of voor speciale meldingen die verkeerd geplaatst waren. Zie speciale mededelingen voor een volledige discussie over het juiste gebruik van deze speciale mededelingen, evenals hun indeling en plaatsing binnen de instructies.
Getallen, afkortingen en symbolen. Instructies bevatten ook veel cijfers, afkortingen en symbolen. Voor richtlijnen op deze gebieden.
Inspringen van mededelingen in instructies. In het eerste voorbeeld, let op hoe de kennisgeving is ingesprongen naar de tekst van de vorige stap. In het tweede voorbeeld, let op dat de ernstige opmerking aan het begin is geplaatst, voordat enige van de stappen.
AI-aanwijzingen voor instructies
Checklist, die doorgaans niet wordt gelezen, kan als bron voor AI prompts worden gebruikt met enige aanpassing. Kopieer het volgende, plak het in een AI-systeem zoals Google's Gemini en kijk wat je misschien hebt gemist.
Opmerking: Alle verwijzingen naar de inhoud, opmaak, stijl van instructies of hun componenten kunnen worden gevonden in de online technisch schrijfboek.
Wanneer je AI wilt gebruiken om een schrijfproject te evalueren, stel jezelf voor, vertel AI wie je bent en wat je wilt. Geef AI een referentiepunt voor evaluaties, zoals een online leerboek. Plaats vervolgens wat je wilt dat AI controleert in zijn evaluatie.
Pas de introductie aan om bij jouw identiteit te passen.
|
AI Prompts Instructies Hallo, AI. Ik vraag je om instructies te evalueren die zijn geschreven door een tweedejaars student aan een Amerikaanse hogeschool. Hieronder is een samenvatting van de hoofdstukken in het leerboek over instructies en opmerkingen om als basis voor uw beoordeling te gebruiken. (Identificerende informatie gemaskeerd):
|
Gerelateerde Informatie
Lezing quiz. Gebruik deze quiz om je begrip van dit hoofdstuk te testen.
Quizzen: grammatica, gebruik, interpunctie.
Hoe kan ik effectieve instructiehandleidingen maken
De verborgen kost van zo intuïtief dat het geen handleiding nodig heeft
D dragen Bedieningshandleidingen bij aan de bedrijfsprestaties?
Hoe schrijven we instructies. techscribe
Ik waardeer uw gedachten, reacties en kritiek op dit hoofdstuk: uw antwoord—David McMurrey.
