Skip to main content
Dat 2. semester
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Cupcake rapportskabelon

Dokumentation af software kan tage mange former og variere fra det ene softwarefirma til den andet.

Denne skabelon viser, hvordan I skal opbygge jeres 2. semesterrapport.

Forside

Det er almindeligt at der på forsiden er følgende informationer

  • En titel. Ofte er det navnet på opgaven - Cupcake. Studenter-projekter har ofte en skør titel som “Kagekaj slår til igen”. En af jeres opgaver i løbet af studiet er at lære at lade jeres pjat ligge hjemme og opføre jer professionelt

  • Deltagere — Vigtigt

    • Navn, studie-email og GitHub-navn på alle deltagere
    • Klasse (A, B eller Bornholm, hvis der er flere hold på en årgang)
  • Tidspunkt. Hvornår blev projektet og rapporten lavet - husk årstal

Indholdsfortegnelse

Skal altid med når et dokument bliver længere end 4-5 sider. Husk også sidenumre på alle sider undtagen forsiden.

Indledning

Kort intro til hvad dette projekt omhandler. Formålet med indledning er at sætte en fagfælle i stand til at forstå resten af rapporten. For jer som studerende er en “fagfælle” en anden datamatiker studerende på 2. semester der er på samme niveau, men som ikke kender cupcake opgaven. Det må I gerne skrive eksplicit i indledningen, så læseren ikke kommer i tvivl om målgruppen.

Baggrund

Det typiske der skal med for at forklare projektet er:

  • En kort beskrivelse af den virksomhed, som skal bruge systemet
  • Hvilke krav kunden har til systemet forklaret i brede termer, f.eks. “kunden skal kunne estille en cupcake hvor man kan vælge både bund og top.” i modsætning til “der skal være en drop down menu med scrollbar i højre side med en liste over hvilke bunde der er og hvad de koster”.

Teknologivalg

En kort beskrivelse af hvilke teknologier der er brugt (jdbc, Postgresql, Java …). Her er det ikke meningen at I skal beskrive disse teknologier, men man skal sige hvilke der er brugt sådan at den der skal overtage projektet ved hvilken software der skal bruges. Der skal versions numre på (IntelliJ 2025.2.1, ikke blot “IntelliJ”).

Krav

Der er to dele i dette afsnit:

  • Hvad er firmaets håb med dette system (hvad er deres vision for systemet eller hvilken værdi er det jeres system skal tilføre deres virksomhed).
  • User stories. Disse er udleveret i opgaven, så dem kan I sætte ind som de er. Inklusiv acceptkriterer for de user stories, som I har implementeret.

Domæne model og ER diagram

I skal både lave Domænemodel og ERD. Den første skal give et overblik over det man kalder problemdomænet (begreber og ting fra den virkelige verden). ERD viser databasedesignet, som opstår på baggrund af domænemodellen og user stories. Det interessante ved domænemodellen og databasen, er at de langt hen af vejen er grundlaget for resten at systemet. Tabeller og relationer siger noget om hvad systemet arbejder med, ikke hvordan. Så det er godt sted at starte.

Som led i beskrivelsen af Domæne og ER diagram skal man have følgende med:

Domænemodel

  • Diagram over hele modellen. Husk der skal ikke metoder på klasserne og højst nogle attributter som er helt særlige for klassen. I kan udelade andre attributter.
  • Relationer og multiplicitet er vigtige, og gerne et par sætninger om de relationer I har måttet overveje mest eller kunne laves på flere måder.

ER diagram

  • Diagram over hele databasemodellen. Det er vigtigt at få plads til alle tabeller og alle relationer. Det kan så betyde at man ikke kan få plads til alle attributter på de enkelte tabeller. Dem kan man slå op i databasen, så det er ikke så vigtigt
  • Hvis nogle af tabellerne ikke er på 3. normal form vil det være almindeligt at nævne det, og forklare hvorfor det er gjort (tidspres eller anden overvejelse).
  • Hvis der anvendes 1-1 relationer kan man beskrive hvorfor man ikke blot har en tabel.
  • Hvis nogle tabeller implementerer en mange-mange relation vil det være normalt at beskrive det.
  • Hvis der er flere veje at nå fra et sted til et andet, vil det gøre det sværere at holde databasen konsistent. Hvis I har gjort det alligevel så skal I forklare hvorfor.
  • Hvis der er tabeller, hvor man benytter andet end et automatisk genereret ID som nøgle skal man forklare det.

Det er interessant at beskrive hvilke overvejelser der ligger til grund for de konkrete valg der er i ERD modellen (fremmednøgler, constraints osv)

Mockups

Man kan bruge mockups til at designe sin brugergrænseflade. Prototyping - især low-fi - er godt til hurtig idéudvikling, og er en billig og nem måde at engagere hele teamet i det kommende interaktionsdesign.

I skal vedlægge de mockups, som I har udarbejdet i forbindelse med jeres brugergrænsefladedesign. Det kan være papir-prototyper (low-fi), eller noget mere hi-fi (wireframes eller fuld figma).

Det som brugeren oplever er en række websider, hvor man kan indtaste oplysninger og navigere videre til andre sider. I større systemer kan det være svært at bevare overblikket over hvilke sider der er, og hvordan man kommer fra den ene til den anden. Navigationsdiagrammet er beregnet på at vise dette på en mere overskuelig måde. Som led i beskrivelsen af navigationsdiagrammet skal følgende med:

  • Oversigtsdiagrammet. Hvis det bliver for stort må man dele det op. Men det er vigtigt at der er et overordnet diagram.
  • Hvis man har benyttet sig af en “fælles navigations bar” i toppen af alle sider, skal man forklare det.
  • Hvis nogle sider kun kan nåes af nogle brugere (dem der har konto, dem der er logget ind, dem der arbejder i butikken,…), så skal det fremgå.

Navigationsdiagrammer laves som UML Tilstandsmaskine. Bemærk specielt at det, der hedder “composite state” er velegnet til at indkapsle at man er logget ind.

Implementation

Dette afsnit bruges til at beskrive udvalgte dele af implementation. Det kan f.eks. være:

  • Hvilke informationer gemmes i session
  • Hvordan I håndterer exceptions
  • Hvordan I har valgt at lave validering af brugerinput
  • Hvordan I har valgt at lave sikkerhed i forbindelse med login
  • Særlig lækker kode fx brug af design patterns
  • … andre elementer

Husk: det er bedre med 2 linjers dokumentation end ingen. Vi kigger ikke (nødvendigvis) hele jeres kode igennem, så sæt spotlys på det, I gerne vil have vi lægger mærke til.

Test

Her skriver I om hvordan I har testet jeres system. Fx

  • Har I foretaget unit test?
  • Har I foretaget integrationstest?
  • Hvornår i processen har I testet? Løbende eller det hele til sidst?
  • Har I foretaget brugertest af jeres mockup?
  • Har I foretaget UAT?

Status på implementation

Dette afsnit skal liste hvor langt I er nået med implementationen. Typiske ting man kan have sprunget over er:

  • Man har ikke nået at lave alle de websider man har med i navigationsdiagrammet.
  • Man har ikke nået at lave alle CRUD metoderne til alle tabellerne
  • Man har ikke fået stylet sine sider
  • Man har fundet en fejl “i sidste øjeblik”, men har ikke haft tid til at rette det. - F.eks. at man har brugt session forkert, sådan at man på en af siderne kan komme ind uden at være logget ind.
  • tests der fejler på afleveringstidspunkt
  • … andre mangler

Husk at holde jeres status op mod acceptkriterierne i US.

Proces

Dette afsnit skal beskrive projektforløbet, og hvordan kom det til at forløbe i praksis. Så beskriv:

  • Hvilke processtyringsværktøjer har I anvendt (fx GitHub Projects)?
  • Hvilke gitstrategier har I anvendt (branching, pull request, hvor hyppige commits)?
  • Hvordan har I gjort brug af kodestandarder og DoD?
  • Hvordan fungerede rollerne som Scrum Master, Product Owner og Tech Lead?
  • Hvad har I lært af processen og hvad vil I evt. gøre anderledes næste gang?