2nd year Practicum

How do I write a good report?

It is an important part of scientific research to be able to write a good report - this can be to report on a small project you have done in a course, the writing up of a summary for your supervisor, writing a scientific paper, a grant application, or to write a telescope proposal.

 

The aim of a report to present to the reader what you have done with the aim of convincing her that the results you have obtained are trustworthy. This means that you must be precise, honest and clear. To ensure that the reader keeps interested and pays attention to what you write you should as much as possible write it in an engaging way in good English/Dutch. It is important to keep in mind that the report should not be a collection of answers, but rather a complete document that anyone should be able to read and make sense of without the original problem set at hand!

 

The structure of a report can vary, depending on your research, but in general the structure broadly like this

 

  • Title, with the name of the author and the date
  • A short summary, typically known as an abstract
  • The introduction
  • Discussion of the methods (might include a discussion of the data used)
  • Results
  • Discussion
  • Conclusions
  • Bibliography

 

 In particularly short articles/reports some of these sections might be combined, but this should not influence the readability. In some cases it is also necessary to add sections, for instance to give more background information. It is however important not to use the above as a straitjacket but rather to adjust the above to suit your needs. The structure itself is of course not the goal of the report writing, it is merely a tool to help you get your point across effectively.

 

Engels: A practicum report should also avoid typos and poor language.

Nederlands: Ook in een practicumverslag moet je geen spel- of taalfouten maken. Vermijd ook het gebruik van de ‘ik-vorm’, en wees spaarzaam met de ‘wij-vorm’.

 

It is particularly good to take initiative - you can of course learn a lot by doing things yourself and finding out of things yourself - even though that might not have been explicitly asked for in the problem set. If you do this, and you decide to include this in the report, make sure you also indicate where the information was found.

 

The following

 

Titelblad - Het titelblad moet expliciet de titel van het verslag vermelden met de naam en studentennummer van de auteur

 

 

Inleiding - De inleiding is heel belangrijk. Hier introduceer je het onderwerp voor een lezer, die niet per se een expert is. Maak de inleiding daarom niet te kort (maar ook niet te lang!). Een redelijke lengte is 10-15% van de totale lengte van het verslag. De inleiding moet de volgende onderdelen bevatten:

 

 

    1.korte beschrijving van het onderwerp

 

    2.motivatie; waarom is dit onderzoek van belang

 

    3.achtergrondsinformatie (eventueel eerder verricht werk met verwijzingen)

 

    4.kort overzicht van wat er in dit verslag beschreven gaat worden

 

 

Methode - In deze sectie kun je de onderzoeksmethode en de apparatuur die gebruikt is beschrijven. Je kunt ook uitleggen waarom je een bepaalde opstelling hebt gekozen, of waarom je een bepaald object hebt waargenomen.

 

 

Resultaten - Hier geef je de resultaten met hun meetfouten. Gebruik de juiste aantallen significante cijfers. Geef altijd de foutmarge, ook als daar niet expliciet om gevraagd wordt. Geef natuurlijk ook aan hoe je tot de gegeven meetfout bent gekomen (tenzij het volkomen triviaal is). Schrijf bij voorkeur 1.1⋄1011 , en dus niet 0.11⋄1012 . Maar als je resultaat 70±20 is, kun je dat zo laten staan. Wat je ook doet, houd de leesbaarheid van het verslag in gedachten. Vergeet ook niet om eenheden bij je resultaten te vermelden en gebruik hierbij de in de sterrenkunde gebruikelijke eenheden (bv pc, zonsmassa’s, etc) en symbolen.  Als je getallen geeft, houdt er dan rekening mee dat grote hoeveelheden getallen de tekst onleesbaar maken. Het is dan beter om ze in een tabel te zetten. Het is belangrijk om de tabellen een nummer te geven. Geef ook altijd een bijschrift boven de tabel en leg daarin de tabel uit.

 

 

Discussie- Geef nooit zo maar een resultaat. Probeer het altijd te vergelijken met literatuurwaarden (of door logisch na te denken). Geef commentaar als je antwoord afwijkt. Een onjuist resultaat waarvan je tenminste door hebt dat het onjuist is, is minder erg dan een onjuist resultaat dat als goed wordt gepresenteerd. Bespreek ook eventuele fysische implicaties van je resultaat.

 

 

Conclusies - Hier kun je ook nog eventuele slotopmerkingen maken, open vragen aan de orde te stellen of bescrijven hoe de resultaten verbeterd kunnen worden.

 

 

 

Figuren - Een plaatje kan meer zeggen dan 1000 woorden, maar dat werkt natuurlijk alleen maar als de lezer de figuur ook kan begrijpen. Geef daarom altijd een figuur als dat verhelderend werkt. Geef ook altijd een bijschrift onder de figuur en leg daarin de figuur uit, inclusief alle eventuele symbolen. Ga dit niet nog eens in de tekst herhalen! Nummer de figuren ook, zodat je er in de tekst naar kunt verwijzen.

 

 

Vergelijkingen - Als je een verslag schrijft dat in de eerste plaats over de verwerking van gegevens gaat, vermijd dan de (veelgemaakte) fout alle te gebruiken formules (inclusief die voor de berekening van onzekerheden) in  het begin te presenteren (bv. in de sectie over methodes). Als je dit doet, moet je verder in het verslag steeds naar deze formules terugverwijzen en de lezer moet steeds terugbladeren. Dat maakt een verslag minder leesbaar. Presenteer formules op het moment dat je ze voor het eerst nodig hebt. In de sectie over methodes beperk je je in dit geval tot het beschrijven van de gegevens die je gebruikt (hoe heb je ze verkregen, heb je er eventueel nog iets aan gedaan om ze in bruikbare vorm te krijgen) plus een algemene beschrijving van de fysische methoden die je in de analyse gaat gebruiken.

 

NB: als een verslag een uitgebreide theoretische component bevat, gaat dit niet meer op; in dat geval kan het zeker goed zijn deze in het begin volledig uit te werken.

 

Presenteer alle formules die je gebruikt. Leg alle symbolen uit (zelfs triviale zoals T voor temperatuur) bij eerste gebruik. Gebruik standaard symbolen (dus T voor temperatuur, en niet bv. ξ ). Houd de symbolen in het hele verslag consistent, ook wat betreft lettertype. Dus vermijd het gebruik van bv. a in formules terwijl je in de text het symbool a gebruikt (ander lettertype). Nummer de formules (aan de rechterkant  van de pagina).

 

Voorbeeld: Einstein’s beroemde formule die het verband tussen energie E en massa m uitdrukt, luidt

 

 

E = mc2.                                                                                                                            (1)

 

 

Hierin is c de lichtsnelheid.