Göm meny

Rapport för kandidatprojektet

Kandidatrapporten ska bestå av en inledande kappa följt av alla projektdokument infogade som appendix.

Kappa

Mallar

Mallar för kappan i Word och Latex finns att hämta på sidan för LIPS-mallar.

Inlämning

Den färdiga kappan, version 1.0, (exklusive Appendix) skickas senast den 16 maj, kl 16.00 till er beställare samt till Birgitte Saxtrup Hermansson. I ämnesraden skriver ni:

"TSEA56: Kappa, grupp XX"

Inga appendix behöver bifogas kappan vid detta tillfälle. Kappan tillsammans med alla appendix utgör kandidatrapporten och lämnas in i sin helet i slutet av kursen.

Instruktioner

Titlen på kandidatrapporten, dvs kappan, ska beroende på det projekt ni gör vara:

  • Konstruktion av en autonom undsättningsrobot
    Design of an Autonomous Rescue Robot
  • Konstruktion av en autonom lagerrobot
    Design of an Autonomous Warehouse Robot
  • Konstruktion av en autonom sjöräddningssvävare
    Design of an Autonomous Search and Rescue Hovercraft
  • Konstruktion av en autonom taxibil
    Design of an Autonomous Taxicab
  • Konstruktion av en autonom truck
    Design of an Autonomous Forklift

Kappan ska ge en överblick av det genomförda arbetet. Kappan är den del av er kandidatrapport som en läsare (er framtida arbetsgivare?) börjar att läsa. Det kan till och med vara det enda som läses om man vill få en översikt av arbetet.

Omfånget av kappan ska vara ca 10-15 sidor plus framsida, innehållsförteckning, referenslista och bilagor. Kappan ska inkludera följande delar:

  • Problemformulering
  • Kunskapsbas
  • Genomförande
  • Resultat och slutsatser

Projektdokument inklusive förstudier inkluderas som appendix och refereras i de olika avsnitten i kappan.

Exempel på disposition

  1. Inledning
    • Ge en översiktlig beskrivning av produkten och uppdraget gärna kopplat till bilder.
    • Lyft gärna fram det som ni anser är utmanande/intressant i uppdraget.
    • Beskriv kortfattat dispositionen på rapporten.
  2. Problemformulering
    • Redogör kort för kravbilden och referera till projektdirektiv och kravspecifikation för att läsa detaljer.
    • Lägg återigen mest fokus på det som ni ansåg utmanande/intressant.
  3. Kunskapsbas
    • Beskriv kortfattat och referera litteratur, datablad och dokumentation som ni använt er av för att genomföra projektet.
  4. Genomförande
    • Beskriv kortfattat (ca 1 sida, max 2) hur projektet har bedrivits och referera bland annat till LIPS-modellen, systemskiss, projektplan och designspecifikation. Observera att designspecifikationen belyser arbetsprocessen och inte den slutliga produkten så om ni uppdaterat designspecifikationen löpande under projektet så kan ni infoga t ex den version som var aktuell vid BP3.
  5. Teknisk beskrivning (huvuddelen)
    • Redovisa det tekniska resultatet och förstudierna på ett lämpligt sätt. Detaljerade beskrivningar på grindnivå i hårdvaran eller på instruktionsnivå i mjukvaran är i detta sammanhang oftast ointressant. Referera den tekniska dokumentationen och förstudierna för beskrivning av detaljer. Lyft fram egna kreativa lösningar!
  6. Resultat
    • Beskriv kortfattat hur produkten används, hänvisa till användarmanualen.
    • Beskriv vilken prestanda produkten har och hur det har testats, hänvisa till eventuella testprotokoll.
    • Kommentera om produkten klarade de kraven som ställdes upp i kravspecifikationen.
  7. Slutsatser
    • Slutsatser
      Sammanfatta arbetet.
      Lyft fram det ni är mest nöjda med.
      Reflektera över resultatet såväl tekniskt som över genomförandet. Referera efterstudien.
    • Framtida arbete
      Vad skulle ni göra annorlunda om ni skulle göra om samma uppdrag?
      Vad skulle ni vilja utveckla om ni fick mer tid?
      Hur skulle ni tänka er att ändra uppgiften för att göra den ännu mer intressant?
  8. Referenser
    Ange de referenser som hänvisas till från kappan. Nämn gärna också att fler referenser finns i bilagorna.

    Appendix:
    LIPS-dokument och förstudier enligt ovan, dvs åtminstone: projektdirektiv, kravspecifikation, systemskiss, projektplan, designspecifikation, förstudier, teknisk dokumentation, användarmanual och efterstudie.

Skrivtips för kappan

Ibland har jag märkt att presentationen på framläggningen av projektet blir betydligt bättre än kappan och därför skulle jag vilja ge lite kortfattade och konkreta tips för hur kappan kan skrivas.

Både kappan och presentation ska på ett lättsamt och trevligt sätt introducera projektuppgiften och ge en övergripande bild av tekniska resultat. I och med denna likhet och att det verkar vara enklare att göra en bra presentation föreslår jag att ni börjar med presentationen även om kappan ska lämnas in först. Här följer ett förslag på arbetsgång:

Börja med presentationsbilderna:

Vad vill ni ha sagt med presentationen?

För att fokusera presentationen på det viktigaste kan det vara bra att tänka på vad de t ex tre viktigaste resultaten är, det borde alla åhörare komma ihåg efter att ha lyssnat på er presentation. Om ni enats om huvudbudskapet så bör det genomsyra hela presentationen från början till slut. I inledningen så gäller det att beskriva problemet och förutsättningarna tydligt och ibland även ge en glimt av resultatet för att väcka åhörarnas intresse, i mitten ge en övergripande bild av lösningen och kanske om tid finns även motivera val som ledde fram till er lösning, och i slutet visa förträffligheten med lösning.

Typiska punkter är innovativa lösningar som möjliggör bra prestanda. Det kan vara en bra filtreringsmetod av brusiga mätdata, en metod för att få upp frameraten på kameran, ett flexibelt protokoll som gjorde felsökning eller adaptering av reglerparametrar enkelt, en regleralgoritm som ger robust körning eller elektrisk konstruktion som ger små störningar. Någon av punkterna kan även vara relaterat till arbetssätt, t ex metoder för systematisk testning och integrering.

  • Skapa enkla presentationsbilder som bara innehåller titlar, enkla punktlistor om vilka poänger som ska lyftas fram och placeholders för figurer för att staka ut en röd tråd i presentationen.
  • Välgjorda figurer är ofta ett oerhört bra stöd vid presentation. Skapa och lägg in figurerna i presentationen.
  • Tänk igenom vad som ska sägas till bilderna/figurerna och korrigera eventuellt ordningen för att få ett bra flyt.

Nu är det dags att börja skriva kappan

  • Lägg in figurerna i den ordning som ni tänkt presentera dom.
  • Lägg till rubriker där det passar.
  • Skriv introducerande text i avsnitten.
  • Skriv ner förklaringen av bilderna.
  • Läs igenom utkastet och fyll i luckor i texten och komplettera delar som saknas. Finns det luckor i texten kanske det saknas bilder i presentationen.
  • Kontrollera att ni har refererat alla bilagor i kappan och att övriga instruktioner är uppfyllda.
  • Korrekturläs och lämna in.
En positiv bieffekt av denna arbetsgång är att presentationsmaterialet förmodligen nästan är färdigt!

Vanligt misstag

Slutligen skulle vilja varna för ett vanligt misstag. Det händer att den tekniska beskrivningen vävts in i beskrivningen av genomförandet, vilket inte alls är bra, dessa delar ska vara helt separerade och tyngdpunkten ska ligga på den tekniska lösningen.

Genomförandet ska vara kort och främst ses som ett stycke för att referera och kommentera projektdokumenten som har producerats under utvecklingen, dvs systemskiss, projektplan och designspecifikation.

Dom tekniska resultaten beskriver den slutliga lösningen. Intressanta designval kan beskrivas och motiveras. Beskrivningen ska fokusera på generella sanningar, dvs slutsatser som är giltiga om någon annan vill bygga en liknande robot. Att motivera ett designval med att gruppen inte hade tid att undersöka alternativa lösningar är inte så intressant. Vad gruppen skulle vilja göra om mer tid fanns till förfogande passar däremot i framtida arbete men bör då beskrivas som intressant vidareutveckling.


Informationsansvarig: Mattias Krysander
Senast uppdaterad: 2022-04-22