Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De...

46
Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA

Transcript of Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De...

Page 1: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Praktische richtlijnen voor het schrijven van een technisch-wetenschappelijk verslag

J. De Schutter, K.U.Leuven/PMA

Page 2: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Vooraf ...

Wat is het belang van schriftelijk en mondeling rapporteren voor een ingenieur, en waarom ?

Wat is het belangrijkste basisprincipe voor een goede rapportering ?

Page 3: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Overzicht

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

Page 4: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Inleiding

Doelstelling– Verbeteren van kwaliteit van verslagen

Projectverslagen 1e+2e+3e ir. Ontwerp 2e ir. Eindwerk 3e ir. Technisch rapport Publicatie (artikel ...)

Page 5: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Algemeenheden (1)

Rapporteren is essentieel onderdeel van technisch-wetenschappelijke activiteit (... 15 % ...)

Hoofdprincipe: Maak het de lezer zo gemakkelijk mogelijk !! Lezer “leiden” Klare boodschap Bondigheid

Page 6: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Algemeenheden (2)

En verder:– Verslag is “visitekaartje”– Rapporteren vraagt bijzondere inspanning– Neerschrijven brengt inzicht bij

Page 7: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (1) Titel

– Doel: lezer precies idee geven van inhoud zo goed mogelijk lading dekken:

zo specifiek mogelijk elk woord afwegen

wordt op allerlaatste moment vastgelegd !– Voorbeeld:

NIET: “Luchtbellendetector” WEL: “Ontwerp van een ultrasone luchtbellendetector

voor bloedlijnen”

Page 8: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (2)

Samenvatting– Doel:

eigen bijdrage duidelijk aangeven lezer idee geven of verslag interessant is voor hem

Enkel besluiten opsommen, geen uitleg Wordt als laatste geschreven !

Page 9: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (3)

Inhoudstafel– Doel:

springen naar bepaald onderdeel geeft opbouw van tekst aan

opbouw moet logisch en transparant zijn !

Page 10: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (4)

Inleiding– Probleem situeren– Verband met literatuur/vorig werk (

referenties !)– Korte beschrijving activiteiten/gevolgde

werkwijze– Opsomming voornaamste besluiten– Opbouw verslag (verwijzing naar onderdelen !)

Page 11: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (5)

Hoofdstukken/Paragrafen– Logische/transparante indeling + volgorde– Evenwichtige indeling qua lengte– Beperkt aantal onderverdelingen

drie voor thesis: bv. 3.5.1 twee voor publicatie of kort verslag: bv. 3.5

– Meestal volgorde: theorie/experimentele opstelling/resultaten + interpretatie

Page 12: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (6)

Hoofdstukken/Paragrafen (vervolg)– Inhoud van hoofdstukken van thesis:

Inleiding:– Korte beschrijving activiteit + werkwijze– Besluiten van hoofdstuk– Opbouw van hoofdstuk

Paragrafen Besluit

Page 13: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (7)

(Algemeen) Besluit– Herneemt voornaamste besluiten– Suggesties voor verder onderzoek/studie– NIET: Problemen situeren, uitleggen, motiveren,

enz. Referenties: volledig + systematisch !!

– chronologisch– volgorde van voorkomen– alfabetisch

Page 14: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua inhoud (8)

Appendices– Niet-essentiële details die leesbaarheid schaden

Lange bewijsvoeringen Lange berekeningen Uitgebreide experimentele resultaten Afwijkingen van de hoofdlijn

Page 15: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (1)

Regel 1: Behandel alle noodzakelijke onderwerpen– Voorbeeld: cyclus van verbrandingsmotor

Page 16: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

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

Page 17: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (3)

Regel 2: Laat niet-noodzakelijke (irrelevante) onderwerpen weg– Voorbeeld: cyclus van verbrandingsmotor:

geen beschrijving van carburator– Hoe sluipen irrelevante dingen in rapport ?

We werken hard op iets dat ons interesseert ... Een onderwerp is zo verwant aan ons onderwerp ... Na verder onderzoek blijkt origineel onderwerp wat

te breed gekozen en we willen ons beperken.

Page 18: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (4)

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

Page 19: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (5)

Regel 4: Rangschik elke groep deelonderwerpen op een goede manier– Vermijd kruisverdeling: eenduidig criterium !– Voorbeeld:

A. Machines– 1. Pompen

• a. Hoofdpompen• b. Secundaire pompen• c. Tertiaire pompen• d. Centrifugaalpompen• ...

Page 20: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (6)

– Vermijd kruisverdeling: eenduidig criterium !– Voorbeeld:

I. Schoenen– 1. Leder– 2. Hout– 3. Textiel– 4. Karton– 5. Veiligheidsschoenen– 6. Gezondheidsschoenen– 7. Kinderschoenen

Page 21: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (7)

Regel 5: Gebruik zoveel mogelijk parallelle behandeling en parallelle verwoording– Voorbeeld:

NIET:– I. Hoe warmte wordt opgewekt– II. Meting van warmte– III. Warmteoverdracht

Page 22: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Hoe gedachten ordenen ? (8)

WEL:– I. Opwekking van warmte– II. Meting van warmte– III. Overdracht van warmte

– I. Warmteopwekking– II. Warmtemeting – III. Warmteoverdracht

Page 23: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

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 ?

Page 24: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

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 een 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 ?

Page 25: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (1)

Algemeen– Bondigheid

Schrap alle nietszeggende woorden/paragrafen/ ... Vermijd herhalingen

– Lezer leiden Gebruik inleidende zinnen en verwijs nadien Definieer alle begrippen !! Laat lezer nooit met vragen zitten Stel nieuwsgierigheid niet op de proef

Page 26: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (2)

Alinea– ‘Topic sentence’: zin waarrond andere zinnen

opgebouwd zijn– Methode om paragraaf te ontwikkelen ?

van algemeen naar detail van fysische oorzaak naar gevolg rangschikking volgens ruimte of tijd met behulp van een analogie met behulp van een voorbeeld

Page 27: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (3)

door vergelijking of tegenstelling door verduidelijking van een definitie van eenvoudig naar complex door bewijs (inductie of deductie) volgens orde van belangrijkheid

Page 28: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (4)

Zinsconstructie– Korte, eenvoudige zinnen– Eén nieuwe gedachte per zin– Maak voornaamste element onderwerp en

plaats het vooraan– Vermijd gebruik van wij/ik/men

NIET: “In dit hoofdstuk beschrijven wij hoe wij het 2D-systeem hebben uitgebreid naar een 3D-systeem”

Page 29: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (5)

Zinsconstructie (vervolg)– Geef duidelijk verband met vorige zin

verwijswoorden– voegwoorden– voorzetsels– aanwijzende voornaamwoorden

leestekens (tussen delen van samengestelde zin)

– Gebruik parallelle verwoording voor parallelle constructies

Page 30: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (6)

Werkwoorden– Actief: kies actieve vorm i.p.v. passieve vorm

NIET: “In dit hoofdstuk wordt beschreven hoe het 2D-systeem wordt uitgebreid naar een 3D-systeem.”

WEL: “Dit hoofdstuk beschrijft de uitbreiding van het 2D-systeem naar een 3D-systeem.”

NIET: “Volgende resultaten worden bekomen in deze proef: ...”

WEL: “Deze proef levert volgende resultaten: ...”

Page 31: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (7)

Werkwoorden (vervolg)– Actief: vervang zelfstandig naamwoord door

werkwoord NIET: Titel:

– “Hoogdynamische regeling van ... voor ... in ...”

WEL: Titel: – “Hoogdynamische regelen van ... voor ... in ...”

– Eenvoud: alles zoveel mogelijk O.T.T.– Direct: vermijd werkwoorden als

kunnen/mogen/zouden

Page 32: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (8)

Woordkeuze– Zo specifiek mogelijk

NIET: “een opnemer” WEL: “een rekstrookje” NIET: “kan bekomen worden” WEL: “kan gemeten worden” of:

“kan berekend worden”

– Geen poëtische beschrijving Gebruik steeds zelfde woord voor zelfde begrip Kies meest eenvoudige uitdrukking

Page 33: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (9)

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 = ax2 + bx + c ,

waarbij a, b en c bepaald worden in (3.23).”

Page 34: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (10)

Figuren en tabellen– Voldoende groot en leesbaar– Assen benoemen + eenheden + schalen– Meest sprekende resultaten laten zien– Refereren in tekst– Figuur voorzien van verklarend onderschrift

Page 35: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Richtlijnen qua vorm (11)

Appendices– Voorzie nodige uitleg !

Page 36: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (1a)

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 self-consistent 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)

Page 37: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (1b)

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)

Page 38: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (2a+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)

De stuurgeometrie, de ophanging (vering en demping) en de belading bepalen het weggedrag van de wagen. Zij worden gegeven verondersteld. (20 woorden)

Page 39: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (3a)

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

Page 40: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (3b)

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)

Page 41: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (4a+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)

A calibration procedure determines the systematic errors of the CMM. These are then used for on-line error correction. (18 woorden)

Page 42: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (5a)

– Als er een goede instelling voor de PID-regelaar 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)

Page 43: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Voorbeelden (5b)

– 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)

Page 44: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

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

Structurering van inhoud Vorm

– Project-/ontwerp-/eindwerkverslagen zijn goede oefening !

Page 45: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Epiloog: tips voor mondelinge presentatie (1) Idem als verslag: toehoorder leiden, klare

boodschap, bondigheid Transparant:

– letters groot genoeg– niet teveel informatie op één transparant– overzicht presentatie + besluit– gebruik aanwijsstok/laser pointer– geen ‘strip-tease’

Page 46: Praktische richtlijnen voor het schrijven van een technisch- wetenschappelijk verslag J. De Schutter, K.U.Leuven/PMA.

Epiloog: tips voor mondelinge presentatie (2) Spreektechniek:

– luid genoeg– aangezicht naar publiek– geen stopwoorden– eerbiedig tijdslimiet– goed voorbereiden + oefenen !