Schrijfwijzer Handleiding voor het schrijven van verslagen
Auteurs: James M. Boekbinder Jantien Slob Irma Rademaker 2014.09.07 versie 18.0
Inhoudsopgave Korte verslagen (1 tot 2 pagina's) BOUWSTENEN VAN EEN KORT VERSLAG Lange verslagen (meer dan 2 pagina's) BOUWSTENEN VAN EEN LANG VERSLAG Titelpagina Inhoudsopgave Inleiding Hoofdstukken en subhoofdstukken Interviews Bijlagen Bronnenlijst Beschrijving van interfaces Paginanummering Gebruik van teksten uit andere bronnen Algemene vormgeving Bronnenlijst
ii
1
Korte verslagen (1 tot 2 pagina's)
1.1 BOUWSTENEN VAN EEN KORT VERSLAG Header* Voorzie korte verslagen van een header met minimaal de volgende informatie:
voor- en achternaam student(en) studentennummer klasnummer datum versienummer naam docent(en) opdracht
Titel * De titel geeft de inhoud van de opdracht of activiteit weer. Subtitel Een subtitel kan de titel verder verduidelijken, indien wenselijk. Bodytekst* Let op: als deze tekst meer dan één onderwerp behandelt, gebruik alinea’s met tussenkoppen om de tekst overzichtelijk te maken. Bronnenlijst Indien gebruik gemaakt wordt van boeken, artikelen of andere documenten, on- en offline, som deze op in een bronnenlijst (zie 2.1.6 hieronder voor een voorbeeld). Let op: items aangeduid met * zijn verplicht voor ELK kort verslag.1
2
Lange verslagen (meer dan 2 pagina's)
2.1 BOUWSTENEN VAN EEN LANG VERSLAG Elk verslag van een opdracht voor Interaction Design bevat een aantal elementen: Titelpagina* Inhoudsopgave* Inleiding* Hoofdstukken en subhoofdstukken (waaronder conclusies en persoonlijke verslagen)* Bijlagen Bronnenlijst*
1
Deze regel geldt niet in het geval dat een standaard voorblad of titelblad voor een verslag wordt verstrekt.
Beschrijvingen van interfaces – foto’s, schema's en beschrijving van de verschillende functies met verklaringen Pagina-nummering* Illustraties en grafische elementen Let op: items aangeduid met * zijn verplicht voor ELK lang verslag. Hieronder worden deze elementen afzonderlijk toegelicht. 2.1.1 Titelpagina Deze bevat: titel (meestal naam van opdracht) subtitel die het onderwerp nader uitlegt (optioneel) voor- en achternaam student(en) studentennummer klasnummer datum versienummer naam docent(en) 2.1.2 Inhoudsopgave In het boek 'Een goed rapport'2 bevinden zich een aantal handige checklists, waaronder één voor de inhoudsopgave. Hieronder volgen een aantal punten uit de checklist: Bevat het alle in het rapport opgenomen (sub)hoofdstukken in dezelfde volgorde, met dezelfde nummeraanduiding en dezelfde titel als in het rapport? Komen de verwijzingen naar de pagina's overeen met de werkelijke pagina's in het rapport? Is de verdeling in hoofdstukken, subhoofdstukken en paragrafen goed overdacht en logisch? Zijn de titels en subtitels correct en informatief in relatie tot de inhoud? Is de layout overzichtelijk en ruim opgezet zodat de lezer snel ziet waar welk onderdeel staat? 2.1.3 Inleiding Een inleiding moet informeren, structureren en motiveren.3
informeren - de lezer vertellen wat de probleemstelling is en waarom en hoe het onderzocht is structureren - de lezer vertellen hoe het rapport is opgebouwd
motiveren - bovenstaande informatie op zo'n manier formuleren dat de lezer het belang ervan inziet
2.1.4 Hoofdstukken en subhoofdstukken Elk hoofdstuk behandelt één onderwerp. Subhoofdstukken behandelen deelonderwerpen daarvan. TIP Bij het schrijven, let op een aantal basiseisen: gebruik titels van (sub)hoofdstukken maar één keer; zo beknopt mogelijk formuleren; zonder spel-, grammaticale of andere taalfouten; onderzoek je gedachten en meningen: is het waar wat je schrijft?; schrijf in een serieuze, maar niet te formele toon, zonder onnodige vaktermen, grappen of andere inhoud die er niet bij past; geen waardeoordeel over het verslag zelf geven - het is aan lezers om te oordelen
2
Hogeweg, Reinout (2004), Een goed rapport, Utrecht / Zutphen: ThiemeMeulenhoff.
3
Hogeweg, Reinout (2004), Een goed rapport, Utrecht / Zutphen: ThiemeMeulenhoff.
2.1.5 Interviews Bij de weergave van een interview:
geef voor elke respondent zowel de vragen als de antwoorden weer - niet alleen de antwoorden; schrijf de antwoorden zo volledig mogelijk uit en wel als citaat; dus niet inkorten tot een enkel woord (ja, soms, nee) of veranderen in een verhaal geschreven vanuit de derde persoon; Niet zo: Koopt u vaak bij de MediaMarkt? Soms Of zo: Koopt soms bij Mediamarkt. Maar zo: Koopt u vaak bij de MediaMarkt? "Nou, soms wel... het hangt ervan af wat ik nodig heb."
nummer de vragen en herhaal de nummering bij elke respondent geef bij elk interview de gegevens van de respondent weer in een beknopte header schrijf de vraag en bijbehorend antwoord bij elkaar, niet op gescheiden plaatsen in het document
2.1.6 Bijlagen In de bijlagen worden alle relevante achtergrondmaterialen opgenomen, zoals volledige teksten van interviews, productspecificaties of andere materialen. Zorg dat elke bijlage een eigen nummer heeft en dat alle bijlagen opgenomen worden in de inhoudsopgave. 2.1.7 Bronnenlijst Aan het einde van het verslag vermeld je de volledige gegevens van alle geraadpleegde bronnen. Voor boeken en artikelen bevat de vermelding: naam van auteur datum publicatie titel (in cursief) locatie uitgever naam uitgever Bijvoorbeeld: Saffer, Dan (2007), Designing for Interaction: Creating Smart Applications and Clever Devices, Berkeley, CA, USA: New Riders. Voor online en database bronnen bevat de vermelding: naam van auteur datum publicatie (of n.d. als er geen datum bekend is) titel (in cursief) datum waarop bron geraadpleegd is URL (web of database) Bijvoorbeeld: Landsberger, Janice (n.d.). Study Guides and Strategies. Geraadpleegd: 13 mei 2012, op http://www.studygs.net/citation.htm.
2.1.8 Beschrijving van interfaces Je verslagen bevatten vaak beschrijvingen van een interface. Hieronder volgt een eenvoudig voorbeeld van een beschrijving van een schermafbeelding met genummerde annotaties (nummers die op de afbeelding van de interface geplaatst worden en die verwijzen naar een lijst van verklaringen onder of naast de afbeelding). Deze is opgemaakt in Microsoft Word, voor de meeste studenten een toegankelijk programma met beperkte layout- en ontwerpmogelijkheden. Toepassingen als InDesign zijn beter geschikt voor het vormgeven van schema’s en illustraties. Let
4
op: foto's en andere afbeeldingen moeten groot en scherp genoeg zijn om gemakkelijk gelezen te worden gebruik annotaties behalve verklaringen van de werking van elementen van de interface kun je ook algemene opmerkingen opnemen voor de wireframes die onderdeel uitmaken van cursusactiviteiten bestaan aparte richtlijnen (zie de handleiding 'Manual for screen interface sketching')4
Boekbinder, J., Slob, Z. Pashkina (2014), Manual for screen interface sketching, Rotterdam: HRO.
VOORBEELD VAN BESCHRIJVING VAN EEN INTERFACE: HOMEPAGE HRO INTRANET
Scherm is verdeeld over het algemeen in 3 kolommen met een onderverdeling in 8 vlakken: 1. 2. 3. 4. 5. 6. 7. 8.
Bovenbalk met ID van HINT, gebruikersgroep en instituut Hoofdnavigatiebalk met tabs voor hoofdonderdelen Visual ter versterking van (Rotterdamse) identiteit van school 1ste (linkerkolom) met subnavigatie Balk met kruimelpad 2de (middelste kolom) voor tekst en andere content Vlak met zoekfunctie Verticaal vlak voor sitewide functies en tools
Opmerkingen: Visuele hiërarchie is zwak. Rode kruimelpad (5) en beeld (3) verstoren de basis hiërarchie van tabs en subnavigatie. Grootte van alle koppen (op bijv. tabs) is niet verschillend genoeg - dit maakt de hiërarchie ook minder duidelijk. In contentvlak (6) zit een tabel waarin subnavigatie items herhaald (bijv. 'Cijfers') worden. Dit is compleet verwarrend, en wekt de indruk van een hiërarchie die er niet is, door 2 kolommen zij-aan-zij te nestelen in het tabel. Het lijkt een soort van 'tweede site binnen een site'. Op deze manier is de functie van dit vlak (6) niet duidelijk - het is zowel content als uitgebreide navigatie.
2.1.9 Paginanummering Alle pagina's (exclusief titelpagina en inhoudsopgave) moeten voorzien worden van nummering.
3
Gebruik van teksten van andere auteurs / bronnen
Als je in een verslag teksten uit een publicatie of bron van een andere auteur wilt gebruiken als onderdeel van je eigen tekst, is het belangrijk om de bron en auteurs van de overgenomen tekst volledig en nauwkeurig aan te geven. Ook moet de overgenomen tekst worden onderscheiden van je eigen tekst. Hiervoor geldt de vuistregel: parafraseer liever dan dat je hele zinnen of alinea’s ‘knipt en plakt’. Schrijf de informatie op in je eigen woorden gebaseerd op de redenen waarom je een tekst relevant vindt. Stel dat je als onderdeel van een tekst wilt uitleggen waarom het moeilijk is om te weten te komen hoe een algorithme van een grote webdienst werkt. Je vindt een artikel waarin het onderstaande fragment staat met uitleg hierover. Neem het fragment niet een-op-een over. Dus niet zo: Hoe kun je een algorithme doorzien?1 De meest voor de hand liggende optie is om die regels uit de softwarecode te destilleren. Maar dat is niet zo makkelijk. Het algoritme dat de newsfeed reguleert, is eigendom van Facebook en die wenst geen pottenkijkers. Wat voor Facebook geldt, geldt ook voor veel andere bedrijven. Er wordt daarom vaak gesuggereerd om een onafhankelijke overheidsinstantie of vertrouwde derde partij aan te wijzen die zich over de code buigt. Maar ook dat heeft niet zoveel zin. Ten eerste veranderen algoritmen continu, simpelweg omdat de dynamiek tussen online dienstverlener en gebruiker dat vereist. Een goed voorbeeld is de handel in likes. Lees hier meer over de like-economie: vind mij leuk en ik zal zeggen wie je bent. Lange tijd gold dat hoe meer likes je hebt, hoe groter de kans was dat je in iemands newsfeed terechtkwam. Dus ontstond er een levendige handel. Inmiddels lijkt het erop dat het algoritme dit gedrag juist weer afstraft. Ten tweede zijn algoritmen van grote webdiensten zeer complex geworden. Een beetje algoritme van Facebook bestaat uit miljoenen regels code. Door die complexiteit is het heel moeilijk om de uitkomst van de logische regels helemaal te doorgronden. Je kunt er wel data instoppen, maar er hoeft maar een klein dingetje anders te zijn en de uitkomst is wezenlijk anders. Maar zo: Het is moeilijk om te weten te komen hoe een algorithme van een grote webdienst precies werkt, voor een aantal redenen: ● bedrijven houden algorithmen geheim ● algorithmen veranderen continu ● algorithmen zijn zeer complex geworden (1) In de voetnoot geef je de bron aan, in dit geval een artikel in De Correspondent. Op deze manier bied je de lezer alleen de relevante informatie op een overzichtelijke manier en in de juiste context. Als je wel een zin letterlijk wilt overnemen in je tekst, moet het visueel onderscheiden worden van de rest van de bodytekst. Een enkele zin kan opgenomen worden na een dubbele punt, tussen aanhalingstekens. Vaak wordt zo’n citaat ingeleid door de bron aan te wijzen. Dus zo: Zoals correspondent Dimitir Tokmetzis recentelijk schreef: ‘Je kunt er wel data instoppen, maar er hoeft
1
Tokmetzis, Dimitri. Hoe werken de algorithmen die op Facebook bepalen wat je krijgt te zien? Geraadpleegd: 7 september 2014, op https://decorrespondent.nl/1624/Hoe-werken-de-algoritmen-die-bepalen-wat-je-op-Facebook-krijgt -te-zien-/129352170024-7b87ed7d
maar een klein dingetje anders te zijn en de uitkomst is wezenlijk anders.’ (1) Ook dit citaat moet van een voetnoot worden voorzien met volledige bronverwijzing. Ook hier geldt: dit type citeren doe je alleen als het niet beter verwoord kan worden voor de lezer. Een alinea (meer dan een zin) moet als ‘block quote’ worden weergegeven, d.w.z. de tekst moet door een witregel en een diepere inspringing worden onderscheiden van de rest van de bodytekst. Ook hier is het belangrijk om naar de bron te wijzen in een inleidende regel. Dus zo: Zoals correspondent Dimitir Tokmetzis recentelijk schreef: Ten tweede zijn algoritmen van grote webdiensten zeer complex geworden. Een beetje algoritme van Facebook bestaat uit miljoenen regels code. Door die complexiteit is het heel moeilijk om de uitkomst van de logische regels helemaal te doorgronden. Je kunt er wel data instoppen, maar er hoeft maar een klein dingetje anders te zijn en de uitkomst is wezenlijk anders. (1) Ook dit type ‘block quote’ moet van een voetnoot worden voorzien met volledige bronverwijzing. Wellicht ten overvloede: parafraseren heeft altijd de voorkeur over direct citeren. Het gebruik van ‘block quotes’ is dus eerder uitzondering dan regel. Let op: als teksten worden overgenomen zonder de bron aan te geven, en de overgenomen tekst te onderscheiden van de rest van de bodytekst, zal het als plagiaat worden beschouwd.
4
Algemene vormgeving
Pas voor je gehele verslag een consistente vormgeving toe. Begin met het vaststellen van een vaste marge (houd rekening met de printermarge) en het aantal kolommen. Voor de tekst kun je het beste vaste tekststijlen gebruiken voor de kop, subkop, inleiding, platte tekst, fotobijschrift, paginacijfer. Deze basisprincipes zijn in alle opmaaksoftware terug te vinden (ook in MS Word). Het opgemaakte verslag schrijf je weg als pdf, een bestandsformaat dat universeel uitwisselbaar is. Gebruik de optie ‘kleinste bestandsformaat’ om te voorkomen dat je documenten onnodig groot worden.
5
Bronnenlijst
Boekbinder, J. Slob, J., Rademaker, I., Philippen, J. (2014) Basiscursus interaction design, Rotterdam: HRO. Hogeweg, Reinout (2004), Een goed rapport, Utrecht / Zutphen: ThiemeMeulenhoff.
