Att skriva rapporter Det som ställer till mest frustration bland studenter är det avsnitt som kallas Systembeskrivning. Studenterna får lära sig att en systembeskrivning alltid har samma upplägg. Detta är tyvärr ett allvarligt misstag! En rapport måste tillåtas vara lite flexibel.
En rapports syfte Träna skriftlig framställan Dokumentera sitt arbete på ett professionellt och formellt sätt Göra det möjligt för andra att förstå och ta del av arbetet Förbereda sig själv för det som väntar i arbetslivet, där dokumentation är en central del av arbetet
En rapports innehåll Försättsblad, titelblad Sammanfattning (abstract) Innehållsförteckning Inledning/problemspecifikation Genomförande/metodbeskrivning (huvudavsnitt) RESULTAT (viktigt) Problem och reflektioner Litteraturförteckning, referenser Eventuella bilagor
Så Skriver Du Bättre Tekniska Rapporter Litteratur Så Skriver Du Bättre Tekniska Rapporter av Walla, Erik Häftad. Studentlitteratur AB (ISBN 9144019130). Pris: 187:-
Försättsblad, titelblad Titel, ev. undertitel (Kursens namn) Ditt namn Din E-post adress (Handledarnas namn) Datum Lämna utrymme för kommentarer
Sammanfattning (abstract) Max. en sida. Skall vara en kortfattad sammanfattning av vad rapporten innehåller. Nyckelord (Atmel, LED, A/D-omvandling) (På engelska)
Innehållsförteckning Innehåller alla avsnitt i rapporten Innehåller inte sig själv Innehåller helst alla bilagor Kan ofta genereras automatiskt Om man själv gör innehållsförteckningen, se till att den verkligen stämmer Se till att rubriker och underrubriker inte ser förvillande lika ut i innehållsförteckningen Det kan vara bra med t ex punkter mellan namnet på ett avsnitt och sidnumret
Problemspecifikation/inledning Ska beskriva vad uppgiften går ut på Ska kunna ge en bild av uppgiften utan att man ska behöva läsa hela original- specifikationen Använd egna ord, d v s kopiera inte (labb)specifikationen Sammanfatta problemet Hänvisa till originalspecifikationen Gör specifikationen att vissa antaganden måste göras? Ta upp dessa i sådana fall Övergång till huvudavsnittet
Genomförande/metodbeskrivning Den mest centrala delen och den som brukar innehålla flest påpekanden Ska beskriva systemets (konstruktionens) interna uppbyggnad och struktur Vad som anses viktigt är olika beroende på vilken typ av uppgift man haft Försök att tänka efter vad som är de viktigaste delarna av lösningen och beskriv dessa mer ingående Ofta bra med figurer som illustrerar centrala delar samt hur olika delar är sammankopplade Bättre med små tydliga figurer än ett enda stort spindelnät Endast fakta skall finnas här
Resultat Mycket viktigt! Vad har du kommit fram till. Redovisa det! Inget tyckande hit och dit. FAKTA! Redovisa testkörningar
Problem och reflektioner 1 Vilka problem har du stött på? Vad tyckte du om arbetsuppgiften? Har du några åsikter du vill framföra? Finns det personer som varit till särskild hjälp? Tacka dessa Detta avsnitt är mycket fritt och kan innehålla nästan vad som helst
Problem och reflektioner 2 Beskriver alla begränsningar som du kan komma att tänka på, eller har stött på under testningen Uppriktighet anses positivt. Alltså bör du tala om de begränsningar som strider mot specifikationen Förbättringar som kan göras Nästan alla lösningar innehåller någon begränsning, tänk till lite bara Hur kan/kunde begränsningarna undvikas?
Litteraturförteckning/referenser Bör användas i mer uppsatsliknande rapporter Brukar oftast påpekas om det är nödvändigt Det finns standarder för hur referenser kan göras
Bilagor Används vid behov Bör finnas med i innehållsförteckningen Bör alltid hänvisas till från rapportens huvuddel Kod skall finnas här. Bilagan skall ej behöva läsas för att förstå rapporten
Slutliga tips och råd Umeå Universitets logo får inte användas Använd ett korrekt och formellt språk Normalt är språkvalet svenska/engelska fritt Sidhuvud/sidfot innehållandes namn, E-mail, kursnamn, laborationsnamn Sidnumrering ska användas Använd inbyggda rättstavningen i WORD Om du använder MS WORD, se till att den inte är inställd på engelska (i blir I) om du skriver på svenska Sidnumreringen börjar med sid 1 på sidan efter innehållsförteckningen
Språket Stavfel och språkfel leder till retur. Stavfel tolereras ej. Be någon annan person läsa rapporten. Använd ett korrekt och formellt språk Använd ’jag’, ’vi’, ’man’ mm med yttersta sparsamhet Dåtid för slutsatser och nutid för generella beskrivningar Texten skall vara torr och tråkig och klart formulerad. Har du inget att säga, säg inget. Skriv i logisk följd. Inte tidsmässig. (Förskräckligt:Först gjorde vi …. sen tog vi …… till slut så …..)
Layout Välj lämplig font, 12 pt textstorlek och normalt radsprång. Bilder/tabeller/diagram skall numreras och ha en kommentarsrad. (ex.:Bild 1: controllerns benkonfiguration)
Muntlig framställning Utgå ifrån att åhörarna inte vet något om dig eller ditt projekt. Presentera dig Presentera projektet (ta specen som utgångspunkt) Beskriv lite om hur gruppen arbetat/samarbetat. Har det funkat? Har alla deltagit i arbetet/utvecklingen Antag att åhörarna besitter samma kunskaper i elektronik som du själv. Ex. Förklara ej hur en OP fungerar Använd visuella hjälpmedel (OH e.dyl.) Om du vill köra en PPT-presentation så finns dator tillgänglig. Tag med filen på minnespinne. Kopplingsschema från Capture. Delar av. Dema speciallösningar och annat intressant och specifikt för din konstruktion. Gör en strukturiell beskrivning av koden.
Alla i gruppen skall delta aktivt Alla i gruppen skall delta aktivt. Planera samarbetet inom gruppen före framställningen. Tänk igenom före vad du skall säga.
Framförandet Var entusiastisk över ditt fantastiska jobb. Säg aldrig något nedsättande om det du åstadkommit!