Klik hier om te helpen David McMurrey betaal voor webhosting:
Doneer een klein bedrag dat je kunt!
Online technische schrijfvaardigheden blijven gratis.
De grootste hindernis waar je tegenaan kunt lopen bij het schrijven van een beschrijving is je te herinneren wat de term betekent zoals deze in deze context wordt gebruikt. We gebruiken allemaal het woord beschrijving losjes verwijzen naar praktisch iedere discussie of uitleg. Maar in deze context betekent het de gedetailleerde bespreking van de fysieke aspecten van een ding. Dat betekent het bespreken van zaken zoals kleur, vorm, grootte, gewicht, hoogte, breedte, dikte, textuur, dichtheid, inhoud, bouwmaterialen, enzovoort.
Bijvoorbeeld, deze zin is niet echt een beschrijving in onze zin van het woord:
Een computerflop is een apparaat dat wordt gebruikt voor het opslaan van elektronische gegevens.
Het legt de functie of het doel uit, maar biedt weinig of geen fysieke details. Deze zin is echter zeer zeker beschrijving:
De gewone computerschijf van de jaren 80 was 3,5 inch bij 3,5 inch en ongeveer 1/8 inch dik.
Zorg ervoor dat je de voorbeeld beschrijvingen beschikbaar met dit hoofdstuk.
NotebookLM-gegenereerde infographic van dit hoofdstuk
Contexten voor Beschrijving
Zoals eerder vermeld, zijn beschrijvingen een gemeenschappelijk element in technische documentatie—maar niet op dezelfde manier als instructies. Beschrijvingen komen vaker voor als een zin of twee hier, een alinea daar, of een hele sectie elders. Bepaalde soorten technische documentatie bevatten beschrijvingen:
- Ongevallenrapporten die veel beschrijving vereisen.
- Productspecificaties—documenten die het ontwerp en de kenmerken van een nieuw of veranderd product—omvatten veel beschrijving.
- Instructies vereisen vaak een beschrijving om lezers in staat te stellen te visualiseren wat ze doen en waarmee ze werken.
Inhoud en Organisatie van Beschrijvingen
Het volgende is een beoordeling van de secties die je vaak zult tegenkomen in beschrijvingen. Terwijl je leest, bekijk dan de voorbeeldbeschrijvingen.
Inleiding. Plan de inleiding van je beschrijving zorgvuldig. Zorg ervoor dat het al het volgende doet (maar niet noodzakelijk in deze volgorde) dat van toepassing is op jouw specifieke beschrijving:
- Geef het specifieke object aan dat gaat worden beschreven.
- Geef aan welke kennis en achtergrond het publiek nodig heeft om de beschrijving te begrijpen.
- Geef een algemene beschrijving van het object.
- Voeg een overzicht toe van de inhoud van de beschrijving.
Achtergrond. Als het ding dat je beschrijft waarschijnlijk niet vertrouwd is voor de meeste van je lezers, overweeg dan om wat achtergrondinformatie toe te voegen voordat je daadwerkelijk in de beschrijving duikt. Als je van plan bent om een SGO/3 dichtheidsmeter aan niet-specialisten te beschrijven, kun je beter eerst bespreken wat dat ding in hemelsnaam is, wat het doet en op welk deel van de planeet het wordt gebruikt.
Discussie van de onderdelen of kenmerken. Het belangrijkste onderdeel van je beschrijving is de bespreking van elk onderdeel of kenmerk. Je moet het ding dat je beschrijft opdelen in onderdelen, of kenmerken, of beide. Onderdelen zijn makkelijk: bijvoorbeeld, een houten potlood heeft een vulling, een houten vat, een gum en een metalen clip. Kenmerken zijn beschrijfbare aspecten van een ding, maar zijn geen onderdelen: bijvoorbeeld, de potlood heeft een bepaald gewicht, lengte, breedte, enzovoort. Als je een opkomende vastgoedmagnaat was en je moest een leeg perceel beschrijven voor bedrijfsbestanden, zou je het waarschijnlijk beschrijven aan de hand van zijn kenmerken: zijn locatie, oppervlakte, terrein, vegetatie, toegang tot nutsvoorzieningen, enzovoort. (Bekijk de beschrijving van de primitieve stenen schraper in de voorbeelden; een deel is geordend op kenmerken en een deel op onderdelen!)
Zodra je het ding dat je beschrijft in delen, kenmerken of beide hebt verdeeld, is je volgende taak om elk deel te beschrijven. Voor mechanische dingen werkt het goed om te beginnen met het definiëren van het onderdeel, door de functie ervan uit te leggen. Daarna beschrijf je het onderdeel van algemeen naar specifiek, met gebruik van elke geschikte bron van beschrijving.
Merk op dat je in de beschrijving verschillende soorten schrijven kunt mixen. Je zult jezelf functies uitleggen, termen definiëren en een beetje over processen discussiëren terwijl je beschrijft. Dat is geen probleem zolang de primaire focus en de meerderheid van de inhoud echt beschrijving zijn.
Bespreking van de gerelateerde operatie of procedure. Op een bepaald moment in een beschrijving, vaak aan het einde, is het nuttig om de werking of het proces dat verband houdt met het object dat je beschrijft samen te vatten. Als je bijvoorbeeld net een mechanisch potlood hebt beschreven, kun je kort uitleggen hoe het wordt gebruikt. Als je net een sneeuwvlok hebt beschreven, kun je het proces bespreken waardoor het is gevormd.
Bronnen van Beschrijving
Wanneer je een beschrijving schrijft, moet je nadenken over de soorten beschrijvend detail die je kunt bieden. Soms zijn beschrijvingen op dit gebied vrij zwak. Gebruik de volgende lijst om je beschrijving te plannen of om een beschrijving die je hebt geschreven te herzien. Denk na over de categorieën van beschrijvend detail die je zou kunnen bieden, of gebruik de volgende lijst om categorieën te identificeren die je niet hebt gebruikt:
|
kleur hoogte breedte vorm gewicht materialen textuur locatie methoden van bevestiging geur |
diepte aantal patroon, ontwerp ingrediënten leefheid subonderdelen lengte afmaken temperatuur vochtgehalte |
Schematische weergave van
beschrijvingen. Houd er rekening mee dat dit slechts een typisch of veelvoorkomend model is voor de inhoud en organisatie; veel anderen zijn mogelijk.
Diverse Zorgen
In beschrijvingen zul je waarschijnlijk puzzelen over hoe je omgaat met nummers, afkortingen en symbolen:
Nummers. Vergeet niet dat technische schrijfstijl enkele van die regels breekt die je zo hard hebt geleerd in eerdere schrijfklassen. In de context van technische schrijfvaardigheden zijn we vaak sterk bezorgd over cijfers en willen we dat ze opvallen. Dit betekent dat je cijfers moet gebruiken in doorlopende tekst wanneer het nummer een exact, gemeten of meetbaar bedrag aangeeft, of wanneer het een kritische waarde vertegenwoordigt. Bijvoorbeeld, in deze zinnen lijkt het belangrijk dat de cijfers exact zijn:
De beker heeft een diameter van 3 inch.
Gebruik 4 punaises om de poster aan de muur te bevestigen.
Echter, dit betekent niet dat er cijfers gebruikt moeten worden voor onverschillige waarden. Bijvoorbeeld, in deze zin is er niets hartverscheurend aan het aantal secties dat het rapport heeft:
Het rapport bevat vier belangrijke secties.
Zie de sectie over cijfers vs. woorden voor verdere details.
Anatomie van een beschrijvende alinea. Typisch begint het met een verklaring over het doel of de functie van het onderdeel, met daarachter de beschrijvende details. Beschrijvende details putten uit de "bronnen" van beschrijving— zoals dingen als kleur, vorm, breedte en hoogte.
Afkortingen. In technische schrijfvaardigheid verwachten we abbreviaties. Gebruik ze vrijelijk in je beschrijving. Onthoud de regel over het punten van abbreviaties: punctueer ze alleen als ze een woord vormen (bijvoorbeeld, in.). Vergeet ook niet dat abbreviaties doen niet tegen het nummer dat ze gebruikt worden (bijvoorbeeld, maak dat "8 mm tape" of "8-mm tape" maar niet "8mm tape").
Symbolen. Het meest voorkomende probleem met symbolen in instructies en beschrijvingen heeft te maken met inches en voeten. Als je instructies schrijft voor het droomproject van een timmerman waar overal voeten en inches zijn, gebruik dan de symbolen " (inches) en ' (voeten). Als je echter inch- en voetmetingen maar een paar keer vermeldt, gebruik dan het woord of de afkorting in plaats daarvan.
Grafieken en Formaat in Beschrijvingen
In de meeste beschrijvingen heb je ten minste één illustratie nodig van het ding dat je beschrijft, met labels die naar de onderdelen wijzen. Zie de sectie over grafieken voor meer informatie over het maken van graphics, het opmaken ervan en het integreren in je beschrijvingen.
Koppen. In beschrijvingen wil je koppen en subkoppen gebruiken om de discussie over de afzonderlijke onderdelen of kenmerken aan te geven. Onthoud dat je idealiter elk onderdeel in een aparte alinea of sectie wilt beschrijven—en die discussie wilt markeren met een kop. Als je een achtergrondsectie hebt, gebruik daar ook een kop voor. Zie de sectie over koppen voor de specifieke vereisten.
Lijsten. Lijsten zijn in beschrijvingen lang niet zo belangrijk als in instructies. Als je echter onderdelen of subonderdelen opsomt of specificaties opsomt, zijn dit goede situaties voor lijsten. Zie de sectie over lijsten voor de specifieke vereisten.
Bijzondere aankondigingen. In beschrijvingen is er niets zoals de belangrijke rol voor speciale mededelingen zoals die in instructies voorkomt. Tenslotte, als het echt een beschrijving is, zouden lezers geen procedures moeten proberen te volgen, en zouden ze daarom geen risico's moeten lopen op het beschadigen van apparatuur, het verspillen van voorraden, het verpesten van de procedure, of het verwonden van zichzelf of anderen. Echter, je kunt de opmerking speciale mededeling om nuttig te zijn om belangrijke punten of uitzonderingen te benadrukken. Zie de sectie over speciale mededelingen voor een volledige bespreking van het juiste gebruik van deze speciale mededelingen, evenals hun indeling en plaatsing binnen de instructies.
Gerelateerde Informatie
Lezen quiz. Gebruik deze quiz om je begrip van dit hoofdstuk te testen.
Training beschikbaar. Krijg wat oefening in het schrijven met McMurrey als uw instructeur.
Ik waardeer uw gedachten, reacties, en kritiek over dit hoofdstuk: verantwoordelijkheid—David McMurrey
