02101   Indledende programmering
Efterår 2007

Løsningen til den stillede rapportopgave skal udformes som en grupperapport, der indeholder nedennævnte afsnit.

Fra kursets hjemmeside under indgangen Supplerende notemateriale er der adgang til en række noter om rapportskrivning. I behøver kun at kigge på afsnittet 'Advice on style' fra noten Documentations of software systems. Der kan I finde mange nyttige råd omkring skrivestil og skrivemåder. Læs afsnittet (og kun dette afsnit) for at blive opmærksom på brug af de rette virkemidler.

Rapportens enkelte afsnit

• En Forside (titelblad) der indeholder:
  • 02101   (kursusnummeret)
  • Indledende programmering   (kursusnavnet)
  • IMM   (institutnavnet)
  • Danmarks Tekniske Universitet
  • Læg en studieplan
  • dato   (dag, måned og år)
  • Gruppe nr   (gruppens nummer som meddelt via  Dannede grupper )
  • studienummer, fulde navn og underskrift for hver af gruppens medlemmer.
• En Indholdsfortegnelse med titlerne på afsnit og underafsnit.
  Hver klassefil fra appendix betragtes som et afsnit.
• Et Resumé for læsere der kender den stillede opgaves tekst. Afsnittet skal i få sætninger beskrive løsningens omfang, dvs. hvad der er nået og ikke-nået - også omkring afprøvningen - samt bemærkelsesværdige ting.
  Resuméet kan kaldes forfatternes egen vurdering af det arbejde der er udført og præsenteret i rapporten.
  (bør begrænses til en side)
• En Kravanalyse hvor I mere overordnet analyserer den stillede opgave, dens delproblemer,  løsningsmuligheder for disse, samt Jeres valg af løsninger (med passende begrundelser).
  Hvis der er manglende eller modstridende oplysninger i opgaveteksten er det også her I definerer de forudsætninger som I har valgt at løse opgaven ud fra.
  (2 – 3 sider)
• Et afsnit Programdesign og -implementering hvor I som beskrevet i underafsnittet ”Programmets klasser” - jfr. opgaven   Læg en studieplan   - forklarer hvordan jeres program er bygget op og hvordan de enkelte dele arbejder sammen. Den overordnede programstruktur vises i et klassediagram. Begrund og diskutér jeres valg alle de steder hvor det er relevant.
  (3 – 6 sider)
  Programmernes kildetekst skal være i appendix
• Et afsnit Afprøvning der forklarer og dokumenterer hvordan I har valgt at afprøve jeres løsning, herunder de udførte JUnit test og de resultater I har opnået. Afsnittet skal rumme testudskrifter og vise skærmdumps af de gennemførte JUnit tests.
  (3 – 4 sider)
  Selve testklasserne indgår i appendix.
• Et afsnit Kørselsdokumentation der indeholder en kommenteret udskrift af en brugerdialog, som omfatter de i opgaven   Læg en studieplan   nævnte tre funktionalitetskrav 5, 6, og 7 under lægning af en studieplan for tre semestre med fem kurser indplaceret.
• Appendix med kildeteksten til programmerne i Jeres løsning, inklusive testprogrammer. Hver klasse skal have sit eget underafsnit. Følg anvisningerne i Java lærebogen. Primært afsnittene 5.10 og 6.7 der giver en oversigt omkring kommentering, layout og god stil - samt Appendix J.

Digital dokumentation

• Et katalog source med kildeteksten til alle klasserne (java-filerne).
• Et katalog doc med  den komplette javadoc dokumentation til alle klasserne.

Hvis I ikke har adgang til at producere en CD-rom kan I i stedet for pakke de to kataloger sammen i en zip-fil og sende denne fil som bilag (attachment) til en mail til jtk@imm.dtu.dk

Filen bør omdøbes fra .zip til .gip for at undgå at mail'en bliver afvist af serverne under håndteringen. Nogle servere accepterer ikke .zip-filer.