NTNU Norwegian University of Technology and Science
  Faculty of Information Technology, Mathematics and Electrical Engineering > Department of Computer and Information Science

Lasse's enkle tips om rapportskriving

Ifm. veiledning av mindre og større prosjekt samt diplomoppgaver har jeg laget en stikkordsmessig oppramsing av tips/ting å huske på m.m. ifm. rapportskriving. Dette er tildels et spørsmål om smak og behag. Systematikk og kvalitet er dog viktig uansett stil! Legg merke til at en rekke av kravene nedenfor er i konflikt med hverandre, dvs. fokuserer man for mye på ett kan det lett gå ut over et annet. Dette er noe av det som gjør skrivingen utfordrende og spennende.

Sist revidert 1 okt 2008. Kommentarer og forslagsendringer mottas med takk, helst pr. mail til Lasse (se nederst på siden).
  1. Rapportskriving er "et fag i seg selv"
    • dere får eller har fått ulike tilbud om kurs i rapportskriving på ulike nivå, ta i mot disse !
  2. Disposisjon
    • klarlegg struktur tidlig, putt inn stikkord.
    • legg gjerne frem oppdatert disposisjon/innholdsfortegnelse i hvert eneste veiledningsmøte
    • 1: intro
    • 2: "state-of-the-art" / Bakgrunn. Organiser etter ideer/konsepter, ikke etter tid, forfatter, el. geografi. (Ideelt sett, prøv å rydd opp i det som er skrevet om temaet).
    • 3 - (n-1): topp-ned. Kan oppfattes som en tre-struktur. En må ikke nødvendigvis "gå like dypt ned i alle grener" - ofte er det nødvendig å begrense arbeidsmengden. En tradisjonell oppbygging som også brukes er en "topp-ned-sekvens:" * Krav -> (Topp-nivå design) -> Detaljert design -> Implementasjon -> Test (testplan og testresultater).
      Alternativ mer forskningsrettet struktur: 1: intro, 2: s-o-t-a, 3: Research Questions, 4: Method, 5: Experiments, 6: Evaluation.
    • n: erfaringer, diskusjon, konklusjon, videre arbeid. (Delkapitlet "Videre arbeid" er smarte greier, her kan en snu noe negativt (det at det er noe en ikke rakk) til noe positivt, ved at en viser fornuftige tanker og ideer for hva som bør gjøres fremover.)
    • n++: vedlegg (man kan ikke forvente at sensor leser disse, men at hun blar i dem, gjør stikkprøver og vurderer dem.)
  3. Begynn tidlig!
    • Skriving tar vesentlig mer tid enn lesing.
    • Skriving tvinger fram mer grundig forståelse (Jfr. erfaringer ved å forklare et problem til en venn/kollega)
  4. Hopp i det!
    Lever notater og kladd til veileder selv om det ikke er helt ferdig. (Uten noe å lese er det vanskelig å veilede)
  5. Vis interesse og seriøsitet!
    Tenk på hva som motiverer en veileder til innsats
  6. Teknisk skriving =/= skjønnlitteratur
    • overordnet mål: "hjelp leseren"
    • konsistens framfor variasjon, men gjerne variasjon der det ikke forvirrer.
    • definisjoner, presisjon
    • fjern muligheter for misforståelser el. ulike tolkninger
    • figurer og tabeller hjelper
    • åpenhet/ærlighet/eksakthet (se plagiarisme)
    • opphavsrett, copyright
  7. Plagiarisme tolereres ikke!
    • skjult avskrift tolereres ikke
    • kopiering er lov, forutsatt at kilde klart oppgis og omfang/grad av kopi er angis
    • det er studentens arbeid som skal vurderes.
    • omfattende avskrift/kopiering er dumt. Å "tegne av" en figur er dumt. (Men på den annen siden kan en ikke forvente at sensor har eller skaffer de sentrale referansene.) Rapporten bør være fullstendig (Eng. selfcontained)
    • mer eller mindre ukritisk kopiering av informasjon fra internett er anerkjent som et økende problem ved universiteter i hele verden. Faglærere er på vakt mot dette, og søkeroboter gjør det lett å avsløre slikt.
  8. Fortsettelse av tidligere arbeid
    Hvis arbeidet er en fortsettelse av prosjektarbeid, sommerjobb el.l. skal det klart gjøres rede for dette på et egnet sted tidlig i rapporten (f.eks. i forord el. introduksjon). Det skal være lett å vurdere hva som er gjort i dette prosjektet.
  9. Engelsk
  10. Maksimer
    • innhold (prøv å oppnå høy "informasjonstetthet" uten at det går utover lesbarhet/forståelighet)
    • lesbarhet
    • forståelighet, klarhet
  11. Minimaliser
    • volum
  12. Vis måtehold ("unngå målforskyvning") - balanser!
    (Målforskyvning er et vanlig navn på det faktum at en lett kan skli ut på siden for et problem en sliter med å løse, og så heller jobbe med andre ting som er på siden eller langt vekk fra hovedproblemet)
    • ikke bruk for mye tid på
      • typografi - layout
      • fikse finesser
    • informasjons-innhenting (viktig med mye og god info, men "du kan bli borte der ute". Finn den rette balanse).
    • ambisjoner (de fleste student-prosjekter er for ambisiøse. Ambisjoner er bra men realisme er også viktig)
  13. Kvalitet framfor kvantitet
    • Bedre å gjøre litt bra enn mye dårlig.
    • Vil du at ditt prosjekt/rapport skal leve videre?
  14. HW og SW-dokumentasjon
    Det finnes mange måter å dokumentere HW, SW og systemer på. Viktig er systematikk og "tenke på" leseren/konstruktøren.
  15. Sunn fornuft og hardt, systematisk arbeid
    En viktig egenskap mange veiledere/arbeidsgivere ønsker seg hos studenter/ansatte er at man er selvdrevet, dvs. at man står på og jobber med oppgaven selv om det går tungt i perioder eller man "står fast". Det er du som skal gjøre arbeidet, og om veilederen blir en "flaskehals" bør det ikke bremse deg. SELVDREVET = SELVstendig + DRIV.
  16. Sett deg inn i leserens situasjon
    • faglærer/sensor
    • deg selv om 1 mnd el. 1 år
  17. Rapport som en tre-struktur
    • topp-ned planlegging
    • "parallell skriving", dvs. skriv notater, stikkord, ideer "rundt omking" i rapporten der ting hører hjemme i rapport-strukturen. Moderne tekstbehandling er her et fantastisk hjelpemiddel.
    • abstraksjon er viktig (ting er ikke nødvendigvis lett selv om du har forstått det i øyeblikket.)
  18. Referanser/bibliografi
    • første ref: ... Ole Hansen [Han94] beskriver at ... (Nevn evt. tittel på verket hvis det har en sentral plass i arbeidet)
    • senere ref: ... bla bla [Han94]
    • sitat (avskrift) må merkes
    • liste bak, nok info, riktig info, (Hva er hensikten?), spes. navn. (få liker at eget navn staves feil)
    • format uvesentlig (bibtex er bra), systematikk og presisjon er viktig. (Pass på å beskytte store bokstaver i latex slik at ikke NTNU blir skrevet som ntnu osv.)
    • noter ned alle nødvendige fakta om kilden når du finner den! (rett før innlevering har du glemt det). Viktigheten av dette punktet er noe redusert etter at søkemotorer og digitale bibliotek har gjort det mye lettere.
  19. Figurer og grafiske fremstillinger
    • bruk for å hjelpe leseren
    • forventes
    • stort spillerom -> bruk fornuft (visualisering et fag i seg selv) (excel, gnuplot, matlab osv.)
  20. Tekstbehandlings-systemer
    • framemaker (NTNU har fortsatt lisens)
    • latex (Mange dr.stip bruker dette) (Noen nevner bruk av "eclipse med riktig plug-in")
    • Haakon har tipset om TexNicCenter som skal være bra for å skrive latex under Windows. Gratis.
    • word, mange har fått problemer, men det er blitt bedre (og verre...)
Editor: Kontorsjef: Eivind Voldhagen  Contact address: Lasse KROELLALFA idi PRIKK ntnu PRIKK no  Last updated: 01.10.2008