Jonas Stålhand Mekanik/IEI Bedö mning av rapporter Allmänt En rapport skall ha god läsbarhet. Med detta menas att det finns en inneboende logisk struktur hos texten, att texten är sammanhängande och att ingen del är oväsentlig i förhållande till sammanhanget eller helheten (koherens). Den inneboende logiken innebär till exempel att läsarens förväntningar på vad som avhandlas i nästa steg också stämmer överens med rapporten. Koherensen implicerar att texten inte är onödigt lång utan är väl avpassad till uppgiftens och/eller målgruppens krav. Ett vanligt fel är att författaren tar med för mycket i rapporten istället för att exkluderar sådant som ej bidrar till sammanhanget. Därigenom signalerar författaren brister i sin förmåga att urskilja det viktiga. Läsbarheten påverkas också implicit av språket i rapporten. Detta skall vara korrekt, fackmässigt och enhetligt. Texten också vara redaktionellt genomarbetad. Ett korrekt fackmässigt språk skapar trovärdighet hos läsaren och visar på fackmässig mognad hos författaren. Även om mindre språkliga fel passerar utan att störa läsaren är grammatiska regler och rättstavning mycket viktiga för läsbarheten. Oklarheter kring textens betydelse uppstår lätt vid felaktig satsbyggnad, syftningsfel eller brister i skiljetecken (innefattande punkt, komma, och kolon). Felaktig kommatering och för korta/långa meningar hindrar flödet och gör texten onödigt svårläst. Slutligen skall texten vara redaktionellt genomarbetad. I denna process ingår att åtgärda felaktig upprepning av bokstäver, ord och meningar (dittografi), skapa enhetligt språkbruk vid flera författare, rättstavning, med mera. Försättsblad En klar och tydlig rubrik. Eventuell bild skall vara relevant och beskrivande. Försättsbladet skall beskriva arbetet på ett klart och tydligt sätt. Notera att försättsbladet också fungerar som en reklampelare – en god utformning väcker intresse och skapar positiva förväntningar. Av samma skäl kan förväntningarna sänkas, till exempel genom en felstavad titel. 1 Jonas Stålhand Mekanik/IEI Förord Förordet är den enda subjektiva delen av rapporten och påverkar därför omdömet ganska lite. Det är dock värt att trycka på vikten av tacka de som bidragit och att stava person-, företags- och organisations-namn rätt; slarv i denna detalj kan irritera den person som bedömer författarens prestation. Sammanfattning En god sammanfattning är ett kondensat av det viktigaste i rapporten. Sammanfattningen är tillsammans med försättsbladet det första en presumtiv läsare stöter på och dess syfte är att beskriva hela arbetet på ett kondenserat sätt. Det är därför viktigt att sammanfattningen är logiskt strukturerad, tydlig, välskriven och inte för omfattande. Tänk på att sammanfattningen kan användas som beslutsunderlag i en ledningsgrupp (där deltagarna inte har tid att läsa hela rapporten). Beskrivningen av frågeställningen, resultatet och rekommendationer är därför viktiga tillsammans med den trovärdighet författaren förmedlar. Avseende omfattningen gäller ofta att regeln att ”less is more”. Innehållsförteckning En god innehållsförteckning skall vara logisk och ge översikt samt struktur åt rapporten. Utifrån en god innehållsförteckning bör läsaren kunna skapa sig en uppfattning om arbetets struktur och hitta de delar som intresserar honom/henne. Inledning (inklusive bakgrund) En inledning skall ge bakgrund, syfte/mål och avgränsningar för arbetet. Utöver detta skall en inledning även beskriva hur uppgiften skall lösas. I bakgrunden ingår både att beskriva problemet och att beröra vad som tidigare gjorts inom fältet avseende metoder och resultat. Denna beskrivning utgör sedan grunden för att motivera den valda lösningsmetoden samt arbetets avgränsningar. Referenser till litteraturen och andra arbeten utgör en viktig del av inledningen. 2 Jonas Stålhand Mekanik/IEI Metod Beskrivningen av metod och teori skall vara korrekt, fullständig, logisk strukturerad och lättfattlig. Alla nödvändiga delar i skall vara inkluderade samt beskrivna och motiverade på ett adekvat sätt utifrån den tänkta målgruppen och den givna uppgiften. Målet med denna del av rapporten är att beskriva metod och teori på ett sådant sätt att en utomstående kan värdera rimligheten i arbetet och vid behov återupprepa det. Detta innebär, bland annat, att det är viktigt att antaganden är tydligt beskrivna och gärna motiverade. Däremot behöver inte allt beskrivas; ekvationer, samband och teorier som är allmänt vedertagna inom fältet kan användas utan härledning. Metoddelen skall stå för sig själv och vara begriplig utan att läsaren måste konsultera bilagor och/eller annan litteratur. Notera dock att mindre väsentlig delar som upptar stor plats med fördel kan lyftas ut och placeras i en bilaga eller hänvisas till litteraturen Resultat Resultatdelen skall endast innehålla relevanta resultat och dessa skall presenterade på ett för uppgiften beskrivande och tydligt sätt. Med relevanta resultat avses de diagram, figurer, grafer, ritningar, tabeller, eller liknande, som krävs för att nå uppsatta mål och besvara den övergripande frågeställningen i arbetet. Resultaten skall därför spegla de förutsättningar som sattes upp i inledningen. Precis som för metoddelen bör läsaren kunna förstå resultaten utan att först läsa hela rapporten. Tydliga och beskrivande diagram, figurer, grafer, och tabeller är därför av största vikt. Gör gärna något med resultaten utöver det uppenbara om det finns utrymmer. Exempel på detta kan vara att använda statistiska metoder för att studera utfallen, göra feluppskattningar eller störningsanalyser. Personligen föredrar jag att resultatdelen är fri från diskussion och att värderingar, men detta kan variera lite beroende på ämnet och omständigheterna. Naturligtvis hindrar detta inte författaren från att poängtera samband och göra förtydliganden som kan identifieras ur resultaten. Trots att resultatdelen skall stå för sig själv kan omfattande resultat, till exempel, stora ritningar, underlag till ekonomiska kalkyler, tabeller med rådata från mätningar, och liknande, med fördel placeras i en bilaga. 3 Jonas Stålhand Mekanik/IEI Diskussion I en diskussion skall relevanta aspekter av arbetet granskas kritiskt, speciellt avseende metod och resultat. Insikter, reflexioner och rekommendationer baserade på författarens erfarenheter från arbetet bör inkluderas. Diskussionen bör knyta an till både metod- och resultatdel. Var noggrann med att värdera validiteten hos den valda metoden och resultaten. Hur fungerade den valda metoden? Hade andra (relevanta) metoder lett till ett annat resultat? Hur har gjorda antaganden och förenklingar påverkat resultatet? Vilka osäkerhetsfaktorer finns och hur stora är de? Tänk också på att diskussionen är den del av rapporten där ”praktisk” erfarenhet och kunskap överförs till läsaren, till exempel vilka analysmodeller fungerar och varför, hur en CAD-modell skall meshas, vilka FEM-element som fungerar bäst och hur givare skall placeras för att få bästa mätsignal. Dessa insikter kan spara mycket tid och frustration eftersom ”hjulet inte behöver uppfinnas på nytt”. Var noggrann med att få med det som är viktigt och bidrar till arbetet och beskriv detta på ett tydligt men kortfattat sätt; ingen gillar att läsa långa utläggningar om en detalj som kan beskrivas i några meningar. Slutligen skall också diskussionen innehålla en konklusion kopplad till frågeställning och mål som behandlades i inledningen - knyt ihop säcken! Bilagor Bilagor skall vara fristående från rapporten och innehålla sådant material som inte passar i rapportens flöde. I bilagor placeras material som upplevs mindre relevant men inte kan exkluderas av något skäl eller material har stort omfång. Exempel på det första fallet kan vara bakgrundsinformation eller härledningar som betraktas som allmänt vedertagna inom ett fält men behövs på grund av att rapporten vänder sig till läsare utanför detta fält. Exempel på det andra fallet kan vara konstruktionsritningar och interpolationstabeller. En interpolationstabell eller liknande kan också placeras i resultatdelen om den inte är för omfattande, men många gånger är det bättre att använda ett diagram eller en graf i resultatdelen för överskådligheten och placera den exakta interpolationstabellen i en bilaga. 4