Rapportmall/Anvisningar Vetenskaplig rapport

Transkript

1 Rapportmall/Anvisningar Vetenskaplig rapport Mälardalens Högskola Akademin för Innovation, Design och Teknik Författarnamn (Förnamn Efternamn) Examen/Nivå på examensarbete Datum Examinator: examinatorns namn Handledare: handledarens namn Stor omsorg bör läggas vid valet av titel. Titeln ska informera om rapportens innehåll, den får inte vara allt för generell men inte heller för specifik eller detaljerad.

2 Anvisningar för rapportens inledande del Läs igenom hela denna rapportmall innan du påbörjar ditt arbete. Läs också dokumentet Guide till skrivande. Där finns tips på hur skrivprocessen ser ut samt hur man hanterar stycken, citat, figurer, tabell och kod i texten. Den vetenskapliga rapporten är en av de allra vanligaste akademiska texttyperna. I stort så följer den en bestämd struktur men denna kan variera något beroende på ämne. I denna rapportmall finns en generell beskrivning av de delar som ska finnas i en vetenskaplig rapport samt vilken struktur denna har. Du bör alltid kontrollera vilka regler som gäller för den typ av rapport och inom det ämnet som du ska skriva samt diskutera rapportens struktur med din handledare. Den inledande delen av den vetenskapliga rapporten består av uppgifter som krävs för att läsaren ska få en inblick i rapportens struktur och innehåll. Abstract/Sammanfattning Abstract och sammanfattning, är en kort text vars syfte är att ge läsaren ett sammandrag av rapporten innehåll, med andra ord problemet, metoden och resultatet. Det är denna rubrik som får flest läsare och det är här läsaren ska kunna avgöra om rapporten är av intresse. Sammanfattningen får inte innehålla någon information som inte kan återfinnas i rapporten. Eftersom sammanfattningen sammanfattar vad som redan gjorts ska den skrivas på tempus imperfekt och den skrivs alltid löpande, utan styckesindelning. För att kunna återge rapportens innehåll och resultat på ett bra sätt skrivs denna sist. Den ska dock ligga först i rapporten, redan innan innehållsförteckningen. Storleken på sammanfattningen ska vara ca ½ sida. Några stolpar att skriva sammanfattningen kring är: Vad handlar arbetet om (ämne)? Vilket var syftet och hur strukturerades, organiserades och begränsades arbetet? Vilka källor användes? Vilket blev resultatet och vilka slutsatser drogs? Skrivs rapporten på svenska ska både en Sammanfattning skriven på svenska och en Abstract skriven på engelska finnas med. Skrivs rapporten på engelska räcker det med en Abstract skriven på engelska. 2

3 Innehållsförteckning 1. Inledning Problemformulering Bakgrund Metod Teknisk beskrivning/design/teori Resultat Analys/Utvärdering/Diskussion av resultat Relaterad forskning Avslutning/Slutsatser Framtida arbeten... 6 Källförteckning... 7 Referenser enligt IEEE- systemet... 8 Innehållsförteckningen ska korrekt visa rapportens rubriker och nivåerna på dessa samt på vilka sidor rubrikerna kan hittas i rapporten. Det är den sida som själva rubriken står på som ska anges som sidnummer. Den enda rubrik som inte ska finnas med är rubriken Innehållsförteckning. Rubriker kan anges på olika sätt. Används numreringar framför rubrikerna så ska även dessa synas i innehållsförteckningen. Källförteckningen ska inte föregås med en siffra. Siffror och teckenstorlek kan användas för att visa rubrikens nivå. Undvik att använda fler än tre nivåer på rubrikerna då detta kan göra att arbetet känns rörigt och svårt att greppa. Förteckning över tabeller och/eller figurer ska finnas efter innehållsförteckningen om rapporten innehåller tabeller och/eller figurer. Tabeller och figurer ska vara numrerade, ha figur- och tabellnamn samt alltid hänvisas till från texten. Tänk på att skapa en för läsaren tydlig och logisk struktur samt att bibehålla en röd tråd genom hela arbetet. Tips! Används ordbehandlingsprogrammets inbyggda rubriknivåer så kan en korrekt innehållsförteckning genereras automatiskt, detta rekommenderas starkt! 3

4 Anvisningar för rapportens huvuddel Rapportens text ligger i den här delen. Den ska delas in i flera rubriker och olika underrubriker utifrån vilka som behöver finnas med för att göra strukturen tydlig för läsaren. Delarna inledning, syfte, metod, material och avslutning måste finnas med medan andra delar kan benämnas och struktureras olika beroende på ämne. Man kan behöva dela upp eller slå ihop vissa delar/rubriker beroende på rapportens struktur. Här måste författaren se till att strukturen är genomtänkt och presenterar ämnet och resultatet så tydligt som möjligt för läsaren. Tips! Planera rapportens struktur innan du börjar skriva och diskutera den med kollegor och handledare. Tänk på att aldrig sätta en ny rubrik eller underrubrik direkt efter en rubrik. Det ska alltid finnas brödtext mellan rubrikerna. 1. Inledning Inledningen är till för att låta läsaren sätta sig in i rapporten samt ge en kort orientering i ämnet. Här ska en tydlig problemformulering tillsammans med analys av problemet ingå samt textens syfte. I inledningen ska också en bakgrund till problemet ges. Även potentiella avgränsningar i arbetet ska beskrivas här. Underrubriker kan skapas om det bidrar till att rapporten får en tydligare struktur. Hela avsnittet bör skrivas så att det logiskt och motiverat leder fram till den frågeställning/problemställning som är aktuell för rapporten. 1.1 Problemformulering Rapporten ska innehålla en tydlig och väl genomarbetad problemformulering med en motiverad och aktuell forskningsfråga. Problemformuleringen ska också analyseras. Problemformuleringen och forskningsfrågan ska sedan som en röd tråd genomsyra hela rapporten. Tips! Skriv ner din forskningsfråga på en lapp som du sätter vid skärmen. På så sätt får du hjälp att alltid hålla forskningsfrågan i åtanke när du arbetar med rapporten. 2. Bakgrund I Bakgrunden ska läsaren ges förutsättningar att förstå innebörden av resterande rapport. Detta kan göras genom att beskriva State of the art (SOTA) och/eller State of Practice (SOP). Det är viktigt att ge en översikt om det aktuella forskningsläget för att sätta ämnet i ett större sammanhang samt visa att rapporten är orienterad i ämnet. I ett examensarbete ska alltid SOTA och/eller SOP finnas med i rapporten. Hur utförlig denna ska vara i andra typer av arbeten beror bland annat på arbetets omfattning. Fråga ansvarig lärare eller handledare. 4

5 SOTA är en översikt över var forskningsfronten står just nu. Man ska alltså kunna beskriva de forskningsområden som rapporten berör och kunna redogöra för vilken forskning som gjorts inom området. Hur djup redogörelsen görs beror på arbetets nivå och omfattning. SOP är en översikt över var best practice står just nu. Detta kan vara relevanta teknikområden som ett arbete berör, där man ska kunna redogöra för vilka tekniker som finns och hur dessa relaterar till varandra. I examensarbetet för Kandidatexamen, Masterexamen och Magisterexamen ska alltid en SOTA finnas med. I examensarbetet för högskoleingenjör samt civilingenjör ska en SOTA och/eller en SOP ingå. 3. Metod Här anges vilken metod som använts för att få fram det resultat som presenteras i rapporten. Valet av metod bör motiveras genom att diskutera varför just den metoden passar bäst i det aktuella sammanhanget och även gärna jämföras argumenterande mot andra vetenskapliga metoder som skulle kunna vara applicerbara på arbetet. Är både inledningen och metod korta så kan man ibland låta metod vara en underrubrik till inledningen. Man kan också ibland välja att slå ihop rubrikerna Metod och Material. 4. Teknisk beskrivning/design/teori Här ska relevant information om det faktiska arbetet som lett fram till resultatet beskrivas, sådant som inte hör till bakgrund eller metod men som inte heller är resultat eller diskussion. Huruvida detta avsnitt bör finnas med i det aktuella arbetet och vad som i så fall ska tas upp i avsnittet beror på vad arbetet handlar om samt vad som görs under arbetet. Detta kan med fördel diskuteras med handledaren. Innehåller i avsnittet bestämmer givetvis dess titel. Exempel på sådant som passar in i den här rubriken är designval med bakomliggande undersökningar eller teori, implementation som har betydelse för rapporten (tänk då på att inte lägga med större avsnitt av programkod), beskrivning av och information kring relevanta tekniska plattformar etc. 5. Resultat Denna rubrik ska innehålla resultaten av ditt arbete. Det är ytterst viktigt att fundera på hur man presenterar resultaten för läsaren så att de blir så tydliga som möjligt, är det till exempel via bilder, diagram, tabeller, text eller en kombination av dessa. Denna del bör vara presenterad på ett objektivt sätt, det vill säga utan att författaren tar ställning till om resultatet var bra eller dåligt, i linje med det förväntade etc. En diskussion av resultaten kan istället göras under rubriken Analys/Diskussion av resultat. I vissa fall kan det vara lämpligt att slå ihop själva presentationen av resultaten med diskussionen av denna. Detta är någonting som författaren måste ta ställning till. Om dessa slås samman är det fortfarande viktigt att ha en tydlig avslutning under egen rubrik då det annars kan uppfattas av läsaren som att rapporten inte är färdig. 5

6 Tänk på att detta är läsarens enda möjlighet att få reda på vad du kommit fram till i ditt arbete. 6. Analys/Utvärdering/Diskussion av resultat Under denna rubrik som kan heta både Analys, Utvärdering och Diskussion ska resultatet av ditt arbete analyseras, utvärderas och diskuteras. Du ska här dra slutsatser från ditt arbete och dess resultat. Här finns en möjlighet att hålla ett mer subjektivt resonemang än under övriga rubriker. Följande bör behandlas när resultaten diskuteras: Har metod och material påverkat resultaten och i så fall på vilket sätt. Hade den valda metoden några fördelar eller/och nackdelar? Vad betyder egentligen resultaten som presenterats? Vilka resultat är viktiga att ta i beaktning baserat på vilka tendenser som kan utläsas och hur ska de tolkas? Får resultaten några konsekvenser samt hur och vad de påverkar? Hur relaterar resultaten till aktuell forskning? Referenser till de studier som du jämför med måste anges, detta avsnitt kan med fördel läggas som en egen underrubrik. Tänk på att det är mycket viktigt att återknyta resultatet till rapportens syfte och diskutera huruvida de frågor som syftet ställer har besvarats. Med andra ord ska du här se till att knyta ihop säcken. 6.1 Relaterad forskning Här diskuteras vilken forskning som ligger mycket nära ditt eget arbete. Vad har relaterad forskning resulterat i, hur förhåller det sig till din egen forskning och ditt resultat samt hur påverkar dessa ditt arbete. Tänk på att inte diskutera relaterad forskning för yvigt utan begränsa det till viktiga slutsatser samt annan för ditt arbete nödvändig och intressant information. Glöm inte att ange referenser till de studier du diskuterar och jämför med. 7. Avslutning/Slutsatser Under rubriken Avslutning eller Slutsatser rundas rapporten av och läsaren påminns om de resultat som presenterats i rapporten genom att sammanfatta dessa. Om inte slutsatser av resultat och analys av dessa redan dragits ska det göras här. 7.1 Framtida arbeten Man brukar också i den avslutande delen blicka framåt och ge förslag på framtida forskningsområden och frågeställningar inom ämnet. 6

7 Anvisningar för rapportens avslutande del I rapportens avslutande del finns förteckning över referenser samt eventuella bilagor. Bilagor läggs allra sist i rapporten, alltså efter källförteckningen. Exempel på sådant som kan läggas som bilagor i rapporten är intervju- och enkätfrågor, detaljerade testdata, längre kodavsnitt som har betydelse för rapporten etc. Källförteckning De källor som använts till den vetenskapliga rapporten ska redovisas i en detaljerad lista. Genom att göra det visar du att du tagit del av relevant forskning inom området och ditt arbete får mer substans. Du ger också din läsare möjlighet att studera ämnet närmare och risken för att du råkar plagiera någon annan minskar. Sådant som räknas som allmänt känt inom det aktuella ämnesområdet behöver inte ha källor, du måste dock vara helt säker på att kunskapen är så allmänt känd inom området så att den delas av dina läsare för att kunna utelämna referens. Informationen måste fortfarande formuleras på ett självständigt sätt och får inte plagieras från någon källa. Du kan läsa mer om plagiat på raknas- egentligen- som- fusk Tips! Se till att du redan från början skapar dig ett eget referensbibliotek med tillräcklig information om varje källa du ska hänvisa till. Det finns också mycket användbara program för automatisk referenshantering som EndNote och Mendeley. Skrivs rapporten i LaTeX så tar BibTeX hand om referenserna på korrekt sätt så snart man har arbetet upp sitt BibTex- referensbibliotek. Källförteckningen, eller referenslistan som den också kan kallas, är en lista över de referenser som använts i rapporten. Informationen som anges om varje referens ska vara detaljerad och det ska utifrån denna vara lätt för läsaren att hitta referensen. Se information nedan om hur olika typer av referenser anges. Källor, alltså därifrån du hämtar informationen, kan vara tryckta eller elektroniska texter, till exempel böcker, artiklar och rapporter. Även intervjuer och filmer etc. kan användas som källor. När det gäller användning av webbsidor som källor, se avsnitt längre ner i denna rapportmall. I den text du skriver, alltså själva rapportens innehåll, måste du ange om någonting är hämtat från en källa. Det gör du med en texthänvisning som vävs in i texten. Hur texthänvisningen ser ut beror på vilken referensstil som används. Tänk på att texthänvisningen ska underlätta för läsaren att identifiera källan. Det är därför viktigt att texthänvisningarna utformas på ett konsekvent sätt genom hela rapporten. Tips! Via högskolebiblioteket kan du söka efter artiklar och böcker i en mängd olika databaser. Du kan också boka en bibliotekarie för att få hjälp med ditt informationssökande. 7

8 Referenser enligt IEEE- systemet Det finns ett antal olika referensstilar, några exempel är APA (Harvard), IEEE- systemet och Oxfordsystemet. IEEE- systemet används inom data- och elektroteknik. Referenser och anvisningar enligt IEEE används på följande sätt: I den löpande texten anges referenserna i texten med siffror/löpnummer i hakparenteser i den ordning de förekommer första gången i texten. Förekommer en referens flera gånger i texten ska den anges med samma löpnummer varje gång. Vill man ange en specifik del av referensen, till exempel ett kapitel eller antal sidors så anges dessa efter löpnumret inom hakparenteserna. Vill man ange flera referenser på samma ställe så anges dessa med sina respektive hakparenteser åtskilda med kommatecken. Är det en sammanhängande sekvens av löpnummer kan man ange dessa med bindestreck mellan den första och sista referensen i sekvensen. Se exempel nedan. Exempel Visionen om den semantiska webben formulerades ursprungligen av Tim Berners- Lee [1]. En av dess grundtankar är att informationen på webben inte bara ska kunna läsas och förstås av människor utan också av maskiner [2]- [5]. När maskiner kan tala med andra maskiner öppnas nya möjligheter för informationshanteringen. I sin vision [1, s. 3-4] nämner Berners- Lee bland annat hur handeln över nätet har mycket att vinna på den semantiska webben. En förutsättning för att visionen ska bli verklighet är att information på webben kodas enligt vissa överenskommelser [2], [4]. Källförteckningen som ligger sist i rapporten (dock innan bilagor) ska detaljerat förteckna allt publicerat material som använts i arbetet. Material som inte har hänvisningar i den löpande texten tas inte med här. Nedan följer några exempel på hur böcker, artiklar och webbsidor ska anges i källförteckningen enligt IEEE- systemet. För utförligare förklaringar och fler exempel finns IEEE Citation Reference på följande länk samt i IEEE Editorial Style Manual som kan hittas via följande länk Samtliga exempel på referenser är hämtade från Högskolan i Jönköping. Feb skrivhjalp/skriva- litteraturreferenser/ieee- systemet.html 8

9 Bok standardexempel [#] A.A. Författare/Redaktör, Titel: Undertitel, Upplaga (om ej första), Vol. (om verk med flera volymer). Utgivningsort: Utgivare, År, sidnummer (vid behov) Not: Alla betydelsebärande ord i titeln ska ha inledande versal. Undertiteln ska endast ha inledande versal i det första ordet. Bok [1] K. K. Breitman, M. A. Casanova och W. Truszkowski, Semantic Web: Concepts, technologies and applications. London: Springer, Bok i ny upplaga [1] G. Garner, Careers in Engineering, 3 uppl. New York: Mc- Graw- Hill, Bok med redaktör [1] H.A. ElMaraghy, Red., Changeable and Reconfigurably Manufacturing Systems. London: Springer, Bok med organisation som författare [1] Microsoft Corporation, MCSE training kit Microsoft SQL Server 2000 database design and implementation. Redmond: Microsoft Press, Kapitel i bok standardexempel [#] A. A. Författare, Titel på kapitel i boken, i Titel: Undertitel, Upplaga (om ej första), Vol (om verk med flera volymer), Redaktör, Red. Utgivningsort: Utgivare, År, sidnummer. Not: I kapitelnamnet är det endast det inledande ordet som ska ha inledande versal. Kapitel i bok med redaktör [1] W. Terkaj, T. Tolio och A. Valente, Focused flexibiblity in production systems, i Changeable and Reconfigurable Manufacturing Systems, H. A. ElMaraghy, Red. London: Springer, S E- bok standardexempel Samma principer som för tryckt bok gäller med tillägg om databasens namn sist i referensen. [#] A.A. Författare/Redaktör, Titel: Undertitel, Upplaga (om ej första), Vol. (om verk med flera volymer). Utgivningsort: Utgivare, År, sidnummer (vid behov). [Format Tillgänglig: Databasens namn. E- bok (från e- boksdatabas) [1] R. Lerdorf, P. MacIntyre och K. Tatroe, Programming PHP, 2 uppl. Sebastopol: O Reilly, [E- bok] Tillgänglig: Safari Books Online. Artiklar i tidskrifter standardexempel [#] A. A. Artikelförfattare, Artikelns titel. Tidskriftens Titel, vol. #, nr #, s. sidnummer, månad år. 9

10 Not: Endast artikelns titels inledande ord ska ha inledande versal. Samtliga betydelsebärande ord i tidskriftens titel ska ha inledande versal. Artikel i tidsskrift [1] Y. Zhong, B. Shirinzadeha, G. Alicib och J. Smith, An autowave based methodology for deformable object simulation, Computer- Aided Design. vol. 38, nr 7, s , juli Artikel i tidskrift, fler än sex författare [1] L. Yia et al., P- smart a virtual system for clothing thermal functional design, Computer- Aided Design. vol. 38, nr 7, s , juli Artiklar i e- tidskrift standardexempel Här gäller samma principer som för artiklar i tryckta tidskrifter men med tillägg om databasens och datum för hämtning av artikeln. [#] A. A. Artikelförfattare, Artikelns titel, Tidskriftens Titel, vol. #, nr #, s. sidnummer, månad år. [Format] Tillgänglig: Databasens namn, internetadress. [Hämtad: Datum]. Artikel i e- tidskrift [1] M. Cieslak, Life cycle costs of pumping stations, World Pumps, vol. 2008, nr 505, s , oktober [Online] Tillgänglig: ScienceDirect, [Hämtad: 13 mars, 2009]. Webbsidor standardexempel [#] A. A Författare, Webbsidans titel, Webbplatsens namn, Publiceringstid för webbsidan. [Format] Tillgänglig: Internetadress. [Hämtad: Datum]. Webbsida av organisation/företag [1] A. Rydqvist, Trångboddhet, Boverket, september [Online] Tillgänglig: =SV. [Hämtad: 13 mars,

11