Hur man skriver en rapport

Det här är en kort handledning om grunderna i att skriva en rapport. Det handlar främst om tekniska rapporter, som laborationsredogörelser och konstruktionsbeskrivningar.

Av Thomas Padron-McCarthy (thomas.padron-mccarthy@oru.se). Senaste ändring 24 november 2012. Filen heter http://www.aass.oru.se/~tpy/rapporter/rapporter.html.

De absoluta grunderna

Att skriva en rapport är en form av kommunikation. Kommunikation innebär att man vill framföra ett budskap av något slag till en mottagare. Det gäller all kommunikation, vare sig man skriver ett kärleksbrev, en förklaring till polisen om varför det inte var mitt fel att jag backade sönder busskuren, eller en laborationsredogörelse.

Men samma personer som skulle anstränga sig väldigt mycket för att få fram precis rätt budskap i ett kärleksbrev eller i ett brev till polisen, verkar ibland helt glömma bort att även en labbrapport² är kommunikation. Ibland tänker man nog inte närmare på vad labbrapporten egentligen ska säga, utan ser den bara som några hophäftade papper som man ger till läraren så att hon har något att skriva sin signatur på. Exakt vad som finns med i papperen spelar inte så stor roll, och ännu mindre hur man formulerar sig.¹

Det händer alltså att man slarvar med de här absoluta grunderna:

Det ska gå att läsa vad det står. Det kan man tycka är självklart, men som lärare har jag faktiskt fått in rapporter där delar av texten inte fick plats på papperets bredd, och därför helt enkelt är bortklippt. Jag har också (alltför många gånger!) fått rapporter där ett noga formaterat och indenterat datorprogram inte fick plats på papperet, och därför är omstuvat till ett enda sammelsurium.
Det ska gå att förstå orden. Det brukar de flesta lyckas med när de skriver rapporter på universitetet. Ibland är orden felstavade eller felaktigt särskrivna, men det brukar gå att luska ut vad som menas. Däremot är felen förstås ett hinder för att det ska gå lätt och snabbt att läsa, och de kan också göra ett oseriöst intryck på kunder och tilltänkta arbetsgivare.
Det ska gå att förstå meningarna. Det gäller att formulera varje mening så bra man kan, så att läsaren förstår precis vad man menar, och helst inte behöver sitta och anstränga sig för att göra det. Det här är svårare än att få de enskilda orden rätt, och till skillnad från med stavfel så får man inte någon hjälp av den stavningskontroll som brukar finnas inbyggd i olika ordbehandlingsprogram. Ta till exempel en mening som den här:
Det finns tre entitetstyper, barn, land, present och tre sambandstyper önskar, får, bor i.
Där har författaren antagligen inte funderat så mycket över bästa sättet att formulera sig, och har dessutom slarvat med kommateringen. Här är ett par förslag på hur man kanske skulle kunna skriva om exemplet:
Det finns tre entitetstyper ("barn", "land" och "present") och tre sambandstyper ("önskar", "får" och "bor i").

Det finns tre entitetstyper: Barn, Land och Present. De knyts samman av tre sambandstyper: Önskar, Får och Bor-i.

Rapporten måste alltså gå att läsa och förstå, men sen kommer något som brukar vara svårare, nämligen att välja ut rätt saker att säga, och säga dem i rätt ordning.

Rapportpyramiden: Förklaring i tre nivåer

Ett bra sätt att tänka är att en rapport ska innehålla tre nivåer. Det ska finnas en översiktlig eller övergripande nivå, som talar om för läsaren vad det hela handlar om och går ut på. Det ska finnas en detaljnivå som går in på vad man faktiskt gjort, och precis hur. Dessa två nivåer får inte vara frikopplade från varandra, utan det ska gå att följa resonemanget från den övergripande nivån ner till detaljerna:

Det är alltför vanligt att tekniska rapporter, som ska beskriva till exempel ett datorprogram eller en maskin, saknar de översta nivåerna. I stället för att förklara vad det är för maskin man byggt, eller vad det där datorprogrammet gör, börjar man genast förklara detaljerna. Det handlar om kugghjul eller C++-variabler redan från första meningen:

Även om man faktiskt har med den där översiktliga nivån, blir den ibland ett påhäng. Läsaren förstår vad rapporten handlar om, men sen när man kommer in på detaljnivån med kugghjul och C++-variabler, så är det svårt att se vad de där kugghjulen och C++-variablerna har med det hela att göra. Ja, kugghjulen sitter förstås i den där maskinen som rapporten beskriver, men var och varför?

Rapporten har en målgrupp

Om du skrivit ett datorprogram, och ska förklara vad det gör för din mormor (som vi här antar inte är särskilt van vid datorer), kommer du att förklara på ett helt annat sätt än om du ska förklara samma sak för en programmerare. Samma sak gäller när man skriver en rapport. Vad som bör finnas med i rapporten, och hur innehållet ska presenteras, beror på vem som ska läsa den.

När du ska skriva en rapport måste du alltså bestämma, eller ta reda på, vem eller vilka det är du skriver för. Kanske är det flera och mycket olikartade grupper, och då blir det förstås svårare. I värsta fall måste man kanske skriva flera olika rapporter. En bil kan till exempel beskrivas på helt olika sätt i reklamen som vänder sig till blivande köpare, i handboken som vänder sig till bilägaren, och i en serviceinstruktion som vänder sig till en bilmekaniker.

Skriv i rapporten vem den vänder sig till! Det sparar tid för läsaren, och det hjälper dig själv att fokusera på vad du ska skriva.

Målgruppen kan anges genom att man uttryckligen skriver vem man vänder sig till, exempelvis "företagsledningen på AB Maskindetaljer" eller "studenter i högre årskurs på programmet Datateknik". Ett annat sätt är att beskriva de förkunskaper och andra egenskaper som rapporten förutsätter att läsaren har.

Rapporten har ett syfte

En rapport har inte bara en målgrupp, utan det finns också en anledning till att just de personerna ska läsa just den där rapporten. Du kanske ska skriva en rapport som beskriver ett datorprogram för en grupp programmerare. Vad som ska stå i den rapporten beror förstås på syftet! Ska gruppen av programmerare bestämma om deras företag ska köpa programmet? I så fall vill man kanske ha med vad programmet kostar, och vilka alternativ som finns. Ska gruppen kanske ta över underhållet av programmet, och arbeta med att göra ändringar i det? I så fall är kostnaden för att köpa programmet förmodligen inte så intressant att ha med.

Skriv i rapporten vad den har för syfte! Det sparar tid för läsaren, och det hjälper dig själv att fokusera på vad du ska skriva.

Du måste själv förstå vad du skriver

En sak som kan vara värd att poängtera i sammanhanget är att du själv måste förstå vad du skriver. Om man inte själv förstår, utan bara upprepar ord som man har läst någonstans, så är det inte troligt att man lyckas förklara så att någon annan förstår.

Jag har fått rapporter där författarna uppenbarligen inte själva vet vad de menar, utan där de har satt samman ord och meningar från olika källor till något som blir helt obegripligt både för dem själva och för deras stackars läsare.

Man kan ibland ha med citat som man inte själv förstår, just för att visa att något är konstigt eller svårförståeligt, men då måste man (som alltid med alla citat) markera tydligt att det är ett citat, och ange källan. Man måste också tala om att man inte förstått vad som står, och ange orsaken till att man ändå har med det.

Men förutom det där med citaten så måste du förstå allt som du har skrivit. Det får inte finnas en enda mening, och inte ett enda ord, som du inte vet vad det betyder. Om någon frågar om något i rapporten så ska du alltså genast kunna förklara det.

Några andra tips

Förklara själva texten. Berätta för läsaren vad ni gör. Detta kallas ibland "meta-text", vilket betyder "text om texten". Till exempel kan man inleda ett kapitel med att berätta vad kapitlet handlar om, och hur man valt att lägga upp det. Om man har med en lista med punkter, så kan man börja med att förklara vad det är för en lista, hur man har sammanställt den, och varför den är med i rapporten.

Förklara mer. De allra flesta som inte är vana tekniska skribenter förklarar alldeles för kortfattat. Det märks ofta inte så tydligt på labbrapporter, för en labbrapport läses i de flesta fall bara av labbhandledaren. Labbhandledaren har läst tusen andra rapporter för precis samma labb, och är alltså mycket väl insatt i vad det borde stå. Hon brukar därför kunna gissa sig till vad som avses, hur kortfattat och kryptiskt det än är formulerat. Men det märks desto tydligare i exjobbsrapporter, där studenten gjort ett större, självständigt arbete, och där handledaren eller examinatorn inte vet nästan varje ord som ska stå. Författaren till rapporten vet ju själv vad som menas, och efter att ha jobbat med samma uppgift i flera månader känns allt enkelt och självklart, och kanske skäms hon för att förklara så uppenbara saker. Men redan handledaren, som ofta har avancerad kompetens inom precis rätt område, brukar ha stora svårigheter att förstå. I synnerhet gäller detta matematiska formler. De måste förklaras mycket ingående, steg för steg, för annars förstår läsaren ingenting.

Motivera designbeslut. Om du valt en viss typ av kugghjul, eller en viss typ av konstruktion i ett program, så är det ibland lämpligt att du talar om det i rapporten. Men vad många glömmer är att förklara varför man gjorde det valet. Kanske ska någon ta över ansvaret för maskinen du byggt, och får din konstruktionsrapport. Hon vet att det numera finns mycket mer slitstarka kugghjul än den typ du använt, och byter glatt ut kugghjulet mot den starkare modellen. Det är först när det nya kugghjulet smälter och maskinen går sönder som hon märker att just det kugghjulet blir mycket varmt, och därför måste man använda ett kugghjul med högre temperaturtålighet. Det var mycket riktigt därför du valde kugghjul som du gjorde, men det stod det inget om i rapporten.

Skriv rubrik, namn och datum på rapporten. Även om det är en preliminär version, som du till exempel lämnar in till din handledare för att få kommentarer, och även om det är en fil som aldrig är tänkt att skrivas ut på papper. Jag har många gånger letat i en bunt exjobbsrapporter efter vilken som är rätt rapport: vilken som är skriven av en viss exjobbare och vilken som är den nyaste versionen.

Skriv datum på ett sätt som inte går att missförstå. Kring år 2000, när tidningarna skrev att "2000-buggen" skulle få all världens datorer att krascha, var alla rapporter jag fick märkta med datum som hade årtal med fyra siffror. Nu verkar man ha glömt det igen. Som ett exempel fick jag på samma dag in tre rapporter daterade 03-09-04 och två rapporter daterade 04-09-03. Min personliga rekommendation är att man i en svensk text i stället skriver 4 september 2003.

Vad ska det stå i rapporten?

Den här handledningen handlar huvudsakligen om hur man skriver en rapport, så att den går lätt att läsa och förstå, och inte om vad man ska skriva. Men det finns ändå några grundläggande saker som är viktiga att ta upp.

Tänk på vad som är syftet med en teknisk rapport eller vetenskaplig artikel! En skönlitterär bok, en dikt eller en insändare i en tidning kan ge uttryck för åsikter, propagera för något, eller kanske bara underhålla läsaren en stund. Syftet med en teknisk rapport är sällan eller aldrig att uttrycka åsikter eller underhålla, utan det är att förmedla fakta som läsaren ska kunna förstå och lita på. Tänk därför på följande punkter:

Allt, precis allt, som står i rapporten ska gå att förklara. Ni måste veta vad ni menar med det ni skriver. Om ni skriver att ".NET Framework är en revolutionerande plattform för programutveckling" så måste ni kunna förklara exakt vad ni menar med "revolutionerande". Är det bara en floskel hämtad ur reklambroschyren, eller betyder det verkligen något?

Allt, precis allt, som står i rapporten ska gå att motivera. Om ni (fortfarande) skriver att ".NET Framework är en revolutionerande plattform för programutveckling", så måste ni inte bara kunna förklara exakt vad ni menar med "revolutionerande", utan ni måste också kunna motivera varför den är revolutionerande (vad det nu betydde).

Skilj på faktauppgifter och egna åsikter. I en lite större rapport behöver man ofta presentera både rena faktauppgifter, som till exempel en tabell med uppmätta temperaturer, och slutsatser eller åsikter. Det är viktigt att man tydligt skiljer på dessa olika saker. I en exjobbsrapport eller en forskningsartikel brukar man ha ett avslutande kapitel som kan heta "Diskussion", där man lägger fram sina slutsatser och åsikter. Tänk på att slutsatserna och åsikterna inte får vara löst tyckande, utan de ska ha stöd i fakta och ska gå att motivera, precis som det står i punkten ovan.

Skilj på era egna resultat och saker som ni har hämtat från andra. Om ni skriver i rapporten att ".NET Framework är en revolutionerande plattform för programutveckling", så är det förmodligen synnerligen intressant för läsaren att veta om ni kommit fram till det som resultat av en egen undersökning, eller om ni hämtat det ur en reklambroschyr från Microsoft. Markera därför alltid tydligt vad som är citat, och ange alltid vilka källor ni använt. Även om ni inte citerar direkt utan har sammanställt, sammanfattat eller formulerat om, måste det framgå varifrån uppgifterna kommer.

Läs mer

Det finns förstås mer att tänka på, förutom de grunder jag har tagit upp här. (Referenslista! Figurtexter! Innehållsförteckning! Sammanfattning!) För detta hänvisar jag dock till andra handledningar. Det finns flera olika som man kan hitta på webben. Exempel:

Magnus Merkel et al: Lathund för rapportskrivning, Linköpings universitet, 2011 (PDF-dokument)

Fotnoter: Några vanliga frågor

¹Fråga:
Det står att ibland tänker man inte närmare på vad en labbrapport egentligen ska säga, utan ser den bara som några hophäftade papper som man ger till läraren så att hon har något att skriva sin signatur på. Men en labbrapport är ju faktiskt till för att läraren ska skriva sin signatur på den. Läraren kan redan allt som står i rapporten, och ska bara kolla att studenten har gjort rätt. Varför ska man krångla med budskap och framställning? I själva verket skulle det ju räcka om studenten bara visade datorprogrammet, eller vad det nu är, för läraren, och läraren kollade att det var rätt.

Svar:
En universitetsutbildning ska ge dig många kunskaper och färdigheter, och en av dessa är att kunna kommunicera. Du ska kunna göra presentationer av olika slag, och du ska kunna skriva rapporter och andra texter. Därför måste man öva på rapportskrivning, bland annat när man skriver labbrapporter. Som avslutning på många utbildningar gör du ett examensarbete eller skriver någon annan typ av större uppsats, och examensarbetet innebär förstås att du får öva på rapportskrivning. Men om examensarbetet är den första "riktiga" rapport man skriver, så måste man börja med de absoluta grunderna där, och man hinner kanske aldrig komma fram till de svåra sakerna, eller bli bra på dem.

²Fråga:
Du skriver om "labbrapporter". Ska man inte skriva "lab", med ett B? Det är ju en förkortning av "laboration", som inte stavas "labboration".

Svar:
Det finns olika åsikter i den här frågan, och min åsikt är att man ska skriva "labb" och inte "lab". "Labb" är ju ett eget ord, inte bara en förkortning av "laboration". Det märks till exempel på att det har ett annat böjningsmönster än "laboration". Det heter "en laboration, flera laborationer", men "en labb, flera labbar". Inte "flera labber". Det är ett nytt ord, och man ska förstås inte stava det på ett sätt som känns konstigt och främmande i språket. ("Har du labat klart med laben än, Laban?")