Research and Development 1/2010-11/richtlijnen/eindverslag - productdocumentatie

Titel

Kies een aansprekende titel. Dus niet ‘Verslag R&D1’ of iets dergelijks.

Samenvatting

‘Abstract’. Vat het document kort samen.

Voorwoord

Geef aan waarvoor het document bedoeld is en in het kader waarvan het geschreven is. Beschrijf hoe het document is opgebouwd (leeswijzer).

1. Beschrijving

Inleiding

Globale beschrijving van het product en belangrijkste eigenschappen

Specificaties

"Wat". Beschrijving van de eigenschappen van de applicatie. (Her)gebruik de specificaties die je in de pilot en fase 1 hebt gemaakt. Pas ze zo nodig aan zodat ze het uiteindelijke product karakteriseren.

Structuur

"Hoe". Beschrijving van de opbouw van het systeem. Geef een functionele opsplitsing in componenten die overeenkomt met de wijze waarop jullie het systeem hebben gebouwd. (Her)gebruik eerdere documentatie (architecture design, decomposition, etc). Geef bij elke component een beschrijving die inzichtelijk maakt wat de rol is in het geheel. De structuurbeschrijving dient als documentatie en als leeswijzer voor de programmacode.

Ontwerpverantwoording

"Waarom". Geef aan waarom jullie ontwerp een goed ontwerp is. Beschrijf de rationale achter het ontwerp. Ga inhoudelijk in op de belangrijkste inhoudelijke vraagstukken en bijbehorende ontwerpbeslissingen en geef aan hoe jullie tot die beslissingen zijn gekomen.

2. Evaluatie

Onderzoeksvraag

Geef aan welke producteigenschappen in het onderzoek aan de orde komen. Geef de relatie met de specificaties aan.

Achtergrond

Achtergrondinformatie (theorie, methoden, standaarden, etc) die van belang is voor het onderzoeken van de gekozen eigenschappen. Welke aspecten zitten er aan de te onderzoeken eigenschappen: hoe kun je ze karakteriseren, bepalen, etc? Deze informatie moet zodanig zijn dat de lezer kan inzien dat jullie onderzoeksmethoden passend (‘valide’) zijn. Verwijs naar literatuur, leer/handboeken, standaarden, andere documentatie.

Methode

Geef aan hoe je het evaluatieonderzoek hebt uitgevoerd. Ga in op de operationalisatie (hoe heb je de eigenschappen onderzoekbaar gemaakt – verbind dit met ‘Achtergrond’) en de werkwijze. Gebruikte onderzoeksinstrumenten zoals vragenlijst, interviewleidraad, observatielijst oid, neem je op in een bijlage.

Resultaten

Presenteer de verzamelde gegevens op een overzichtelijke manier. Ruwe data kan eventueel in een bijlage. Analyseer de gegevens.

Conclusie

Beantwoording van de onderzoeksvraag.

3. Reflectie

Product

Geef aan waarover jullie tevreden zijn. Beschrijf ook waarover jullie minder tevreden zijn. In hoeverre is het product anders dan voorgenomen? Hoe komt dat?

Proces

Geef aan waarover jullie tevreden zijn. Beschrijf ook waarover jullie minder tevreden zijn. In hoeverre ging het anders dan verwacht? Hoe komt dat? Trek conclusies voor toekomstige activiteiten.

Learner report (individueel: onderdeel van je portfolio)

Geef aan wat je geleerd hebt in dit project. Je leerervaringen kunnen gaan over de inhoud (over ontwikkel- of onderzoeksaspecten, projectwerk) en over jezelf (sterke en minder sterke kanten, aanpak, samenwerking, etc). Ze kunnen algemeenheden betreffen (‘regels’) of specifieke situaties (‘uitzonderingen’).

Bijlagen

• (Verwijzing naar) code
• (Verwijzing naar) handleiding
• Evt. onderzoeksinstrumenten
• Evt. ruwe onderzoeksgegevens

Denk aan

• Het verslag wordt geproduceerd met LaTeX
• Sturing van de lezer: val niet met de deur in huis, spring niet van de hak op de tak. Voer de lezer (‘aan de hand’) door het document heen.
• Taalgebruik: bij meer dan 10 fouten wordt het verslag niet beoordeeld. Organiseer zonodig taaladvies.
• Formulering: houd het zakelijk en to-the-point.