June 29, 2022
ABCS Technical Writing - 4 Features Technical Writers Need To Know

ABCS Technical Writing - 4 Features Technical Writers Need To Know

Het schrijven van een technisch rapport is voor veel technische professionals vaak een echte uitdaging. Onderzoek, onderzoek of ontwerp is waarom je doet wat je het liefste doet…maar dan moet je wel een rapport schrijven. Dit is waarschijnlijk de zwakke schakel. Maar er zijn enkele kenmerken van technisch schrijven die essentieel zijn, ongeacht uw branche of organisatie. Ik herinner het me graag als het ABC van technisch schrijven: nauwkeurigheid, beknoptheid, duidelijkheid en eenvoud.

    1. Nauwkeurigheid: een nauwkeurige rapportage van uw resultaten; Nauwkeurige weergave van feiten. Een nauwkeurige weergave van uw resultaten, volgens de methoden die u hebt gebruikt. Zorg ervoor dat u duidelijk aangeeft waar u uw mening hebt geuit, en niet een specifieke uitkomst van uw onderzoek. Geef zoveel mogelijk specifieke informatie in plaats van generalisaties.

 

    1. Beknoptheid: Probeer het document zo kort mogelijk te houden – tijdkritische lezers zullen het op prijs stellen. Overweeg om de achtergrond en ondersteunende informatie in een bijlageverwijzing, voetnoot of eindnoot te plaatsen. Houd de zinnen zoveel mogelijk kort (15-20 woorden werkt goed voor de meeste lezers), waarbij u slechts één idee per zin uitdrukt.

 

    1. Helderheid: Gebruik bekende woordenschat en combinaties (zorg ervoor dat je hebt nagedacht over wie je rapport zal lezen en wees voorbereid om mogelijk onbekende woorden uit te leggen, bijvoorbeeld als woordenlijst, voetnoot of eindnoot). Wees consistent met termen, afkortingen, presentatie van figuren, tabellen, illustraties, enz. Overweeg het gebruik van tabellen, figuren, grafieken en illustraties om uw punt te maken… zoals ze zeggen, een foto zegt meer dan duizend woorden. Onthoud dat jargon (gespecialiseerde termen die in uw vakgebied worden gebruikt) degenen die niet bekend zijn met deze woorden uitsluit. Gebruik precieze woorden: Lezers stellen het niet op prijs om te moeten beslissen of een woord in verschillende contexten een iets andere betekenis heeft. Een handige techniek is het gebruik van opsommingstekens of genummerde opsommingstekens om complexe ideeën uit te drukken (als uw systeem of organisatie dit toestaat).

 

  1. Eenvoud Het gaat erom uw ideeën met eenvoud uit te drukken, niet om uw werk te vereenvoudigen. Denk aan uw lezers: u wilt ze de waarde van uw werk laten zien, niet wat u een goede schrijver bent. Inhoud is belangrijker dan overmatig schrijven. Werkelijkheid belemmert het begrip van de lezer. Zorg dat je goed hebt nagedacht over het logische verloop van je melding. Plan de structuur van uw document zodat het uw lezers tot uw conclusie leidt. De eenvoud die inherent is aan het gebruik van gewoon Engels (actieve stem, redelijke zinslengte, oordeelkundig gebruik van gespecialiseerd jargon, geen breedsprakigheid) zal u goed van pas komen.

Meer informatie over ABCS voor technisch schrijven. Onthoud dat je schrijft zodat lezers zeggen: “Dat is uitstekend werk” en niet “Dat is goed schrijven, maar ik weet echt niet waar het allemaal over ging.”

Leave a Reply

Your email address will not be published.