Exjobbsrapport: Grundkrav och formaliakrav

I dagsläget så ställs det inte några krav på att ni ska använda någon specifik mall för er exjobbsrapport. Det är upp till er att skapa den rapport som ni vill skapa. Nyttja era kreativa egenskaper för att göra en snygg rapport som ni är stolta över. Så länge som rapporten känns logisk, är konsekvent och följer vedertagna principer så kommer den att accepteras.

Ni ska självklart följa alla rimliga krav på formalia som kan ställas på en rapport som ska publiceras i en nationell databas för forskning och studentarbeten vid svenska lärosäten.

Bra checklista: Här finns en checklista med vanliga fel när studenter skriver vetenskapliga artiklar och rapporter (med lösningar på problemen): Academic writing: Frequent errors with solutions

Det finns också några specifika krav på formalia som beskrivs nedan:

Grundläggande krav

  • Rapportens design ska bidra till hög läsbarhet. Det innebär t.ex. att det ska vara normalt radavstånd (upp till 1,1-1,3 radavstånd brukar fungera bra), normal fontstorlek (10-12p) med hög läsbarhet (både serif och san-serif fungerar) och normala marginaler.
  • Varje kapitel på högsta nivån ska börja på en ny sida.
  • Rubrikerna ska vara vara väl markerade.

Framsida

Framsidan ska innehålla följande information:

  • Titel på rapporten + eventuell undertitel
  • Författarens namn
  • Tidpunkt för genomförande (t.ex. “Spring 2022” eller “2022”)
  • Namn på akademisk handledare
  • Namn på examinator (oftast “Thomas Mejtoft”)
  • Typ av rapport (“Master thesis, 30 credits”)
  • Programnamn (“Master of Science in Interaction Technology and Design, 300 credits”)
  • Institution (“Department of Applied Physics and Electronics”)
  • Universitet och plats (“Umeå University, Sweden”)

(“credits” kan bytas ut mot “ECTS”, om man vill)

Annan information är ok att lägga till. Vanlig information som brukar finnas med är:

  • Kontaktuppgifter till författaren
  • Datum för inlämnade
  • Företag
  • Företagshandledare
  • Det är möjligt att lägga till en bild på framsidan.

Umeå universitet har tagit fram mallar som ni kan använda om ni vill (de finns att ladda ner under “Mallar för studenter”): https://www.aurora.umu.se/stod-och-service/blanketter-och-mallar/mallar-med-logotyp/

Rapportstruktur

Rapporten ska följa en logisk struktur som gör att innehållet är lätt att följa och ökar läsbarheten. Det vanligaste är att man följer en (troligtvis modifierad) version av IMRaD, där upplägget är (ungefär) enligt följande struktur.

IMRaD, en vanlig struktur på en rapport. Pilarna mellan olika områden visar på viktiga länkar som ska vara tydliga i rapporten.
  1. Titel
  2. Abstract med keywords (engelska + svenska)
  3. Table of content
  4. Introduction/Background
  5. Objective
  6. Theoretical framework
  7. Method (and Methodology)
  8. Results
  9. Discussion/Analysis
  10. Conclusion
  11. Future work
  12. Acknowledgement
  13. References
  14. Appendices

Det uppmuntras att skapa deskriptiva rubriker där innehållet tydligt framkommer och att även lägga till fler rubriker än de som beskrivits ovan. Detta ger en mer lättläst rapport.

Vanligt misstag: Varje nytt kapitel bör börja på en egen sida och innehålla en introduktion till kapitlet.

Abstract

Rapporten ska innehålla både ett abstract på engelska och en sammanfattning på svenska. En rimlig längd på dessa är ca 1 sida vardera.

Vanligt misstag 1: Abstract ger inte en övergripande bild över arbetet.
Vanligt misstag 2: Abstract innehåller inte slutsatserna från arbetet.

Keywords

Rapporten ska innehålla ca 5 keywords som beskriver själva arbetet och rapporten på bästa sätt. Dessa bör placeras på en egen rad sist i abstract.

Ni är fria att välja era egna keywords, men de kan också väljas från t.ex. ACM Computing Classification System.

Bilder, figurer och tabeller

Ni ska ha tillåtelse att använda de figurer, bilder och tabeller som ni har med i rapporten och som ni inte är upphovsperson till själva. Det innebär att ni måste ha tillstånd att använda alla objekt som är under någon form av copyright eller annat skydd.

Här finns information om hur ni kan lösa detta:

Tänk också på att figur+text (eller tabell+tabelltext) ska kunna förstås fristående från texten, dvs. om läsaren bara ser figuren och figurtexten så ska läsaren kunna tolka figuren.

Vanligt misstag 1: Figurtexter skrivs under figuren, men tabelltexter skrivs ovanför tabellen.
Vanligt misstag 2: Alla figurer/tabeller etc. ska hänvisas till i texten enligt något liknande: “… (figure 3)…” eller “Figure 4 illustrates…”.
Vanligt misstag 3: Texten i figurer är väldigt liten och svår att läsa. Sikta på minst 8-10 punkters text i figurer.
Vanligt misstag 4: Figuren har låg upplösning och blir därför “pixlig” och svår att tolka (och ser ful ut). Tips: gör era figurer i vektorgrafik (t.ex. Illustrator).

Metod

Metoden ska vara vald för att möjliggöra bästa möjliga resultat av arbetet. Detta för att några saker är väldigt viktiga att tänka på (men det finns många fler också):

  • Metoden som du valt ska vara väl motiverad, dvs. underbyggt av litteratur och att du kan visa på att det är troligt att detta är det bästa (eller i alla fall ett mycket bra) valet av metod.
  • Alternativa metoder bör presenteras för att visa på vilka val som du har gjort och varför dessa val har gjorts.
  • Om metoden är komplex (vilken den ofta är), så är t.ex. en figur som visar på hur ni har lagt upp studien ett bra sätt att öka läsbarheten.
  • Testpersoner måste väljas med omsorg. Att välja testpersoner bland era kompisar kommer (om inte detta är syftet) att eventuellt innebära att ni måste göra om studien för att bli godkända.

Vanligt misstag 1 (som är svårt att reparera i efterhand): Dåligt urval av testpersoner. Valet av testpersoner (och antal testpersoner) måste motiveras. Observera att vid få testpersoner på ett test, så måste fler tester göras (dvs. t.ex. testa i fler steg) för att garantera en bra design. En sluttest med t.ex. 6 personer garanters (oftast) inte ett bra resultat.

Vanligt misstag 2: Validitet och reliabilitet av era resultat måste diskuteras i rapporten.

Referenser och referenslista

Ni ska ha referenser som stöttar ert resonemang genom hela rapporten. Ni ska använda ett vedertaget system t.ex. Namn-År. ex. (Mejtoft, 2022) eller numeriskt, ex. [23]. Dessutom så ska ni använda en vedertagen stil för att skriva referenser (t.ex. APA, IEEE, ACM, etc.). Detta löser sig per automatik om ni t.ex. skriver i LaTeX.

Om ni hänvisar till personlig kommunikation så läs detta:

Rapporten ska (självklart) innehålla en referenslista. Ni kan använda det system för att skriva referenser i text och strukturera referenslistan på som ni tycker känns passande för just er rapport. MEN det är viktigt att ni följer en vedertagen de-facto standard (dvs. ett system).

Förslag på vedertagna system inom ingenjörsvetenskap och teknikvetenskap är:

Dessa system finns alla att ladda ner som bibliography style file (.bst) för att formatera BibTeX poster (vissa är också förinstallerade i t.ex. Overleaf).

Vanligt misstag 1: Det ska vara ett mellanslag innan referensen. Dvs. den ska inte skrivas ihop med ordet före. ex. “… for a sucessful strategy [34].”

Vanligt misstag 1: Referensen ska vara före punkten i meningen och inte efter punkten (se exempel ovan).

Här är en väldigt utförlig lista på vanliga fel och även lösningar på dessa: Academic writing: Frequent errors with solutions

Tempus

Använd tempus som vanligt, men tänk på att när något blivit publicerat så anses det som “fakta” och ska hänvisas till i nutid. Detta är speciellt viktigt i t.ex. bakgrund och teori.

Här finns en bra sida med stöd i kring tempus: Effective Writing

Några saker som är vanliga att man får retur på sin rapport kring är:

  • Abstract/Sammanfattning
    • Ett abstract som inte visar på hela arbetet. Abstractet ska vara en miniversion av arbetet och innehålla alla väsentliga delar. Fokus bör vara på ditt resultat och din diskussion.
  • Introduktionen
    • Avsaknad av tillräcklig bakgrund för att motivera varför detta arbete ska göras. Det är viktigt att du motiverar i introduktionen varför detta arbete ska göras. Gör det genom att använda en så kallad tratt (fullel approach), där generell information gradvis blir mer specifik.
  • Teori
    • Få vetenskapliga referenser. Teorin ska vara uppbyggt på vetenskapliga källor. Det är självklart så att inte alla referenser måste vara från vetenskapliga källor, men en stor mängd bör vara det. Se ovan för tips på var du hittar bra referenser.
    • Mycket text från en och samma källa. Källor som du baserar stora delar av din teori på är viktigt att de backas upp med fler källor. Lägg in fler referenser som säger samma sak och beskriva även alternativ (om det finns andra ståndpunkter i teorin).
  • Metod
    • En dåligt skriven och dåligt motiverad metod (dvs. ni måste referera och beskriva era metodval). Beskriv också alternativa metodval för att motivera varför ni gjort som ni gjort.
    • Mycket text från en och samma källa. Källor som du baserar stora delar av din metod på är viktigt att de backas upp med fler källor.
    • Dåligt strukturerad metod, vilket gör den svårt att förstå (går oftast att lösa med t.ex. en figur).
    • Avsaknad av diskussion kring validitet och reliabilitet av era resultat (detta kan också ligga under diskussion). Det är viktigt att ni gör bra metodval för att kunna visa på att era resultat bra en bra validitet och reliabilitet.
    • Dåligt utval av testpersoner. Att göra ett bekvämlighetsurval som inte kopplar till målgruppen är ett mycket dåligt utval och kan leda att till att studien måste göras om
  • Diskussion
    • Dålig koppling mellan teori, metod, resultat och diskussion. I diskussionen bör man visa på hur era resultat kopplar till teorin som ni använt och hur detta har lett området framåt i utveckling. Diskussionen ska tydligt koppla den teori som finns i rapporten med de resultat som ni har från er studie. En bra diskussion kopplar dessa på ett bra sätt och använder referenser för att visa kopplingarna (dvs referenser till de artiklar ni hänvisat till i teorin).
  • Slutsatser
    • Dålig koppling mellan slutsatser och syftet med studien. Det syfte som finns i ert arbete ska vara besvarat i slutsatserna
  • Referenser
    • Många påståenden som inte är uppbackade av referenser. Det är viktigt att ni använder referenser för att visa på vad ni bygger er rapport på. Det ska finnas många referenser i inledningen (för att motivera varför ni ska göra studien), i teorin (för att visa vad ni byggt ert arbete på, här bör det var aövervägande vetenskapliga källor), i metoden (för att motivera att detta är bästa sättet att göra denna studie på) och i diskussionen (för att visa på hur resultaten och teorin är hopkopplade).
    • Få vetenskapliga referenser. Det är självklart så att inte alla referenser måste vara från vetenskapliga källor, men en stor mängd bör vara det. Se ovan för tips på var du hittar bra referenser.
    • En referenslista med fel i. Det är viktigt att allt är korrekt när ni använder BibTeX, att fuska med inskrivningen i BibTeX ger ofta konstiga referenser: https://www.mejtoft.se/thomas/education/id/exjobb/references-using-bibtex/
  • Figurer/tabeller/bilder
    • Dålig figurtext. En figur eller en tabell ska kunna läsas fristående med hjälp av sin text.
    • Inte refererat korrekt till bilder, skärmdumpar eller andra verk som inte era egna original. Allt som inte är ert eget originalarbete ska refereras på olika sätt. Här finns instruktioner för bilder, skärmdumpar och att skriva referenser till sekundära källor och review-artiklar.
    • Svårläslig figur. Text i figurer som är får svår att läsa, oftast för att den är väldigt liten eller otydlig (låg upplösning).
  • Bilagor (appendix)
    • Svårt att förstå en bilaga. En bilaga för vara möjlig att förstå utan att förklaringen inne i rapporten har lästs. En “förklaring” till vad bilagan innehåller är en bra introduktion till varje bilaga.

(First published by Thomas Mejtoft: 2020-12-27; Revised: 2021-06-17; Last updated: 2022-05-06)