Prosjekt-dokumentasjon

I Retningslinjer for gjennomføring av prosjekter som en del av informatikkstudiet står det:

8. Dokumentasjon

Dokumentasjonen som skal leveres skal inneholde følgende deler:

• Et produkt, funksjonell programvare og/eller utstyr.
• En brukerveiledning til produktet som beskriver forutsetninger, anvendelsesområde, installasjon, bruk og vedlikehold.
• Dokumentasjon av produktet og dets komponenter
• En beskrivelse av prosjektet, inklusiv prosjektlogg
• Et ark med korrekt tittel og kort beskrivelse på norsk og engelsk

Form og omfang på dokumentasjonen avtales med veileder. Dersom ekstern samarbeidspartner har spesielle krav til dokumentasjonsform, må det avklares med intern veileder om denne dokumentasjon kan stå alene, eller om det må skrives egen dokumentasjon for avdelingens behov.

For prosjekter som har karakter av utredning, og ikke inneholder klare anvendbare produkter, vil rapporten ha en annen karakter. Veileder skal gi råd om rapportering i slike tilfelle.Studentene forestår alle utgifter med disketter, CD, kopiering etc.

9. Innlevering

All dokumentasjon, som nevnt ovenfor, skal leveres til avdelingens administrasjon i følgende formater:

• En CD-ROM, komplett med alt materiale, programprodukter, installasjon, dokumentasjon etc.
• Ett sett med papirkopier og disketter

Materialet på CD skal legges ut både i ren tekst og i et format som kan behandles av standard programvare.

For SD96 betyr dette at dokumentasjonen har to distinkte deler:

• hva den skal inneholde
• hvilken form den skal ta

Innhold

Produkt

Det skal leveres et komplett, kjørbart produkt. Produktet, i form av program, kode, data, etc. skal leveres med de nødvendige verktøy for å demonstrere produktets funksjonalitet i en rimelig periode fremover i tid. Dersom produktet er avhengig av spesielt krevende støttefunksjoner for å kunne demonstreres uavhengig, skal omfanget av det innleverte materialet avtales med faglærer og dokumenteres særskilt.

Prosjektdokumentasjon

Sammen med produktet skal det leveres en skriftlig rapport som redegjør for produktets mål, tilblivelse or realisering. Formen denne dokumentasjonen skal ta er beskrevet nedenfor.

Bilag

Rapporten skal ha de bilag som er nødvendig for å dokumentere de arbeidsmetoder som er brukt for å administrere og gjennomføre prosjektet.

Tillegg

Eventuell brukerveiledning, manual, teknisk veiledning for drift og vedlikehold av produktet.

Form

Prosjektrapporten skal ta for seg prosjektet fra såvel en teoretisk side som en praktisk og funksjonell. Det følgende er bare et forsalg til de deler rapporten bør bestå av. Inndelingen kan modifiseres med tillegg etter behov.

Innledning

Omhandler prosjektet i korte trekk og er et lettfattelig sammendrag av hele prosjektet.

Prosjektbskrivelse

Her skal den opprinlige beskrivelsen, med mål, midler og resultat fremføres i tilpasset form.

Bakgrunn og begrunnelse

Dette er den 'teoretiske' delen av rapporten som forklarer bakgrunn for prosjektet, forutsetninger også diskuterer en begrunnelse for prosjektet som setter det i en perspektivisk sammenheng med selve kurset.

Beskrivelse

Beskrivelse av funksjonalitet, deler, oppgaver, metorder, løsninger, resultater og erfaring. Her bør det også inkluderes en del om hva som ikke ble gjort, skulle ha vært gjort og anbefaling til neste etappe.

Konklusjon

Evaluering med kommentarer og brunnelse av resultatets kvalitet(er).

Referanser

Referanser, noter, bibliografi, etc.

Tekniske tillegg

Teknisk og/eller populær driftsmanual. Denne utformes etter god standard

Media

Produkt

Produktet skal, dersom det er aktuelt, leveres i sin opprinlige form. Digitale data skal leveres på rimelig permanent lagringsmedium i standard formater. Skal avtales med faglærer i hvert enkelt tilfelle.

Rapport

Rapport skal leveres skriftlig. Dette kan imidlertid være en tilpasset utgave av en digital presentasjon. Skriftlig rapport skal utformes, skrives ut eller trykkes i henhold til vanlige regler for vitenskaplig dokumentasjon. Alle kilder skal refereres etter vanlige bibliografiske bestemmelser, fotnoter, henvisninger, osv. etter vanlig norm, f.eks. APA Publication Manual Rapportens omfang står i forhold ti produktet og dets innhold.