Göm menyn

Projektplan

Innan ni börjar implementera ett projekt ska ni skriva en projektplan. Detta ska ske oavsett om ni valde ett inspirationsprojekt som planen inspireras av eller väljer att göra något helt eget, och oavsett vilken kurskod ni har (TDDD78 eller TDDE30). Skriv på svenska, oavsett handledare.

Syftet med projektplanen är:

  1. Att ni ska tänka genom och planera implementationen i förväg, bland annat genom att skapa en uppsättning potentiella milstolpar som vägleder programmeringen. Många tidigare studenter anser att man har tjänat mycket på detta steg.

  2. Att ni ska tänka genom och planera hur ni ska arbeta, om ni arbetar i par. Det är viktigt att komma överens om när/hur man arbetar och vad ambitionen är!

  3. Att er handledare ska kunna ge återkoppling om det finns stora och uppenbara problem eller risker innan ni har börjat genomföra projektet, vilket brukar hända i en del projekt varje år.

    Det är omöjligt för handledarna att helt och hållet avgöra hur genomförbart ett projekt är. Därför är genomgången en kortare "sanity check" där vi tittar efter uppenbara problem, som att projektet är alldeles för litet eller för stort eller att ni saknar tillräcklig information om milstolpar. Vi ger inte "godkänt" eller "ej godkänt" på detta i webreg, utan ger "inlämnat" som betyg om vi inte ser något uppenbart att diskutera. Ansvaret för projektets innehåll ligger fortfarande på er som kursdeltagare, och ni får gärna fortsätta diskutera detta med era handledare under handledningstiderna medan ni utför projektet.

  4. Att er handledare ska se hur ni har tänkt och få en bättre förståelse av projektet när det till slut lämnas in för granskning. För det syftet kommer ni under projektets gång även att utöka rapporten till en längre projektrapport, som också visar vad ni faktiskt har gjort och hur det fungerar – men även projektplanen är viktig.

  5. Att utgöra en del av underlaget för momentet UPG1 (1 hp) för TDDE30 (D-programmet). Detta moment innebär en separat granskning av den längre projektrapportens språk och struktur av personal på IKOS, något som U:are istället gör i en annan kurs (för tillfället TDDD92, AI-projekt). En föreläsning om språk och struktur kommer att hållas under andra perioden.

Mall för projektplanen

Projektplanen är första delen av den större projektmallen. Se instruktionerna i själva mallen för mer information om den information vi förväntar oss! (Det står 2023 i filnamnet då detta är senaste gången mallen ändrades. Vi har inga ändringar för 2024.)

Ni måste använda mallen och inte ändra utseende, ta bort / lägga till avsnitt, eller skriva dokumentet enligt en egen mall.

Inlämningar för projektplan och projektrapport

Det finns flera möjligheter att lämna in projektplan och projektrapport. Vissa är frivilliga, medan andra är obligatoriska.

  • Frivillig men rekommenderad förhandsgranskning av projektplan för TDDD78: Denna kurs har som bekant kortare kurstid och olika studenter kan vara klara att börja med projektet vid olika tillfällen. Därför kan ni som går TDDD78 lämna in projektplanen för en förhandsgranskning när som helst under fjärde till sjätte kursveckan (detta år 2024-02-05 till 2024-02-25). Vi gör då vårt bästa för att kommentera den så snabbt som möjligt. Se inlämningsinstruktioner nedan.

  • Frivillig men rekommenderad förhandsgranskning av projektplan för TDDE30: Denna kurs är utspridd över flera veckor och har särskild tid avsatt för att skriva projektplanen. Därför har vi en specifik deadline för inlämningar för förhandsgranskning (i år 2024-03-08). Lämnar man in till denna deadline ska man få eventuell återkoppling innan projektstart 2024-03-25. Man kan också lämna in senare under mars och april för att få en förhandsgranskning när vi har tid. Se inlämningsinstruktioner nedan.

  • Senare inlämning för förhandsgranskning av projektplan: Om ni börjar med projektet senare (nästa period, nästa termin, nästa år...) och vill ha en förhandsgranskning av en ny projektidé utanför våra angivna granskningstider är det kanske möjligt att få det, beroende på om det finns tid. Skicka då in projektplanen på samma sätt som anges nedan. Det kan mycket väl hända att det dröjer en månad eller att vi inte har tid alls! Se inlämningsinstruktioner nedan.

  • Obligatorisk slutgranskning av projektrapport inklusive projektplan: Hela projektrapporten, inklusive projektplanen, måste alltid vara fullständigt ifylld och ingå i slutinlämningen av projektet (incheckat i Git). Detta gäller oavsett om ni lämnade in planeringsdelen till förhandsgranskning eller inte. Hela rapporten används av handledarna som en del i granskningen av projektkod med mera. Se instruktionerna för projektinlämning för att se hur du lämnar in hela projektet inklusive den slutliga rapporten.

  • Språk- och strukturgranskning av projektrapport inklusive projektplan för TDDE30: Hela projektrapporten, inklusive projektplanen, måste alltid vara fullständigt ifylld för detta separata moment som ger 1 hp extra. Inlämning sker till IKOS via Lisam enligt instruktionerna för språk och struktur.

Instruktioner för dig som lämnar in en projektplan till förhandsgranskning:
(Se separata länkar ovan för info om inlämning av fullständig projektrapport när hela projektet är klart!)

  1. Exportera till PDF-format, t.ex. med File | Export to PDF i OpenOffice Writer. Döp filen enligt följande mönster, utan mellanslag i filnamnet. Ditt eller era LiU-ID måste alltså finnas med, i precis detta namngivningsmönster.

    liuid123-projektplan.pdf om du arbetar ensam

    liuid123-liuid456-projektplan.pdf om ni arbetar i par

  2. Om du inte redan har gjort det: Klona ditt projektrepo som du har fått efter att du anmälde dig till projektet i Webreg.

  3. Checka in PDF-filen i Git. Använd ditt projektrepo som du har fått efter din anmälan till projektet, inte det gamla repot för labbarna! Lägg den i roten av projektet, så det går lätt för handledaren att hitta den utan att leta. Pusha sedan till Gitlab.

  4. Tagga nuvarande version med en tagg vars namn börjar med "plan" (exempelvis plan eller plan1. Detta fungerar som en signal för vår automatisering att det är en plan som lämnas in, och inte ett fullständigt projekt. Se instruktionerna för labbinlämningen för info om taggning.

  5. I stället för att lämna in programkod och dokumentation via epost till assistenterna hanterar vi detta via issues i ett centralt Gitlab-repo.

    Detta är ett centralt repo som vi länkar till nedan. Du kan inte lägga det som en issue i ditt eget repo; det är som att skicka epost till dig själv. Använd länken nedan efter att du har läst instruktionerna. En issue ska skapas innan deadline.

    Detta ser ut ungefär så här:

    Om ingen text är ifylld i rutan är du på fel plats. Om det inte står "java-project-handins" högst upp är du på fel plats. Om det står "INTE TILL FÖR INLÄMNINGAR ELLER FRÅGOR!" är du på fel plats.

    Det enda du behöver fylla i här är titel och en länk till din tagg i Gitlab. Du hittar denna länk genom att leta upp taggen i ditt projekt i Gitlab, under Repository / Tags. Klicka på taggnamnet och kopiera länken – exempelvis https://gitlab.liu.se/tddd78-2048/tddd78-projekt-2048-u1-g24-99/-/tags/t5.

    Från detta hittar vi automatiskt om det är projekt eller labbar som lämnas in, vem som lämnar in, och givetvis även vilken tagg det gäller. Vi kommer att automatiskt göra din issue konfidentiell.

    Då ska det se ut ungefär så här:

    Det är OK att fylla i mer information i beskrivningen om det är något du vill tala om för oss.

    Fyll inte i assignee eller andra fält, om de syns för dig som student. De kommer istället att sättas automatiskt.

    Ändra aldrig på en issue när du väl har skickat in den! Då kan den redan ha börjat behandlas av systemet och granskaren kanske inte ser dina ändringar, t.ex. om du ändrar länken till att peka på en annan tagg. Stäng i så fall din issue och öppna en ny istället.


Sidansvarig: Jonas Kvarnström
Senast uppdaterad: 2024-02-04