Technical Writing Essentials

Descriptief technisch schrijven maakt gebruik van een combinatie van beelden en tekst om de lezer zowel te “tonen” als te “vertellen” over de informatie die wordt overgebracht. Net als meer creatieve beschrijvingen doen technische beschrijvingen soms een beroep op de “vijf zintuigen” en metaforische vergelijkingen (analogieën) om de lezer in staat te stellen zich een volledig beeld te vormen van wat er wordt beschreven. Vaker echter berusten zij op concrete, meetbare beschrijvingen. Technische beschrijvingen kunnen vele vormen aannemen, afhankelijk van het doel en het publiek. Beschrijvingen kunnen uiteenlopen van een korte zin tot een alinea, een heel deel van een verslag of een volledige handleiding. Slecht geschreven technische beschrijvingen kunnen verwarring veroorzaken, tijd verspillen, en zelfs tot een catastrofe leiden! Technische productbeschrijvingen zijn vaak wettelijk verplicht om de veiligheid en naleving te waarborgen. Aandacht voor details is van cruciaal belang.

Productspecificaties vereisen gedetailleerde beschrijvingen van ontwerpkenmerken; instructies vereisen vaak specifieke beschrijvende details om de lezer te “tonen” wat hij moet doen. Enkele algemene categorieën van technische beschrijvingen zijn de volgende:

• Mechanismebeschrijvingen: geven een gedetailleerd overzicht van de fysieke aspecten van een gereedschap, machine of ander mechanisch apparaat dat bewegende delen heeft en is ontworpen om een specifieke functie uit te voeren. Dit kunnen productbeschrijvingen zijn voor verkoop of fabricage, documentatie van ontwerpspecificaties, info-grafieken, enz. Dit hoofdstuk gaat in detail in op dit soort beschrijvingen.
• Procesbeschrijvingen: beschrijven een reeks gebeurtenissen (natuurlijke/biologische/ecologische, mechanische, sociale of psychologische verschijnselen) die in een bepaalde volgorde plaatsvinden om een specifiek resultaat te bereiken. Deze kunnen worden gecategoriseerd in niet-instructieve processen (zoals een procesanalyse van hoe een verbrandingsmotor werkt, of natuurlijke processen zoals fotosynthese) en instructieve processen (zoals aanbevolen/vereiste procedures en expliciete stap-voor-stap instructies die moeten worden gevolgd). (Zie paragraaf 7.7 voor gedetailleerde informatie over het schrijven van instructies).
• Definities: verduidelijken de specifieke betekenis, vaak in verband met een specifieke context, of drukken de essentiële aard uit van de termen die worden gedefinieerd. Deze kunnen in lengte variëren van een eenvoudige verduidelijkende zin tot een uitgebreid document van verscheidene bladzijden. Definities bevatten vaak gedetailleerde beschrijvingen en afbeeldingen om ideeën te illustreren. Klik op de link hieronder om een PowerPoint-presentatie van een student te bekijken over hoe je doeltreffende definities voor technische doeleinden schrijft. Deze presentatie is opgenomen met uitdrukkelijke toestemming van de student.

Definities in technisch schrijven – Voorbeeldpresentatie voor studenten (.pdf)

Mechanismebeschrijvingen moeten een duidelijk inzicht geven in het object dat wordt beschreven, met inbegrip van

• Algemeen voorkomen en fysische eigenschappen
• Algemene functie/doel
• Onderdelen
• Hoe de onderdelen samenwerken om een functionerend geheel te creëren.

De lezer moet zich een duidelijk beeld kunnen vormen, en dus begrijpen, van de aard van het beschreven object, wat het doet, en hoe het werkt.

Om deze duidelijkheid voor de lezer te bereiken, moet de schrijver significante details kiezen en de informatie logisch ordenen. Kies details die nauwkeurig en meetbaar kunnen worden beschreven, zoals

Afhankelijk van de behoefte van de lezer kan de beschrijving variëren van een algemeen overzicht waarvoor slechts een paar zinnen nodig zijn tot een handleiding met meerdere hoofdstukken waarin elk aspect van de onderdelen en functies van het mechanisme wordt beschreven om technische problemen op te lossen en reparaties uit te voeren. Voor een leuk voorbeeld van het laatste, zie de Star Trek: The Next Generation: Technical Manual (omslag afgebeeld in figuur 7.4.1), met gedetailleerde beschrijvingen van alle apparatuur en technologie die aan boord van de fictieve U.S.S. Enterprise-D wordt gebruikt.

Voordat je begint met het opstellen van je beschrijving, moet je nadenken over je doel en je publiek: Waarom heeft je publiek deze beschrijving nodig? Waarvoor zullen ze de beschrijving gebruiken? Beschrijft u verschillende soorten zonnepanelen voor de gemiddelde consument om hem te helpen het zonnepaneel te kiezen dat het beste bij zijn behoeften past? Geeft u schema’s aan technici en installateurs?

Als u uw doel en publiek duidelijk voor ogen hebt, stelt u een beschrijving op die de volgende elementen bevat:

1. Definitie: Wat is het, en wat is het belangrijkste doel?
2. Overzicht: Beschrijf het algemene uiterlijk van het mechanisme (“big picture”).
3. Componenten: Beschrijf de belangrijkste onderdelen in gelabelde secties; houd hier zorgvuldig rekening met de volgorde van de informatie. Leg een logisch verband tussen elk beschreven onderdeel.
4. Verklaring: hoe werken de onderdelen samen om de functie te vervullen? Welke belangrijke principes bepalen de werking? Bedenk hoeveel details hier nodig zijn voor uw beoogde publiek.
5. Visuals: neem afbeeldingen op die het mechanisme en/of de onderdelen ervan duidelijk illustreren. Laat het apparaat als geheel zien; overweeg om specifieke details te laten zien in vergrote weergaven, uitsneden, of diagrammen met labels. U kunt zelfs video’s insluiten of ernaar linken waarin het apparaat in actie wordt getoond.
6. Conclusie: afhankelijk van het doel kunt u de geschiedenis van het product, de beschikbaarheid, de fabricage, de kosten, waarschuwingen, enz. bespreken)
7. Referenties: Bronnen die u in uw beschrijving hebt gebruikt, of aanvullende informatiebronnen die beschikbaar zijn (indien relevant).

U kunt overwegen een sjabloon te gebruiken, zoals het sjabloon voor de technische beschrijving hieronder, waarbij u in gedachten moet houden dat sjablonen weliswaar nuttige gidsen kunnen zijn, maar dat ze niet veel flexibiliteit bieden en mogelijk niet voor alle situaties werken.

Voorbeeldbeschrijvingen

Bekijk de beschrijving van de “Up Goer Five” in figuur 7.4.2 (klik op afbeelding voor grotere versie). Wie zou het beoogde publiek kunnen zijn?

Vergelijk de beschrijving in figuur 7.4.2 met de informatie in figuur 7.4.2.4.2 met de informatie op de NASA-website over de Mars Curiosity Rover.

Noteer de verschillen in de gedetailleerdheid, de woordenschat en het algemene doel van de beschrijvingen. Als je de informatie op de NASA-site gebruikt om het sjabloon voor de technische beschrijving in te vullen, krijg je misschien iets als het volgende schema. Doelstellingen

Het kan zijn dat sommige van deze elementen niet nodig zijn; nogmaals, bedenk wat je doelgroep al weet. Zorg voor een evenwicht tussen het onnodig verklaren van het voor de hand liggende en het ten onrechte aannemen dat uw lezers kennis bezitten die zij niet bezitten.

Om de details van uw beschrijving en de samenstellende delen ervan te verfijnen, moet u het volgende in overweging nemen:

• Organisatie: Gebruik een logisch principe om uw beschrijving te ordenen
  • Top naar beneden (of fundering naar boven)
  • Links naar rechts (of rechts naar links)
  • Binnen naar buiten (of buiten naar binnen)
  • Belangrijkste naar minst belangrijke kenmerken
  • Centrale component naar randapparatuur
  • Materiële eigenschappen, enz.
• Taal: Gebruik specifieke, precieze, concrete termen – vermijd vage of al te algemene termen
  • Gebruik correcte terminologie – definieer termen zoals nodig voor uw publiek
  • Gebruik analogie om een onbekend ding te beschrijven in termen van een bekend ding
  • Gebruik objectieve taal – geen “ad speak” of subjectieve termen
  • Gebruik tegenwoordige tijd, actieve werkwoorden om te beschrijven hoe het apparaat eruit ziet en wat het doet
  • Gebruik woorden die levendige en specifieke beelden in het hoofd van de lezer oproepen.

Kies een alledaags voorwerp (zoals een van de voorwerpen in figuur 7.4.3) en stel een technische beschrijving op voor een publiek dat onbekend is met het voorwerp. Begin met het bedenken van een doelgroep en een doel, en probeer dan het sjabloon voor de technische beschrijving in te vullen met gedetailleerde informatie. Gebruik de informatie in uw sjabloon om een korte beschrijving van 1-2 alinea’s op te stellen, en voeg beeldmateriaal met de juiste ondertiteling toe.