Het labjournaal
Het
labjournaal schrijf je in de eerste plaats voor jezelf. Je legt vast wat je
gedaan hebt, hoe je het deed en waar je op moet letten en dergelijke, zodat je
later direct begrijpt wat je gedaan hebt en je het zonodig kunt herhalen.
Verder is het de basis voor je verslag. Dit is de documentatiefunctie van je labjournaal. Als er meer dan
één persoon
bij het experiment betrokken is, heeft het ook een communicatiefunctie.
Het spreekt vanzelf, dat het
labjournaal zo volledig moet zijn, dat je later geen informatie mist.
Werk daarom niet met
kladjes, want die raken weg of leiden tot overschrijffouten.
Leg direct alles vast, waarvan je denkt, dat het nuttig is. Gebruik
hiervoor een soort dagboek. Probeer
verder om het labjournaal overzichtelijk
te maken. Gebruik hiervoor een thematische
opzet, als intermediair tussen opdracht en verslag. De leesbaarheid en
overzichtelijkheid worden zeker bevorderd door het gebruik van genormaliseerde
symbolen en het veelvuldig gebruik van schemaÆs,
tabellen en grafieken.
Wat moet je nu allemaal
vermelden in je labjournaal? In de thematische
opzet in ieder geval:
0. wie je bent.
1. wat je gaat onderzoeken: zeg maar de opdracht in eigen woorden
2. hoe je gaat onderzoeken: wat is je hypothese, en hoe ga je die
bewijzen.
Als het experiment wat
ingewikkelder is, zul je een plan maken. Dat vermeld je natuurlijk. In dat plan
deel je onderzoek op in delen, die ieder 'an sich' beter te bewijzen c.q. af te schatten zijn. Je mag
wel naar voorafgaande experimenten in je labjournaal verwijzen. Bij
programmeeropdrachten heb je vaak de keuze uit meerdere methoden/algoritmen.
Hier documenteer je jouw ontwerpbeslissingen. De resulterende implementatie licht je toe met één à twee regels
pseudo-code.
3. gegevens van de software en de apparatuur: Geef in één à twee regels een
samenvatting van je gebruikte spullen. Zet in de appendix
details als de soort en identiteit van gebruikte apparatuur (denk aan uname -a bij
computers) en de versies en soort van programmeeromgevingen, liefst met links
naar de downloadpagina.
4. de onbewerkte waarnemingen, dat wil zeggen: de meetwaarden gemeten voordat
deze meetwaarden bewerkt/gefilterd zijn.
Voeg deze toe als appendix.
Geef hier alleen de samenvatting in tabel of grafische vorm. De reden van een
eventuele foute meting is anders achteraf nooit meer te achterhalen.
5. de resultaten, dus eventuele tussenresultaten en het eindresultaat,
in grafische vorm en met commentaar. Zonodig vermeld je bij de uitwerking nog
eens de formules van de bewerkingen, waarmee het eindresultaat wordt berekend
uit de gemeten grootheden. Het spreekt vanzelf dat zowel de nauwkeurigheid van
de metingen als de resultaten worden aangegeven. Zonodig geef je een
foutenanalyse.
Verdere gegevens die
belangrijk (kunnen) zijn, zijn bijvoorbeeld eventuele storingen. Als je denkt,
dat ze misschien van belang zijn, noteer ze dan.
6. de aannamen, die je soms zonder nadenken gebruikt. Om de leesbaarheid
te verhogen is het raadzaam om zoveel mogelijk uit te leggen, wat je aan het
doen bent en waarom. Dit is een samenvatting van je dagboek, met de waarschuwingen en zijpaden die je bewandeld hebt.
Voeg het dagboek toe als appendix.
7. de broncode, voeg deze toe als appendix. Schrijf zoveel mogelijk 'self explanable code'. Gebruik
hierbij de 'General guidelines'
die te vinden zijn onder: http://staff.science.uva.nl/~dick/education/prak/codconv/
Kortom, een labjournaal is
bedoeld om je experimenten later te kunnen herhalen. In het dagboek zet je de dagelijkse
beslommeringen, in het overzicht behandel je jouw experimenten thematisch.
Voor het bijhouden van een
labjournaal is een Wiki erg handig, bijvoorbeeld: UseMod
De lijst van karakter definities in HTML kan men o.a. vinden bij de documentatie van onze systeemgroep: http://www.science.uva.nl/ict/documentation/.