Veiledning til rapportskriving for elektrostudenter

Transkript

1 Veiledning til rapportskriving for elektrostudenter 1. Forord Dette notatet er skrevet for å gi studentene veiledningen i rapportskriving på Elektroseksjonen for typiske laboratorierapporter. Notatet er kun veiledende og enkelte faglærere kan egne spesifikke ønsker/tillegg for rapportene i sine fag. Notatet er basert på tidligere anbefalinger/praksis ved Høgskolen i Gjøvik (HiG), notat Rapportskriving fra Ole Johnny Berg, Høgskolen i Gjøvik og notat Rapportskriving for elektrostudenter fra Åge T. Johansen, Høgskolen i Østfold. 2. Innledning Evnen til å skrive en klar og konsis teknisk rapport er viktig for enhver ingeniør. Dokumentasjonen av resultatene og hvordan de ble frambrakt og ofte vel så viktig som selve laboratoriearbeidet. I mange tilfeller er det dokumentasjonen oppdragsgiver benytter videre. Bedømmelsen av hvor godt arbeidet er utført avhenger da av hvor god rapporten er. 3. Generelt Rapporten skal skrives for en leser med samme tekniske bakgrunn som deg selv. Den skal bygge på resultatene fra laboratoriearbeidet slik de er nedtegnet i laboratorieprotokollen. Oppgaveteksten skal ikke legges ved rapporten og det forutsettes ikke at den er kjent. Rapporten skal stå på egne bein. Derfor skal det gå klart fram hva oppgaven gikk ut på, hvordan du løste den og hvilke resultater du kom fram til. Målet med rapporten er å gjøre det lett for leseren å få oversikt over arbeidet som er gjort og resultatet av oppgaven som er utført slik at det eventuelt kan etterprøves. Rapporten skal være kort og konsis, men ikke så kort at den er uleselig. Rapporten må være tilstrekkelig detaljert til å beskrive arbeidet og oppnådde resultater entydig. Husk at det skal være mulig å reprodusere måleresultatene (for andre enn forfatteren) ved å følge framstillingen i rapporten. Forsøket skal være etterprøvbart for alle med tilsvarende kompetanse. En rapport skal være maskinskrevet. Språket må være korrekt, småfeil og slurv virker irriterende og kan ødelegge inntrykket av en ellers god rapport. Et saksorientert språk uten for mye jeg form egner seg best i en teknisk rapport hvor informasjonen er det sentrale. En teknisk rapport bør være så objektiv som mulig i forhold til innholdet. Vær klar og tydelig i det du skriver, og kom raskt til poengene. En teknisk rapport bør bestå av de listede kapitler foruten en forside/tittelside. Standard forside skal benyttes. Det er viktig at den gitte inndelingen følges. Dette sikrer foruten en strukturert oppbygning også at de enkelte deler kan leses separat, samt at enkelte deler av 1

2 rapporten kan leses med fullt utbytte (noen ganger lese f. eks. bare sammendrag og konklusjon i en rapport). Kapitlene kan etter oppgavens art gis en annen overskrift. Ved eventuelle bortfall eller tilkomst av kapitler, må kapitlene nummereres fortløpende (Kap. 1, 2, 3 osv.). For hvert enkelt kapittel eller underkapittel tas det med som er aktuelt for den aktuelle rapporten. 4. Presentasjon av resultater En må i hvert enkelt tilfelle nøye vurdere på hvilken måte det er mest hensiktsmessig å presentere informasjonen/resultater (f. eks. som tekst, figur, kurve eller tabell). Alle figurer og tabeller skal i tillegge til et nummer ha en kort tekst som forteller hva de framstiller. Kurver skal tegnes med oversiktlig angivelse av enheter. Helsides kurveark, skjemategninger osv. skal påføres minimumstekst som målebetingelser, dato og ansvarlig person (eventuelt signert). Figurer, kurver og tabeller settes vanligvis inn på samme siden som teksten knyttet til dem. De skal ikke komme som vedlegg til slutt (bare unntaksvis dersom det er spesielle grunner). Kurver, figurer og tabeller skal være lesbare og inneholde tilstrekkelig informasjon slik at de skal kunne tolkes entydig av leseren. 5. Rapportens oppbygging Nedenfor følger en kort beskrivelse av de enkelte punktene i en rapport samt noen kommentarer til viktige momenter. Mek at ikke alle rapporter bør inneholde alle punktene, en viss grad av skjønn bør benyttes. Noen rapporter krever også ytterligere punkter. Det vil være leserens behov for informasjon som vil være avgjørende. Forside/tittelside Standard forside fra HiG skal benyttes. Følgende skal oppgis: Oppgavens nummer og tittel. Hvem som har skrevet rapporten. De øvrige deltagerne i gruppen. Hvilken faglærer, lab.ingeniør eller student assistent som var til stede. Når oppgaven ble utført og når rapporten ble levert inn. Forord Forordet skal opplyse om målgruppe og målsetning for rapporten. (Eventuelt hvem som har gjort hva). Dersom noen har gitt råd og veiledning eller vært til hjelp underveis, er det naturlig å fremheve dette i forordet. 2

3 Sammendrag I sammendraget bør en ha med en kort redegjørelse for hensikten med undersøkelsen / arbeidet, mens hovedtyngden skal ligge på en kort oppsummering av de viktigste resultater og konklusjoner. Trekk frem de mest interessante resultater, problemstillinger, løsningsmetode og konklusjoner. I de tilfeller de oppnådde resultater er underlagt spesielle reservasjoner, skal dette nevnes. Sammendraget skal kunne leses isolert fra resten av rapporten og likevel gi nødvendig informasjon. Anslagsvis maks. 1/2 side. Innholdsfortegnelse Her listes opp alle hoved og delkapitler som forekommer i rapporten. Overskriftene gjengis ordrett slik de forekommer inne i rapporten. Rapportens sider skal nummereres, og sidenummeret der hver enkelt overskrift forekommer, føres opp i innholdsfortegnelsen. Husk å nummerere kapitler og delkapitler. Innledning I innledningen skal det gjøres rede for hva laboratorie oppgaven går ut på, det vil si problemstillingen og formålet med arbeidet. En beskrivelse av arbeidets omfang og begrensninger er ofte naturlig å ta med her. Teori I dette kapittelet går en inn på den teoretiske bakgrunnen for undersøkelsen / arbeidet. Formler og lignende hører naturlig hjemme her. Eventuelle ligninger (formler) nummereres, slik at disse kan refereres til seinere i rapporten. Det skal gis begrunnelse for valg av løsningsmetode dersom det ikke dreier seg om helt rutinemessige arbeider. Det bør poengteres at den teorien som tas med, bør være spesiell ut fra oppgaven som foreligger. Grunnleggende teorier er bare aktuelle å ta med når oppgavens art gjør dette naturlig. Utstyrsliste En detaljert og komplett utstyrliste med alle benyttede komponenter/utstyr. Alle måleinstrumenter angis med fabrikat, type og serienummer. Dette er spesielt viktig for å oppdage f. eks. feil på et instrument. Måleresultater Det kapittelet skal angi alle måleresultater hva som er gjort og på hvilken måte, for å verifisere at eventuelle teorier og hypoteser stemmer med de praktiske undersøkelsene. Måleresultatet må angis entydig slik at de tolkes rett ved videre bruk. Husk å angi måleinstrumentenes innstilling osv. 3

4 Det skal tas med beskrivelse av måleutstyret og målemetodene (oppstillingen). Beskrivelsen skal være så fullstendig at undersøkelsen kan rekonstrueres og verifiseres også av andre. Måleoppstilling med figurer og forklaringer hører hjemme her. Likeledes tar en med bearbeidelsen av data (tabeller, kurver, beregninger på bakgrunn av målinger). Det skal imidlertid klart gå fram hva som er observasjoner (målinger, simuleringsresultater) og hva som er beregninger. Oversiklige nummererte tabeller og figurer (eventuelt bilder) er en naturlig del i kapittelet. Bearbeiding/beregning av måleresultatene (kan evnt plasseres under måleresultater) Videre bearbeiding av måleresultater og beregning av data kan plasseres her dersom arbeidet er så omfattende at det er naturlig å benytte et eget kapittel. Alternativt tas det med under måleresultater. Diskusjon I dette kapittelet skal resultatene analyseres og vurderes med sikte på å komme fram til en konklusjon. Spesielt skal det legges vekt på å få fram momenter som kan være av betydning ved en vurdering av påliteligheten i materialet (f. eks. måleusikkerhet). Bruk ikke flere sifre i svarende enn de gjeldende. Det blir f. eks. misvisende hvis du måler en verdi med nøyaktighet på 1% og oppgir 5 desimaler. I en laboratorieoppgave skal du ofte verifisere en teori eller matematiske beregninger. En viktig del av rapporten går da ut på å vurdere de praktiske/målte resultatene i forhold til de teoretiske (hvorfor ble resultatene som de ble). Unøyaktige instrumenter eller støy kan gi feil i måleresultatene. Noen ganger må selve målemetoden med måleoppstillinger og måleprosedyrer analyseres. Eventuelle avvik og mulige feilkilder diskuteres. Kapitlet om diskusjon er spesielt viktig dersom resultatet ikke ble slik som forventet. Hva kunne ha løst eventuelle problem? Konklusjon Konklusjonen skal gi en kort sammenfatning av resultater og vurderinger. Konklusjonen bygger på den forutgående diskusjonen og bør sees i sammenheng med oppgavens hensikt. Her tas med de slutninger som kan trekkes. De viktigste resultatene skal være med i konklusjonen. Ved mindre rapporter kan det være hensiktsmessing å slå diskusjonen og konstruksjonen sammen, men det må da framgå av overskriften. Vedlegg Vedlegg inneholder observasjoner, beregninger, skisser, tabeller, tegninger, bilder, koblingsskjemaer og programlistinger som er for omfattende til å ta med under de foregående kapitler. 4

5 Datablader og lignende hører også hjemme her. Likeledes kan man i mange tilfeller ta med spesielle detaljerte forklaringer og teori som ikke inngår naturlig i hoveddelen av rapporten. Lange utledninger av formeler, forklaring av virkemåten til et instrument eller beskrivelse av framgangsmåten ved bru av et bestemt instrument hører naturlig hjemme her. Du bør da henvise til dette vedlegget i teksten. Litteraturreferanser Å oppgi hvor du har hentet informasjon fra, dvs. hvilke kilder du har brukt, kalles å referer. En referanse består av to elementer. Referanse i den løpende teksten og oppføring i en referanseliste/litteraturreferanseliste. Litteratur som er benyttet i forbindelse med lab.arbeidet, skal angis. Datablad (som ikke er vedlagt) og internettsider angis. Eventuelle tidsskriftartikler og bøker angis med referansenummer, forfatter, tittel, utgiver og utgivelsesår. For tidskrifter angis i tillegg tidsskriftsnavn, nummer og sidetall. For bøker angis i tillegg forlag, trykkested, utgavenummer og eventuelt sidetall. Det er naturlig å henvise til aktuell referanse i teksten. Eksempler på litteraturreferanser: Det finnes flere systemer for hvordan du skal oppgi kilder. To av de mest brukte systemene er Harvard og Vancouver. Harvardsystemet er et forfatter år system. I teksten oppgir du forfatternavn og år. I referanselisten oppgir du full referanse i alfabetisk rekkefølge.. Vancouversystemet er et nummersystem. I teksten oppgir du et løpenummer. I referanselisten oppgir du full referanse i den rekkefølgen du har brukt de ulike kildene.ved HiG avd for Teknologi er dette det mest benyttede systemet. 5