Sammanfattning av boken Writing for Science and Engineering Av Johan Gellner, d96-jge@nada.kth.se, 2002-04-16 Översikt Dessa blad sammanfattar de viktigaste delarna av boken Writing For Science and Engineering Papers, Presentations and Reports av Heather Silyn-Roberts (280 sidor, förlag Butterworth- Heinemann, år 2000, ISBN 0-7506-4636-5). Boken är bred i sin uppläggning och tar upp det mesta från brevskrivning och faxmeddelanden via rapporter för tekniska examensarbeten och doktorsavhandlingar till muntliga presentationer och konferenser. Kort sagt en bok om hur man på olika sätt kommunicerar teknik och naturvetenskaplig forskning. Boken är en receptbok med tydliga steg-för-steginstruktioner för hur man skapar ett dokument av en viss typ. I denna sammanfattning skall vi koncentrera oss på de delar som beskriver hur man lägger upp och skriver rapporter för tekniska och naturvetenskapliga examensarbeten. Ungefär hälften av bokens textmassa är relevant för denna typ av rapporter. Boken tar även upp hur man gör muntliga presentationer och korrekturläser, vilket ju är relevant för examensarbeten vid KTH. Vi tar dock inte upp dessa avsnitt i denna sammanfattning. Boken är på engelska och är sålunda mest relevant för dokument skrivna på just engelska. Genomgående i denna sammanfattning ges därför de engelska orden för vanliga kapitelrubriker och termer inom parentes direkt efter de svenska orden. Att strukturera en teknisk rapport Rapportens övergripande struktur För det första är det viktigt att ha rätt inställning till det som skall skrivas. Den grundläggande frågan här är vem man skriver för. Man skall inte skriva för sig själv utan för sina läsare. Detta betyder att man skall ställa frågan Hur skall jag bäst strukturera mitt material för att läsaren bäst skall förstå innebörden av mitt arbete?. Ställer man istället frågan Hur vill jag presentera mitt material? är man troligen ute på hal is eftersom man då betonar sina egna behov och inte läsarnas. Man skall alltså sträva efter att skriva utifrån läsarnas synvinkel. Efter att man insett detta är det dags att välja huvudrubriker för sitt dokument. Många huvudrubrikers namn och ordningsföljd är mer eller mindre standardiserade och förändras sällan från ett dokument till ett annat även om dokumenten behandlar olika ämnen. Särskilt rubrikerna i början och slutet av ett dokument tenderar att vara identiska över olika dokument. Dessa vanligt förekommande rubriker är: Titel (Title) Sammanfattning (Abstract) Innehållsförteckning (Table of Contents) Ordlista (Glossary of Terms) Introduktion (Introduction) 1
Teoriavsnitt (Theory) Litteraturstudie (Literature Review) Huvuddel Resultat (Results) Diskussion (Discussion) Slutsatser (Conclusions) Rekommendationer (Recommendations) Referenser (List of References) Bibliografi (Bibliography) Appendix (Appendices) Huvuddelen rubriksätts på ett sätt som passar det ämne som avhandlas. En vanlig huvudrubrik i detta sammanhang är Materiel och Metoder (Materials and Methods). Att hjälpa läsaren att navigera genom dokumentet Det är viktigt att läsaren ständigt ledsagas genom dokumentet. Studier visar att den mänskliga hjärnan är i behov av kortfattade översikter och sammanfattningar av det som komma skall för att bättre kunna ta till sig materialet. Detta betyder att man skall tänka på varje del av dokumentet som en diamant [Figur 1]. Detaljnivån i början är låg (vilket motsvaras av diamantformens smala spets) för att sakta men säkert öka när huvudinformationen presenteras (motsvarande diamantens breda mittsektion). Mot slutet avtar detaljnivån återigen vilket motsvaras av en kortfattad slutsats av det som sagts. Sammanfattning Huvudstoff Slutsatser Figur 1. Varje del av dokumentet ses som en diamant där de smala ändarna i topp och botten motsvarar korta summeringar med låg detaljnivå medan mittsektionen motsvarar huvudstoffet. Detta diamant -koncept bör appliceras på alla nivåer i dokumentet. På översta nivån, som representeras av dokumentet i sin helhet, realiseras detta genom abstract-huvuddel-slutsats strukturen där alltså abstract och slutsatsen är översiktliga, korta avsnitt med låg detaljnivå som har till uppgift att summera den detaljrika huvuddelen. Detta koncept appliceras sedan på varje enskilt kapitel och avsnitt av rapporten. D.v.s., varje enskilt kapitel skall börja med en sammanfattning och sedan avslutas med en kort slutsats. Det är viktigt att det som skrivs i dessa sammanfattningar (gäller alltså även abstract!) skall vara informerande (informative) och inte beskrivande (descriptive). Detta innebär att man mycket kortfattat skall återge vad som faktiskt står i rapporten/kapitlet och inte beskriva hur detta stoff presenteras (som en slags guide till strukturen hos en rapport). Om man alltså skriver saker som Därefter beskrivs, Sedan diskuteras, Kapitlet ger en överblick över är man alltså fel ute. Istället skall man sikta på att rakt upp och ned ge en miniatyrbild av den faktiska information som finns i rapporten/kapitlet. T.ex.: Kolmonoxidsnivån 1,5 meter ovanför körbanan uppmättes under rusningstrafik. Mätningarna gav vid handen att 2
Den tekniska rapportens delar De delar/huvudrubriker som listades ovan beskrivs i det följande. Titel (Title) Titeln har till uppgift korrekt beskriva dokumentets innehåll med så få ord som möjligt. Den skall ej vara för generell, ej heller för specifik. Titelsidan Titelsidan skall vara enkel med titeln centrerad högst upp. Den skall också innehålla annan information som t.ex. författarens namn, institution och datum. Sammanfattning (Abstract) Sammanfattningen har till uppgift att ge läsaren en miniatyrbild av hela dokumentet så att denne snabbt kan avgöra om innehållet är relevant för honom/henne. Vanliga delar i en sammanfattning är: Ett uttalande om placerar dokumentet i sitt rätta sammanhang. Metod som använts. De viktigaste resultaten och observationerna. De viktigaste slutsatserna. De viktigaste rekommendationerna. Som nämndes tidigare skall innehållet i sammanfattningen vara informativt, d.v.s. skall innehålla faktisk information och inte en beskrivning av dokumentets struktur. Längd: ungefär 300 ord för ett längre dokument. Innehållsförteckning (Table of Contents) Innehållsförteckningen listar alla huvudrubriker och underrubriker och anger motsvarande sidnummer. Svårigheten är ofta att få en bra layout och att se till att sidnumrena hålls uppdaterade men dessa problem kan man ofta undvika genom att använda något verktyg (t.ex. Microsoft Word eller LaTeX, förf. anm.). Numreringen av rubriker och underrubriker sker efter en allmänt accepterad standard som använder decimalsystemet. Normalt tas inte de stycken som föregår innehållsförteckningen med (t.ex. Abstract). Ordlista (Glossary of Terms and Abbreviations) Ordlistan förklarar vissa termer, förkortningar och annat som ej antas vara självklara för de tilltänkta läsarna. Kan användas för att klart definiera vad man själv menar med vissa begrepp som annars kan vara oprecisa och tvetydiga. Denna del placeras vanligen före introduktionen men kan också placeras sist i dokumentet. Introduktion (Introduction) Introduktionen skall: klart definiera syftet med studien; ge nödvändig bakgrundsinformation; ge en genomgång av den nuvarande kunskapsnivån inom området (state of knowledge); peka på samband, motsägelser och tvetydigheter hos denna kunskap samt ge en beskrivning av dokumentets struktur (för längre dokument). 3
Teori (Theory) Teoriavsnittet tar upp teoretisk bakgrundsinformation om så är nödvändigt. Denna information skall vara riktad till någon som har en allmän förståelse för ämnet men saknar nödvändig detaljkunskap. Avsnittet skall hållas så kort som möjligt. Litteraturstudie (Literature Review) Litteraturstudien har till uppgift att visa att författaren har god allmän kunskap om sitt ämne. I detta avsnitt skall därför ingå en genomgång av olika forskningsområden och tekniker som är relevanta för ämnet. Det skall också ge en historisk överblick, visa på svagheter, motsägelser och tvetydighet hos relaterad forskning samt visa hur det egna arbetet kommer att kunna bidra till området i stort. En bra litteraturstudie skall inte bara vara en torr genomgång av vad som gjordes av vem, utan skall också innehålla egna kommentarer angående relevans och kvalitet av det som gjorts tidigare. Svårigheterna med en litteraturstudie är ofta att hantera den stora mängd information som kanske finns tillgänglig eller i andra fall att hantera en total avsaknad av information. Andra svårigheter är att avgöra vilken litteratur som är relevant och att ha den disciplin som krävs för att kontinuerligt läsa om saker man redan läst, vilket är viktigt för att hålla kunskapen aktuell för sig. Vad gäller rapporter för examensarbeten är det viktigt att komma ihåg att den första litteraturstudien som görs mycket sällan är tillräckligt bra för att ingå i den slutliga rapporten. Den slutliga litteraturstudien kommer troligen att vara mycket annorlunda än den initiala eftersom kunskapen om området kontinuerligt förbättras och nya dokument ideligen påträffas. Metod (Materials and Methods) Metodkapitlet beskriver det arbete som gjorts. Utformningen beror mycket på vilket ämne som avhandlas men viktigt är att andra forskare eller tekniker skall kunna återupprepa arbetet/försöken med hjälp av den information som finns här. Resultat (Results) Resultatkapitlet presenterar resultaten av arbetet men utan att diskutera dem. Detta avsnitt skall ses som dokumentets mest centrala och skall visa den nya kunskap som man kommit fram till. Det är viktigt att inte vara för detaljerad i detta kapitel. Även om arbetet har gett upphov till stora mängder data är det inte troligt att allt detta skall ingå i presentation av resultaten. Sekundär data kan istället lämpligen förpassas till ett appendix. Det är viktigt att man också presenterar eventuella resultat som motsäger den hypotes man arbetat efter. Man skall alltså absolut inte försöka dölja negativa och motsägelsefulla resultat! Diskussion (Discussion) Diskussionskapitlet är aningen svårt att definiera och exakt hur det ser ut beror på ämnets natur. En tumregel är dock att diskussionen skall förklara hur de presenterade resultaten stöder ens egna svar på det eller de problem som ställdes upp i början av arbetet. Man skall alltså i detta kapitel en gång för alla besvara den ursprungliga problemställningen och dessutom dra slutsatser därav. Det är viktigt att man i detta kapitel verkligen diskuterar och inte bara repeterar det som redan sagts. Det är också önskvärt om man sätter sina resultat och sin metod i relation till vad andra tidigare gjort inom området. Man kan också notera eventuella begränsningar hos den använda metoden. 4
När man presenterar och diskuterar sina resultat och slutsatser skall man tänka på att använda lagom starka ord. Ett ord som bevisa (prove) är ofta för starkt medan meningar som innehåller alltför många ord av typen kanske, (maybe) antagligen (probably) eller möjligen (possibly) kan vara för svaga. En bra nivå kan var att använda ord som indikerar (indicates), stödjer (supports) eller implicerar (imply). Slutsatser (Conclusions) Slutsatskapitlet sammanfattar de viktigaste slutsatser man dragit. Detta kapitel agerar motpol till dokumentets inledande sammanfattning (abstract). Genom att läsa sammanfattningen och slutsatserna skall läsaren få en god överblick över arbetet och dess resultat. Notera att alla slutsatser som presenteras i detta kapitel måste vara presenterade tidigare i dokumentet och att det sålunda är oacceptabelt att skapa nya slutsatser ur tomma luften. Vidare skall slutsatserna var konkreta och inte allmänt hållna eller vaga. Punktlistor eller numrerade listor kan vara ändmålsenliga när man sammanfattar sina slutsatser. De viktigaste slutsatserna ges alltid först. Rekommendationer (Recommendations) Rekommendationer är förslag på en serie konkreta åtgärder som följd av de dragna slutsatserna. Förslag för viderutveckling (Suggestions for Future Research) Kapitlet om vidareutveckling ger förslag på omedelbara och långsiktiga förbättringar och utökningar av arbetet. Referenser (List of References) I referenslistan placeras alla källor som är direkt refererade i texten. Det finns två typer av refereringssystem: Författare-datumsystemet (Harvardsystemet). I den löpande texten utformas referensen som en kombination av det refererade verkets författares efternamn och dess publiceringsår. Exempel: (Brown, 1999). I själva referenslistan listas sedan varje verk i alfabetisk ordning efter dess författares efternamn. Det numeriska systemet. Här tilldelas varje refererad källa ett unikt nummer. I den löpande texten skrivs sedan numret inom hakparenteser, t.ex. [5] eller som upphöjd text: 5. I listan med referenser listas sedan källorna ej i alfabetisk ordning utan i nummerordning. Det finns en uppsjö regler för hur själva referenslistan skall utformas varav den viktigaste kanske är att utformningen skall vara konsekvent. Observera också att fotnoter inte används i tekniska och vetenskapliga dokument. Bibliografi (Bibliography) Bibliografin listar verk och källor som ej har refererats i texten men som ändå konsulterades under arbetets gång. Detta kapitel förekommer sällan i tekniska och vetenskapliga rapporter som nästan uteslutande använder referenslistor (List of References) som beskrevs ovan. Appendix (Appendices [plural], Appendix [singular]) I appendix placeras exempelvis komplex data, stora diagram och programkod. Alla appendix skall ha en titel, vara numrerade samt vara refererade i texten. 5
Övrigt Illustrationer Det är alltid viktigt att fråga sig om en illustration verkligen är motiverad i ett givet sammanhang. I många fall kan illustrationer vara överflödiga men när en illustration väl används skall man tänka på att den skall vara självförklarande i så hög grad som möjligt. Det som en illustration visar skall sedan bara förklaras/beskrivas helt kort i texten. När man refererar till en illustration i texten skall detta göras utan att vara ordig. Bäst är att göra ett konstaterande och sedan inom hakparenteser referera till motsvarande illustration. Exempel: Kolmonoxidsnivån visade sig vara förhöjd under rusningstrafik [Figur 2.3]. Varje illustration skall ha ett nummer, en informativ titel och en bra förklaring (caption). Nummer, titel och förklaring placeras under figuren och själva figuren skall placeras så nära den plats där den refereras som möjligt. Tabeller Precis som med illustrationer är det på plats att ifrågasätta behovet av att använda en tabell. Kanske finns det andra, mer lämpliga sätt att presentera sina data (t.ex. med ett diagram)? När man väl bestämt sig för att använda en tabell skall man tänka på att den skall utformas enkelt och att varje enskild tabell skall ta upp en specifik fråga. Tabellen skall vara självförklarande i så hög grad som möjligt. Ovanför tabellen placeras dess nummer, titel och en förklaring. Konventioner Boken ger en också en uppsjö av konventioner gällande användningen av siffror; numrering av kapitel, illustrationer och tabeller; användning av skiljetecken; användning av versaler i rubriker (på engelska är det praxis att varje signifikant ord i en rubrik inleds med stor bokstav); användning av olika typsnitt etc. Av utrymmesskäl tas dessa regler inte upp här utan jag hänvisar till boken istället. Kommentarer om boken När man öppnar boken kan man kanske bli lite lätt skeptisk angående upplägget. Eftersom det är en receptbok så har layouten blivit en veritabel excess i tabeller, punktlistor, numrerade listor, checklistor o.s.v. Texten känns lätt aningen fragmenterad och är kanske inte så behaglig att läsa från början till slut i ett streck. Fördelen är att begreppen förklaras väldigt koncist och eftersom det också är ganska enkelt att hitta i boken kan den med fördel användas som ett referensverk. På det hela taget är jag nöjd med Writing for Science and Engineering och tycker att den gav mig mycket matnyttig information inför rapportskrivandet. 6