Allmänna krav
Laborationsrapporten är en dokumentation av hur ni har löst den givna
laborationsuppgift.
När ni skriver en laborationsrapport ska ni skriva den så att den vänder sig till en
läsare som kan ungefär lika mycket programmering som ni själva.
Rapporten ska vara skriven i ett ordbehandlingsprogram (tex Word).
Försättsbladet
Laborationsrapporten skall förses med ett försättsblad. På försättsbladet skall namn, personnummer och mail-adress på gruppmedlemmarna anges, samt gruppnummer.
Rapportens rubriker
Nedan anges de rubriker som bör finnas med i rapporten.
Om ni vill lägga till ytterligare rubriker är det för ni göra detta.
Åtkomst och användarhandledning
Under denna rubrik anges hur en användare kan komma åt programmet samt hur hon/han
ska gå tillväga för att köra programmet. Här skall exempelvis namnet på den
exekverbara programfilen ges.
Problemspecifikation
Under denna rubrik beskrivs det problem som skall lösas (utan att hänvisa till
laborationsspecifikationen). Här tar ni också upp de eventuella tillägg och
ändringar av problemet som ni gjort.
Analys
Under denna rubrik beskrivs den analys man gjort av problemet. Det kan vara lämpligt att med ett exempel visa hur användaren kommunicerar med programmet.
Systembeskrivning
Under denna rubrik beskrivs hur programmet är uppbyggt,
dvs vilka klasser som finns och hur dessa samverkar med varandra.
Klassbeskrivning
Här görs en noggrannare beskrivning av de ingående klasserna.
Ange syftet med varje enskild klass och vilket gränssnitt klassen har
(dvs vilka publika metoder som finns i klassen).
Lösningens begränsningar
Här diskuterar ni de begränsningar som er lösning kan tänkas ha och beskriver
eventuella förbättringar och utvidgningar av programmet.
Testkörningar
Beskriv hur ni har testat programmet. Beskriv inte enbart hur ni testat det färdiga programmet,
utan beskriv även hur testningen av de ingående programkomponenterna gått till.
Problem och reflektioner
Under denna rubrik skall ni göra en utvärdering av ert arbete. Beskriv de problem
som ni stött på samt hur ni löst dem. Reflektera över vad ni lärde er av
laborationen. Ange hur mycket tid ni lagt ner på laborationen och på vad ni lagt
ner tiden. Tala också om vad ni tyckte om själva laborationsuppgiften och
hur det har fungerat med handledningen.
Källkod
Ni skall bifoga källkoden på papper. Det är viktigt att programmet är lätt
att läsa. Indentering och kommentering är mycket viktig.
Devisen it was hard to write, it should be hard to read kommer inte att accepteras.
Skriv aldrig ut koden i mindre font än 10pt eftersom det är väldigt tröttsamt att
läsa finstilta koder. Om ni skriver ut källkoden med ett ordbehandlingssystem,
se då till att använda en font som har fasta storlekar på tecknen (tex Courier).
Annars kommer tabulatorer och mellanslag att bli ojämna vid utskrift.
|