Projektplan och rapport
En kort översikt över projektdokumentationen:
Före projektet skriver ni en projektplan, med information om vad ni planerar att göra. Detta gäller alla. Man kan också lämna in den för en kort förhandsgranskning enligt nedan.
Under projektets gång skriver utökar ni projektplanen till en fullständig projektrapport, som också visar vad ni faktiskt har gjort och hur det fungerar. Denna rapport, med två delar, lämnas in tillsammans med projektet och är en viktig del av uppgiften.
Deltagare i TDDE30 lämnar också in projektrapporten för en separat språk- och strukturgranskning av personal på IKOS, något som U:are istället gör i en annan kurs. Detta lämnas in via Lisam.
På denna sida diskuterar vi projektplanen. Den senare projektrapporten kommer att vara en del av samma dokument som ni skriver – den andra halvan av dokumentmallen som länkas nedan.
Att skriva projektplanen
Innan ni börjar utföra projektet behöver ni alltså skriva en projektplan, oavsett om ni valde ett inspirationsprojekt som planen inspireras av eller väljer att göra något helt eget. Skriv på svenska, oavsett handledare. Syftet är:
-
Att ni ska tänka genom och planera implementationen i förväg. Många studenter anser att man har tjänat mycket på detta steg.
-
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!
-
Att er handledare ska kunna ge återkoppling om det finns stora och uppenbara problem eller risker, vilket brukar hända i en del projekt varje år. Detta diskuteras nära slutet av denna sida.
Att göra: Beskriv projektet
Fyll tillsammans i projektplanen, som är första delen av den större projektmallen. Mer instruktioner ges i mallen.
Att göra: Skicka projektplan till handledaren
Oavsett kurskod och oavsett om man använder ett inspirationsprojekt måste projektplanen lämnas in på ett eller annat sätt -- gärna i god tid så att vi hinner kommentera och se att ni inte är inne på uppenbart fel väg, men senast som en del av slutinlämningen. Exakta regler varierar beroende på kurskod:
Förhandsgranskning 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 kursvecka 3-6 (detta år 2022-01-31 till 2022-02-25). Vi gör då vårt bästa för att kommentera den så snabbt som möjligt.
Förhandsgranskning för TDDE30 och 729A85: Dessa kurser är utspridda ö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 2022-03-11). Lämnar man in till denna deadline ska man få eventuell återkopplinginnan projektstart. Man kan också lämna in senare under mars och april för att få en förhandsgranskning när vi har tid.
Slutgranskning: Projektplanen måste alltid ingå i slutinlämningen av projektet, oavsett om ni fick en förhandsgranskning eller inte. Har ni då inte lämnat in under de angivna perioderna, och därför missat möjlig återkoppling på projektidéerna, är detta inget vi kan ta hänsyn till. Det skulle kunna leda till att ni behöver göra större ändringar i projektet i efterhand.
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 i så fall till examinatorn. Det kan hända att det dröjer en månad eller att vi inte har tid alls!
Instruktioner för dig som lämnar in:
-
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 ensamliuid123-liuid456-projektplan.pdf
om ni arbetar i par -
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.
-
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.
-
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.
-
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.
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 om inlämningen om det är något du vill tala om för oss.
Ä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.
Här är länken till inlämningssidan där du fyller i en issue.
Om handledarens granskning
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.
Sidansvarig: Jonas Kvarnström
Senast uppdaterad: 2022-03-08