Praktische richtlijnen voor het schrijven van een technischwetenschappelijk

Praktische richtlijnen voor het schrijven van een technischwetenschappelijk verslag J. De Schutter, K. U. Leuven/PMA

Vooraf. . . n Wat is het belang van schriftelijk en mondeling rapporteren voor een ingenieur, en waarom ? n Wat is het belangrijkste basisprincipe voor een goede rapportering ?

Overzicht Inleiding n Algemeenheden n Richtlijnen qua inhoud n Hoe gedachten ordenen ? n Richtlijnen qua vorm n Voorbeelden n Besluit n Epiloog: tips voor mondelinge presentatie n

Inleiding n Doelstelling – Verbeteren van kwaliteit van verslagen n Projectverslagen n Ontwerp 1 e+2 e+3 e ir. 2 e ir. n Eindwerk 3 e ir. n Technisch rapport n Publicatie (artikel. . . )

Algemeenheden (1) Rapporteren is essentieel onderdeel van technisch-wetenschappelijke activiteit 15 %. . . ) n Hoofdprincipe: Maak het de lezer zo gemakkelijk mogelijk !! n – – – Lezer “leiden” Klare boodschap Bondigheid (. . .

Algemeenheden (2) n En verder: – – – Verslag is “visitekaartje” Rapporteren vraagt bijzondere inspanning Neerschrijven brengt inzicht bij

Richtlijnen qua inhoud (1) n Titel – – Doel: lezer precies idee geven van inhoud zo goed mogelijk lading dekken: n zo specifiek mogelijk n elk woord afwegen – – wordt op allerlaatste moment vastgelegd ! Voorbeeld: n NIET: “Luchtbellendetector” n WEL: “Ontwerp van een ultrasone luchtbellendetector voor bloedlijnen”

Richtlijnen qua inhoud (2) n Samenvatting – Doel: n eigen bijdrage duidelijk aangeven n lezer idee geven of verslag interessant is voor hem – – Enkel besluiten opsommen, geen uitleg Wordt als laatste geschreven !

Richtlijnen qua inhoud (3) n Inhoudstafel – Doel: n springen naar bepaald onderdeel n geeft opbouw van tekst aan – opbouw moet logisch en transparant zijn !

Richtlijnen qua inhoud (4) n Inleiding – – – Probleem situeren Verband met literatuur/vorig werk ( referenties !) Korte beschrijving activiteiten/gevolgde werkwijze Opsomming voornaamste besluiten Opbouw verslag (verwijzing naar onderdelen !)

Richtlijnen qua inhoud (5) n Hoofdstukken/Paragrafen – – – Logische/transparante indeling + volgorde Evenwichtige indeling qua lengte Beperkt aantal onderverdelingen n drie voor thesis: bv. 3. 5. 1 n twee voor publicatie of kort verslag: bv. 3. 5 – Meestal volgorde: theorie/experimentele opstelling/resultaten + interpretatie

Richtlijnen qua inhoud (6) n Hoofdstukken/Paragrafen (vervolg) – Inhoud van hoofdstukken van thesis: n Inleiding: – – – Korte beschrijving activiteit + werkwijze Besluiten van hoofdstuk Opbouw van hoofdstuk n Paragrafen n Besluit

Richtlijnen qua inhoud (7) n (Algemeen) Besluit – – – n Herneemt voornaamste besluiten Suggesties voor verder onderzoek/studie NIET: Problemen situeren, uitleggen, motiveren, enz. Referenties: volledig + systematisch !! – – – chronologisch volgorde van voorkomen alfabetisch

Richtlijnen qua inhoud (8) n Appendices – Niet-essentiële details die leesbaarheid schaden n Lange bewijsvoeringen n Lange berekeningen n Uitgebreide experimentele resultaten n Afwijkingen van de hoofdlijn

Hoe gedachten ordenen ? (1) n Regel 1: Behandel alle noodzakelijke onderwerpen – Voorbeeld: cyclus van verbrandingsmotor

Hoe gedachten ordenen ? (2) – – – A. Inlaatslag • 1. Volumetoename • 2. Drukafname • 3. Instroming van gasmengsel • 4. Sluiten van inlaatklep B. Samendrukkingsslag • 1. Volumeafname • 2. Temperatuurtoename C. Vermogenslag • 1. Volumetoename • 2. Drukverloop • 3. Openen van uitlaatklep • 4. Uitstroming van verbrandingsgassen

Hoe gedachten ordenen ? (3) n Regel 2: Laat niet-noodzakelijke (irrelevante) onderwerpen weg – – Voorbeeld: cyclus van verbrandingsmotor: geen beschrijving van carburator Hoe sluipen irrelevante dingen in rapport ? n We werken hard op iets dat ons interesseert. . . n Een onderwerp is zo verwant aan ons onderwerp. . . n Na verder onderzoek blijkt origineel onderwerp wat te breed gekozen en we willen ons beperken.

Hoe gedachten ordenen ? (4) n Regel 3: Met een top-down werkwijze: verdeel elk onderwerp in al zijn deelonderwerpen – – Elk deelonderwerp kan maar behoren tot één enkel onderwerp van een hoger niveau (‘vader’) Elk deelonderwerp moet op zelfde niveau staan met minstens één ander onderwerp

Hoe gedachten ordenen ? (5) n Regel 4: Rangschik elke groep deelonderwerpen op een goede manier – – Vermijd kruisverdeling: eenduidig criterium ! Voorbeeld: n A. – Machines 1. Pompen • a. Hoofdpompen • b. Secundaire pompen • c. Tertiaire pompen • d. Centrifugaalpompen • . . .

Hoe gedachten ordenen ? (6) – – Vermijd kruisverdeling: eenduidig criterium ! Voorbeeld: n I. Schoenen – – – – 1. Leder 2. Hout 3. Textiel 4. Karton 5. Veiligheidsschoenen 6. Gezondheidsschoenen 7. Kinderschoenen

Hoe gedachten ordenen ? (7) n Regel 5: Gebruik zoveel mogelijk parallelle behandeling en parallelle verwoording – Voorbeeld: n NIET: – – – I. Hoe warmte wordt opgewekt II. Meting van warmte III. Warmteoverdracht

Hoe gedachten ordenen ? (8) n WEL: – – – I. Opwekking van warmte II. Meting van warmte III. Overdracht van warmte I. Warmteopwekking II. Warmtemeting III. Warmteoverdracht

Hoe gedachten ordenen ? (9) – Vragenlijst – – – – Drukt de gehele inhoudstafel een welbepaalde doelstelling uit ? Geeft de inhoudstafel het essentiële van het onderwerp weer ? Omvat de inhoudstafel het gehele onderwerp ? Is de inhoudstafel klaar en duidelijk ? Zijn de gekozen hoofdingen zinvol ? Is elk onderwerp voldoende ontwikkeld in deelonderwerpen ? Zijn de gekozen hoofdingen de meest geschikte (voor uw doel) ? Zijn alle overbodige onderwerpen weggelaten ?

Hoe gedachten ordenen ? (10) – – – – Geven de groepen hoofdingen relatief aan hoe lang elk van de delen van het afgewerkte rapport zullen zijn ? Drukt de inhoudstafel een gevoel van eenheid uit, eerder dan eenvoudige verzameling van hoofdingen ? Heeft elk hoofding, indien ze wordt onderverdeeld, minstens twee deelhoofdingen ? Zijn er minder dan zes deelhoofdingen ? (Zoniet: ga na of alle deelhoofdingen wel op zelfde niveau staan) Staat elke deelhoofding onder de juiste hoofding ? Is elke groep deelhoofdingen vrij van kruisverdeling ? Wordt er, indien dit raadzaam is, gebruik gemaakt van parallelle behandeling en parallelle verwoording ?

Richtlijnen qua vorm (1) n Algemeen – Bondigheid n Schrap alle nietszeggende woorden/paragrafen/. . . n Vermijd herhalingen – Lezer leiden n Gebruik inleidende zinnen en verwijs nadien n Definieer alle begrippen !! n Laat lezer nooit met vragen zitten n Stel nieuwsgierigheid niet op de proef

Richtlijnen qua vorm (2) n Alinea – – ‘Topic sentence’: zin waarrond andere zinnen opgebouwd zijn Methode om paragraaf te ontwikkelen ? n van algemeen naar detail n van fysische oorzaak naar gevolg n rangschikking volgens ruimte of tijd n met behulp van een analogie n met behulp van een voorbeeld

Richtlijnen qua vorm (3) n door vergelijking of tegenstelling n door verduidelijking van een definitie n van eenvoudig naar complex n door bewijs (inductie of deductie) n volgens orde van belangrijkheid

Richtlijnen qua vorm (4) n Zinsconstructie – – Korte, eenvoudige zinnen Eén nieuwe gedachte per zin Maak voornaamste element onderwerp en plaats het vooraan Vermijd gebruik van wij/ik/men n NIET: “In dit hoofdstuk beschrijven wij hoe wij het 2 D-systeem hebben uitgebreid naar een 3 Dsysteem”

Richtlijnen qua vorm (5) n Zinsconstructie (vervolg) – Geef duidelijk verband met vorige zin n verwijswoorden – – – voegwoorden voorzetsels aanwijzende voornaamwoorden n leestekens – (tussen delen van samengestelde zin) Gebruik parallelle verwoording voor parallelle constructies

Richtlijnen qua vorm (6) n Werkwoorden – Actief: kies actieve vorm i. p. v. passieve vorm n NIET: “In dit hoofdstuk wordt beschreven hoe het 2 D-systeem wordt uitgebreid naar een 3 D-systeem. ” n WEL: “Dit hoofdstuk beschrijft de uitbreiding van het 2 D-systeem naar een 3 D-systeem. ” n NIET: “Volgende resultaten worden bekomen in deze proef: . . . ” n WEL: “Deze proef levert volgende resultaten: . . . ”

Richtlijnen qua vorm (7) n Werkwoorden (vervolg) – Actief: vervang zelfstandig naamwoord door werkwoord n NIET: – “Hoogdynamische regeling van. . . voor. . . in. . . ” n WEL: – – – Titel: “Hoogdynamische regelen van. . . voor. . . in. . . ” Eenvoud: alles zoveel mogelijk O. T. T. Direct: vermijd werkwoorden als kunnen/mogen/zouden

Richtlijnen qua vorm (8) n Woordkeuze – Zo specifiek mogelijk n NIET: “een opnemer” n WEL: “een rekstrookje” n NIET: “kan bekomen worden” n WEL: “kan gemeten worden” of: “kan berekend worden” – Geen poëtische beschrijving n Gebruik steeds zelfde woord voor zelfde begrip n Kies meest eenvoudige uitdrukking

Richtlijnen qua vorm (9) n Formules en symbolen – – – Gebruik standaardsymbolen en -notaties Geen dubbel gebruik van symbolen Symbolen ter plaatse definiëren Zeer korte formules inwerken in tekst Langere formules op aparte lijn Gebruik leestekens, voorbeeld: “Dit geeft als resultaat y = ax 2 + bx + c , waarbij a, b en c bepaald worden in (3. 23). ”

Richtlijnen qua vorm (10) n Figuren en tabellen – – – Voldoende groot en leesbaar Assen benoemen + eenheden + schalen Meest sprekende resultaten laten zien Refereren in tekst Figuur voorzien van verklarend onderschrift

Richtlijnen qua vorm (11) n Appendices – Voorzie nodige uitleg !

Voorbeelden (1 a) n Both methods are applicable to systems that can be considered single degree of freedom and few restrictions are imposed upon the type of nonlinearity. The methods are selfconsistent in the sense that no apriori knowledge about the nonlinear system characteristics is required and no initial estimates or approximative functions have to be provided. (54 woorden)

Voorbeelden (1 b) n Both methods apply only to single degree of freedom systems, however with few restrictions imposed upon the type of nonlinearity. They require no prior knowledge about the type of nonlinearity: no initial estimates or approximate functions are needed. (38 woorden)

Voorbeelden (2 a+b) De wagen met zijn weggedrag dat bepaald is door de stuurgeometrie en de ophanging, afvering, demping en belading, is wat ze is. (22 woorden) n De stuurgeometrie, de ophanging (vering en demping) en de belading bepalen het weggedrag van de wagen. Zij worden gegeven verondersteld. (20 woorden) n

Voorbeelden (3 a) n Indien niet de ideale overbrengverhouding No, maar een andere overbrengverhouding N, gekozen wordt voor de gegeven inerties en de andere gegevens, dan definieert men energiefaktor rho die de verhouding is van de energiedissipatie bij de gekozen overbrengverhouding N tot de ideale overbrengverhouding No. (44 woorden)

Voorbeelden (3 b) n De energiefactor wordt gedefinieerd als de verhouding van de gedissipeerde energie bij de gekozen overbrengingsverhouding N tot de gedissipeerde energie bij de ideale overbrengingsverhouding No. (26 woorden)

Voorbeelden (4 a+b) A self-calibration procedure will deduce the systematic errors of the CMM’s and this information can be used in an on-line error correction of single measurements by the CMM. (28 woorden) n A calibration procedure determines the systematic errors of the CMM. These are then used for on-line error correction. (18 woorden) n

Voorbeelden (5 a) – Als er een goede instelling voor de PIDregelaar zou bestaan, dan kunnen we ons voorstellen dat bij uitval van de koppelsensor er wordt overgegaan op een algoritme dat het gemeten koppel aan het stuur vervangt door het berekende T_in_experimenteel. We hebben dan dus een regeling zonder koppelsensor die toch koppelgevoelig is. Evenwel is het adaptatievermogen van de nieuwe regeling zero geworden. (62 woorden)

Voorbeelden (5 b) – Bij uitval van de koppelsensor kan het koppel Tin, experimenteel, berekend door een goed ingestelde PID-regelaar, het gemeten koppel aan het stuur vervangen. Zo ontstaat een regeling zonder koppelsensor, die toch koppelgevoelig is. Deze regeling is echter niet adaptief. (38 woorden)

Besluit – – Rapporteren is belangrijk, maakt deel uit van opdracht Rapporteren vraagt bijzondere inspanning en kritische ingesteldheid Basisprincipe: maak het de lezer gemakkelijk Praktische richtlijnen voor n Structurering van inhoud n Vorm – Project-/ontwerp-/eindwerkverslagen zijn goede oefening !

Epiloog: tips voor mondelinge presentatie (1) Idem als verslag: toehoorder leiden, klare boodschap, bondigheid n Transparant: n – – – letters groot genoeg niet teveel informatie op één transparant overzicht presentatie + besluit gebruik aanwijsstok/laser pointer geen ‘strip-tease’

Epiloog: tips voor mondelinge presentatie (2) n Spreektechniek: – – – luid genoeg aangezicht naar publiek geen stopwoorden eerbiedig tijdslimiet goed voorbereiden + oefenen !