En vigtig del af at lære programmering er også at forstå, hvordan man strukturerer og dokumenterer sine programmer i en rapport. Rapporten er ikke kun en præsentation af dit program, men også en mulighed for at vise, hvordan du har arbejdet systematisk og reflekteret gennem hele processen.

Denne vejledning giver dig et overblik over, hvad der forventes i din rapport. Du vil lære at forklare, hvordan dit program fungerer, og hvordan du har udviklet det, ved hjælp af både tekst, diagrammer og dokumentation af koden. Målet er, at du bliver bedre til at formidle dine idéer og løsninger, både til fagfolk og andre, der ikke nødvendigvis har programmeringserfaring.

• Titel på projektet
• Navn(e) på elever
• Dato for aflevering
• Underviserens navn
• Skolens navn

• Kort resumé af opgaven, så censor hurtigt kan få overblik over indholdet.

• Oversigt over rapportens indhold med sidetal.

• Kort introduktion til projektets formål og problemstilling.
• Baggrund for valget af projektet, evt. i relation til elevens hverdag eller interesseområder.

• En præcis og afgrænset beskrivelse af, hvad projektet forsøger at løse eller undersøge.

• Beskrivelse af programmets opbygning og funktionalitet.
  • Skærmlayout: Hvordan ser brugergrænsefladen ud? Hvilke elementer er synlige for brugeren?
  • Indtastningsmuligheder: Hvordan kan brugeren interagere med programmet? Fx via tastatur, mus eller andre inputmetoder.
  • Formål: Hvad løser programmet og hvem er målgruppen?
  • Funktionalitet: Hvad gør programmet? Hvilke specifikke handlinger kan programmet udføre? Hvordan kan brugeren interagere med programmet?
• Brug af diagrammer som flowcharts, pseudokode eller andre visuelle hjælpemidler anbefales for at illustrere programmets struktur og funktioner.

• Forklaring af de trin, der blev fulgt under udviklingen (f.eks. planlægning, design, implementering, testning). Hvordan kan brugeren interagere med programmet?
• Beskrivelse af arbejdsgange og de værktøjer, der blev brugt (f.eks. udviklingsmiljøer, debugging-værktøjer).
• Brug af Generativ AI, hvis anvendt (vær opmærksom på opgavekrav, om i må have lov til at bruge det).

• Detaljeret dokumentation af centrale dele af programmet, herunder:
  • Kan man have flowchart eller pseudokode til at illustrere programmets opbygning.
  • Gennemgang af vigtige funktioner, kontrolstrukturer og algoritmer. Udvælg de vigtigste dele af din kode.
• Gennemgang af variabler, objekter og events, afhængigt af programmets type og funktionalitet.
• Sørg for kommenterede kodesegmenter for at øge læsbarheden og forståelsen.

• Beskrivelse af testmetoder og resultater.
• Eksempler på input/output og beskrivelse af eventuelle fejlrettelser.
• Evaluering af, hvorvidt programmet løser den opstillede problemstilling.

• Opsummering af projektet.
• Refleksion over, hvad I har lært, og hvordan projektet kunne forbedres.

• Fuldstændig kildekode som bilag.
• Yderligere diagrammer, dokumentation af biblioteker eller API’er, der er blevet brugt.