MINIMIKRAV VID RAPPORTSKRIVNING

Transkript

1 MINIMIKRAV VID RAPPORTSKRIVNING Denna kortfattade beskrivning består av två delar. En allmän del kring formatering etc och en del som tar upp viktiga aspekter i respektive rapportavsnitt. För en fylligare beskrivning hänvisas till Att skriva och presentera rapporter, Tekniska högskolan, Umeå universitet. Allmänt Alla figurer, tabeller, ekvationer, referenser och bilagor ska omnämnas i rapportens brödtext. Dessutom ska alla faktauppgifter, som inte är rapportskrivarens egna, ha en referens till källan som ska finnas i referenslistan. Enheter - Mellan siffrorna och enheten ska det vara ett blankslag (med undantag för C) - Konsekvent skrivning av % (OK både med och utan blankslag, men inte blandat) - Observera att stor/liten bokstav i enheter betyder olika och ska vara korrekt Exempel: Rätt: 16 m 2 32 C W/m. K Fel: 16m 2 16 M 2 32 C W/mK Sidhuvud - Om sidhuvud används ska dess typografi avvika från brödtexten och vara högst två rader. - Kapitelrubrik, rapporttitel eller författarnamn kan stå i sidhuvudet dock inga logotyper. - Ett tips är att avsluta sidhuvudet med en tom rad eller en tunnlinje, så att det inte kan flyta ihop med brödtexten. - Datum och versionsnummer kan vara bra i arbetsversioner, men ska tas bort i slutversionen. Sidnummer - Sidnummer på alla sidor utom första sidan (förslagsvis mitten nedtill) Rubriker - Följs alla rubriker av brödtext? Direkt efter en rubrik bör det vara brödtext; inte tabell, figur eller ytterligare en rubrik (=tomt kapitel). - Är rubrikerna tillräckligt informativa? En rubrik bör rymmas på en rad, men en rubrik som endast består av ett ord är ibland onödigt kort. Styckeindelning Välj antingen indrag eller tom rad var konsekvent.

2 Figurer - Enheter på figurens axlar skall tydligt framgå. - Alla figurer ska vara numrerade och har en figurtext som står nedanför figuren. - Figurtexten (1-3 meningar) förklarar figuren så att man förstår hur figuren ska tolkas. - Alla lånade figurer ha en hänvisning till källan som ska finnas i referenslistan. - Oftast bör man ta bort yttre ram, figurtitel och stödlinjer som lätt följer med från Excel eller Matlab, då beskrivningen ska ligga i figurtexten under figuren. - Figurtexterna rekommenderas ha samma typsnitt, men mindre font som avviker från brödtexten, så att läsaren inte läser figurtexten av misstag mitt i brödtexten. - Till varje figur ska det finnas en hänvisning i brödtexten före figuren. - Alla figurer ska vara begripliga i gråskala, undvik alltså bara färg som markering - Ha inte flera nummerserier som Diagram, Bild, Foto, Graf, Figur alla dessa kallas Figur. - Stämmer figurnumreringen? - Observera att numreringen inte är en del av beskrivningen i tabellrubriker och figurbeskrivningar. Exempel: FEL: Korrekt: Figur 1 visar lönsamheten och den årliga vinsten. Figur 1. Lönsamhet och årlig vinst för de olika alternativen. Tabeller - I princip samma som för figurer, men tabelltexten ska stå ovanför tabellen. - Undvik rutiga tabeller rekommendation tabellformat Enkel tabell 1 Ekvationer - Är alla ingående storheter definierade och enheter angivna? - Ekvationer numreras för att lättare kunna hänvisas till i brödtexten. Hänvisning till referenser Tips: använd Words inbyggda referenshantering (Referenser/Infoga källhänvisnings / lägg till ny källa, ej att förväxla med fotnot) - Kontrollera att det finns källhänvisningar överallt där det bör göra det. - Alla källhänvisningar är skrivna på samma sätt. - Inga hänvisningar i rubriker. Källhänvisning ska anges efter den information man vill styrka. - Källhänvisning för figurer görs sist i tillhörande figurtext. 2

3 Rapportens olika delar Nedan tar vi upp synpunkter på respektive del av rapporten. Indelningen av rapporten måste dock inte slaviskt följa denna indelning. Titelsidan - Är titeln informativ och relevant med avseende på rapportens innehåll? - Finns författare, korrekt versionsdatum? Sammanfattning - Högst en sida (en halv sida är att föredra) - Väsentligaste ur hela rapporten, i huvudsak med samma upplägg som rapporten, dvs inledning/syfte/resultat/slutsats. - Gärna locka till att läsa resten av rapporten - Ska inte innehålla något utöver resten av rapporten Abstract - Engelsk översättning av sammanfattningen, dock ej ordagrann. - Är facktermer korrekt översatta? Inga svengelska gissningar. Enbart google-översättningar är inte acceptabelt. Innehållsförteckning - Ska bara innehålla de rubriker som ligger efter innehållsförteckningen. Så innehållsförteckningen ska inte börja med Sammanfattning och Innhållsförteckning - Se till att bilagorna inte presenteras som de övriga kapitlen, dvs de ska vara utan löpnummer. Inledning - Sätter in arbetet i ett större sammanhang - Logiskt och motiverat leda fram till problemställningen som arbetet behandlar - Översikt av närliggande tidigare arbeten, med referenser till dessa. - Arbetets roll i ekonomisk, social och ekologisk hållbar utveckling i tillämplig omfattning? - Avslutas med en naturlig övergång till syftet/målet Syfte / Målsättning - Kort, tydligt, rakt på sak - Mål ska vara mätbara. Teori / Teoretisk bakgrund Eventuell teori som behövs för att förstå rapporten. Överdriv inte detta avsnitt utan ta bara med sådant som målgruppen behöver för att kunna förstå metod, resultat och diskussion. 3

4 Metod / Genomförande - Detaljerad presentation? - Presentation av beräkningar, förenklingar, antaganden? - Motiveras antaganden och förenklingar? - Beskrivs eventuella instrument och mätutrustning? - Beskrivs metoden tillräckligt för att någon annan ska kunna upprepa det? - Motiveras val av metoder och teknik tydligt? Resultat - De viktigaste resultaten från arbete presenteras i resultatdelens brödtext. - Motivera/beskriv kortfattat men klart och tydligt hur de viktigaste resultaten läses av från tabeller och figurer. Sträva efter att göra beskrivningen logisk och tydlig så att det upplevs som objektivt. - Använd figurer och tabeller på ett aktivt sätt som belägg för beskrivningar i brödtexten, dock inte endast se figur. Diskussion - Diskuteras resultaten och konsekvenserna av vald metod, förenklingar och antaganden? - Jämförs resultaten med andra arbeten och källor (med referenser till dessa)? - Föreslås förändringar/förbättringar? - I detta avsnitt kan rapportskrivaren framföra egna tolkningar och reflektioner. Slutsatser - Med utgångspunkt från resultat och diskussion dras slutsatser. - Återknyts det till syftet? - Har syftet uppfyllts? - Gärna förslag på framtida arbete som syftar till vidareutveckling inom det valda området. Referenslistan Tips: använd Words inbyggda referenshantering. Infoga referenslistan med (Referenser/ Litteraturförteckning/Infoga litteraturförteckning, ej att förväxla med fotnot) - Är referenserna sorterade? (rekommendation ISO-690 numerisk) - Används alla referenserna? - Saknas någon referens i referenslistan? - Är alla spårbara? (Författare, årtal, titel, förlag, ISBN-nummer, länk) - Undvik att dela upp i underlistor 4

5 Bilagor - I bilagorna kan man lägga sådan information som blir för tungt att lägga i själva rapporten. Viktigt dock att inte dränera rapporten på centrala figurer och tabeller. Varje bilaga ska ses som ett fristående dokument vilket kräver rubrik och tydlig förklaring av innehållet. T ex krävs nya definitioner av parametrar. OBS bilagorna har inte löpnummer från övriga kapitel. -Är bilagan hänvisad till i rapporten? 5