Avatar billede netspinner Nybegynder
02. april 2005 - 18:36 Der er 8 kommentarer og
1 løsning

At skrive en teknisk rapport

Hej,
Jeg er i gang med mit bachelorprojekt, hvor jeg har fokus på softwareudvikling med Java 3D.
Imidlertid er jeg kommet i tvivl om selve rapportskrivningen. Jeg har en idé om at starte med Design, derefter Implementering og til sidst Afprøvning - altså for den rent tekniske del. Min vejleder mener at Design-sektionen er det vigtigste, for at repræsentere mit program med UML mv. Dette synes jeg dog ikke selv er tilstrækkeligt.

Er her nogen der har god erfaring i at skrive tekniske rapporter, må I meget gerne dele jeres erfaringer - evt. noter om online-litteratur på feltet... :-)


På forhånd mange tak!
Avatar billede bromer Nybegynder
02. april 2005 - 18:39 #1
Af ren nysgerrighed må man så spørge, hvor du skriver bachelor projekt henne?
Avatar billede driis Nybegynder
02. april 2005 - 18:46 #2
Jeg plejer at arbejde ud fra noget i retning af:

1) Problemformulering og/eller kravspecifikation
En specifik specifikation af problemet du prøver at løse og en præcis specifikation af hvilke krav den skrevne software skal leve op til, og ikke mindst, hvad det IKKE skal kunne, altså samtidig en afgrænsning af hvad du vil beskæftige dig med. Hvis din opgave i forvejen er defineret ved en kravspecifikation behøver du nok inkludere dette.

2) Analyse
Analyse af problemet. Det er ikke altid relevant, men ofte. F.eks. beskrivelse af forskellige løsningsmodeller, diskussion for/imod forskellige løsninger og beskrivelse af en specifik løsning du har valgt at implementere.

3) Design
Hvordan softwaren er designet. Her hører UML og klassebeskrivelser til, klasse-ansvarsområder, etc. Beskrivelser af public methods, evt. også private hvis det er relevant. Spidsfindige detaljer i koden som måske ikke er indlysende hvis man læser koden, kan forklares med pseudokode, state-charts eller lignende, alt efter hvad der findes mest anvendeligt til det specifikke problem.

4) Test
Hvordan softwaren er testet; hvordan det er sikret at softwaren lever op til de stillede krav. Evt. kort beskrivelse af unit test kode, hvis du bruger det. Gennemgang af accepttest specifikation og resultat, hvis en sådan er defineret.
Avatar billede driis Nybegynder
02. april 2005 - 18:47 #3
Jeg er iøvrigt ingeniørstuderende, ovenstående er min normale arbejdsproces for større projekter.
Avatar billede netspinner Nybegynder
02. april 2005 - 18:53 #4
bromer > Jeg læser på Syddansk Universitet i Kolding

driis > MANGE tak, det er i øvrigt den oprindelige model jeg havde i tankerne. Da det er et bachelorprojekt er der ikke stillet en kravspecifikation, så jeg er selvfølgelig nødt til at have et afsnit med Problemformulering. Mht. Analyse er jeg mere i tvivl, men det må drøftes med vejlederen :-)

Har du evt. noget litteratur du kan anbefale?
Avatar billede driis Nybegynder
02. april 2005 - 19:07 #5
Jeg har selv læst "Real-Time UML" og "Håndbog i struktureret programudvikling" om emnet, men jeg vil ikke anbefale nogle af dem. Real-Time UML er primært om UML og har ikke så meget med selve rapportskrivningen at gøre. "Håndbog i struktureret programudvikling" omhandler netop emnet og udviklingsprocessen, men jeg synes ikke den er ret godt skrevet, og den lægger op til en meget formel struktur uden at angive nogle gode alternativer.
Avatar billede netspinner Nybegynder
02. april 2005 - 19:15 #6
OK, tak for kommentaren - jeg holder mig indtil videre til det svar du kom med før.
Avatar billede arne_v Ekspert
02. april 2005 - 22:06 #7
Jeg ville nok lave:

1)  opgave formulering
2)  opstille diverse hypoteser
3)  beskrivelse af projekt forløb
    a)  krav specifikation
    b)  design
    c)  implementation
    d)  test
    e)  kundens (medstuderendes) reaktioner
4)  konklusioner

Hvem underviser i den slags på Engstien nu om dage ?
Avatar billede netspinner Nybegynder
03. april 2005 - 10:07 #8
arne_v > Tak for bidraget! Nu er der pludselig to (gode) fremgangsmetoder, men i sidste ende er det et spørgsmål om at koge det ned til de mest relevante afsnit... Jeg kan evt. altid skrive en kommentar om mine valg, som jeg skal have på plads i løbet af næste uge :-) Jeg er færdig med at kode programmet, så jeg mangler bare at skrive rapporten.

Det er professor Klaus Robering (tysker) der underviser i Java og multimedieprogrammering - dog ikke i Java 3D, som er rent selvstudie for mit vedkommende.
Avatar billede arne_v Ekspert
03. april 2005 - 10:46 #9
Min metoder er ikke et alternativ til driis'es - bare en udvidelse.

Klaus Robering kender jeg ikke (men der er også 9 år siden jeg arbejdede
på HHS i Kolding).
Avatar billede Ny bruger Nybegynder

Din løsning...

Tilladte BB-code-tags: [b]fed[/b] [i]kursiv[/i] [u]understreget[/u] Web- og emailadresser omdannes automatisk til links. Der sættes "nofollow" på alle links.

Loading billede Opret Preview
Kategori
Kurser inden for grundlæggende programmering

Log ind eller opret profil

Hov!

For at kunne deltage på Computerworld Eksperten skal du være logget ind.

Det er heldigvis nemt at oprette en bruger: Det tager to minutter og du kan vælge at bruge enten e-mail, Facebook eller Google som login.

Du kan også logge ind via nedenstående tjenester