RAPPORTSKRIVING FOR ELEKTROSTUDENTER

Transkript

1 RAPPORTSKRIVING FOR ELEKTROSTUDENTER FORORD Dette notatet er skrevet av Åge T. Johansen, Høgskolen i Østfold. Det er skrevet for å gi studenter en veiledning i rapportskriving. Informasjonen er ment å gå direkte på strukturen for typiske rapporter som skal skives av studenter på elektrolinjen. Det er ikke meningen at dette notatet skal være i konflikt med andre opplysninger vedrørende rapportskriving som gis ved Høgskolen. Vi vil gjerne bli gjort oppmerksom på punkter hvor dette eventuelt er tilfelle. INNLEDNING Ofte vil det være rapporten alene som vil danne grunnlaget for bedømmelsen av et arbeid. Rapporten er derfor en meget viktig del av arbeidet med en undersøkelse eller et forsøk, og denne delen bør derfor vies stor oppmerksomhet. 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. En teknisk rapport bør bestå av de listede kapitler foruten en forside/tittelside. 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 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. En må i hvert enkelt tilfelle nøye vurdere på hvilken måte det er mest hensiktsmessig å presentere informasjonen (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. bør påføres minimumstekst som målebetingelser, dato og ansvarlig person (eventuelt signert). For laboratorierapporter skal det ikke forutsettes at leseren har oppgaveteksten foran seg når han leser rapporten. Rapporten skal stå på egne bein. 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. Skiv ikke noe som ikke har betydning bare for å fylle ut teksten. Bruk ikke så mye "jegform" i rapporten, forsøk å være saksorienterte. BESKRIVELSE AV DE ENKELTE KAPITLENE I RAPPORTEN Nedenfor følger en kort beskrivelse av de enkelt punktene i en rapport. Merk at ikke alle rapporter bør inneholde alle punkter - referer til tabellen på siste side. Alle kapitler og delkapitler skal nummereres. 1

2 FORSIDE / TITTELSIDE Ofte kan tittelside og forside slås sammen. Denne er påskrevet rapportens (oppgavens) navn og påføres rapportskriveren(e)s navn, dato/periode og hvilket fag/fagområde (for laboratorierapporter). Ved større prosjekter kan det også stå et meget kort ekstrakt av rapportens hovedinnhold. Ofte er forsiden standardisert. FORORD Forordet skal opplyse om målgruppe og målsetning for rapporten. For større prosjekter bør det tas med; prosjektets eventuelle forhistorie, finansieringsform og medarbeidere (eventuelt hvem som har gjort hva), samt eventuell takk til personer som har vært forfatteren (forfatterne) behjelpelig. 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. 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. 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 Innledningen inneholder problemstillingen og formålet med arbeidet. I prosjektrapporter bør innledningen bør inneholde informasjon om samarbeidsbedriften hvis det er snakk om en ekstern kunde (- mest aktuelt i forbindelse med hovedprosjektrapporter). Den bør også omfatte omfanget og begrensninger, samt strategi for løsning (der dette er aktuelt). Videre bør det inngå en situasjonsbeskrivelse (utgangspunktet man har) der det refereres til eventuelle tidligere arbeider. For mer vitenskapelige undersøkelser bør det gis en oppsummering av tidligere teorier og arbeider innen samme felt. For forprosjektrapporter vil det være naturlig å legge prosjektets planlegging til et eget kapittel plassert bak kravspesifikasjonskapittelet. Merk at løsningsmetode ofte er spesifisert i oppgaveteksten hvis det dreier seg om typiske laboratorierapporter. 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. Det bør legges til at i mange tilfeller for større rapporter, vil det være mer naturlig å ta med egne kapitler for å beskrive bakgrunnen for de enkelte fenomener, metoder og teori 2

3 som bør presenteres, enn et slikt samplekapittel som nevnt her. Skal man f. eks. ta i bruk en spesiell komponent i forbindelse med CAN-buss kommunikasjon, er det naturlig å ta med et eget kapittel med navn "CAN-BUSS" og ikke legge dette stoffet inn i et generelt kapittel om teori. SPESIFIKASJONEN Ved mindre laboratorierapporter vil det i dette kapittelet være naturlig å ta med de krav som er stilt i oppgaveteksten under innledningskapittelet. Ved større oppgaver skal dette kapittelet inneholde funksjonskrav, som for eksempel hvordan et utstyr tenkes brukt. Videre skal kapittelet inneholde tekniske krav, som f. eks. krav til bruk av standarder, effektforbruk etc. Økonomiske krav bør også være med der dette hører hjemme, for eksempel hva er maksimal pris for et produkt som skal utvikles. Kapittelet kan også inneholde en strategi for kvalitetssikring, det vil si å planlegge hvordan de oppstilte krav skal kunne verifiseres (bl. a. målestrategi). LØSNING Denne delen skal dokumentere løsningen som tilfredsstiller de oppstilte krav i oppgaven. Det er viktig å gå ut fra det høyeste nivået (system) til etterfølgende detaljerte nivåer (modul / del), det vil si å foreta en hierarkisk oppdeling. Kapittelet vil ofte inneholde logiske diagrammer, koblingsskjemaer, programmer eller annen dokumentasjon som rapportskriveren har utviklet selv i prosjektet. I laboratorierapporter vil ofte ikke dette kapittelet være så stort, siden mye av det som normalt sett burde inngå her er spesifisert i oppgaveteksten. Overskriften på dette kapittelet kan i disse tilfellene være KONSTRUKSJON eller tilsvarende. UTTESTING Ved laboratorieoppgaver og tilsvarende vil det være mer naturlig å kalle dette kapittelet for MÅLERESULTATER. Det kapittelet skal dekke, er hva som er gjort og på hvilken måte, for å verifisere at eventuelle teorier og hypoteser stemmer med de praktiske undersøkelsene. Ved målinger skal det tas med beskrivelse av måleutstyret og målemetodene (oppstillingen). Her tas det også med hvilke instrumenter som er benyttet (type og IDnummer). Beskrivelsen skal være så fullstendig at undersøkelsen kan rekonstrueres og verifiseres også av andre. Kapittelet omfatter også måleresultatene fra undersøkelsen. 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 er en naturlig del i kapittelet. DISKUSJON I dette kapittelet skal resultatene analyseres og vurderes med sikte på å komme fram til en konklusjon. Spesielt skal det legges vekt på å fram momenter som kan være av betydning ved en vurdering av påliteligheten i materialet (f. eks. nøyaktigheten i målinger). 3

4 KONKLUSJON Konklusjonen bygger på den forutgående diskusjonen. 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, koblingsskjemaer og programlistinger som er for omfattende til å ta med under de foregående kapitler. 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. LITTERATURREFERANSEN Litteratur som er benyttet i forbindelse med undersøkelsen / arbeidet, skal angis. Både 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. 4

5 Målerapport Labrapport Miniprosjekt Prosjekt RAPPORTINNDELING X X FORORD X X X X SAMMENDRAG X X X X INNHOLDSFORTEGNELSE X X X X INNLEDNING (X) Innformasjon om bedriften X X X X Oppgavebeskrivelse X X X X Formål X X Situasjonsbeskrivelse (X) X X Omfang og begrensninger X X X Strategi for løsning (X) X X TEORI (X) X X Teoretisk grunnlag (X) X X Beregningsgrunnlag X X SPESIFIKASJON X X Funksjonskrav X X Tekniske krav X X Andre krav X X Teststrategi X X X LØSNING / KONSTRUKSJON (X) X X Systemoversikt X X X Detaljert løsning X X X X UTTESTING / MÅLERESULTATER X X X Testoppsett X X X X Prosedyre X X X X Resultat X X X X DISKUSJON X X X X KONKLUSJON (X) (X) X X VEDLEGG X X X LITTERATURREFERANSEN X (X) må være med - kan utelates hvis det er naturlig (bruk skjønn) 5