Afstudeerverslag, uitleg programma

[storeman]

We zijn al een tijdje bezig met ons afstudeerverslag. Tijdens ons afstuderen hebben we een applicatie geschreven voor SolidWorks. Aangezien we beide WB-studenten zijn valt het niet mee om fatsoelijke verslaglegging van de grond te krijgen. Daarnaast zijn onze afstudeerbegeleiders natuurlijk ook WB-ers (waarvan één met automatisering als specialisme, maar dat gaat vooral over PLC's etc).

Nu is mijn vraag: Hoe kunnen we een helder verslag maken over onze applicatie, werking, keuzes etc. Verslagen over productontwikkeling is hier geen probleem, maar een dergelijke aanpak lijkt voor ons niet te werken op ons programma.

Dus, tips, tricks of voorbeeldverslagen, ik zie ze graag tegemoet!

[Hydra]

Euh, wat wil je precies? Voorbeeldverslagen? Daar kun je toch via je opleiding aan komen? Voor de rest lijkt het me vooral een kwestie een stuk schrijven over het probleem, en de oplossing die jullie gemaakt hebben.

[Boss]

Is het geen eis dat een goed ingenieur in staat is om zelf in heldere taal uit te leggen wat hij gedaan heeft? Of was dat vroeger?

Het beschrijven van de keuzes die je gemaakt hebt voor een computerprogramma gaat echt niet veel anders dan het beschrijven van andere ontwerpkeuzes.

[Zyppora]

Als het goed is heb je tijdens je studie ook een kwartaal Rapporteren oid gehad, of in elk geval een soort layout van wat er allemaal in je verslag hoort te staan (inhoud, conclusie, voorwoord, aanbevelingen, etc). Sla je oude studieboeken er nog eens op na. Ik weet niet of voorbeeldverslagen hier zoveel gaan helpen, aangezien je zelf aangeeft dat 'een dergelijke aanpak niet lijkt te werken'.

[storeman]

Het probleem ligt hem vooral in het vastleggen van de werking.

Natuurlijk, functiemodellen, klassediagram, database ontwerp, dat soort zaken geven natuurlijk al heel veel verduidelijking.

Maar meer een methodische aanpak van het vastleggen zo'n verslag.

Ik zou zelf niet de code regel voor regel bespreken, of moet dit juist wel? Moet je iedere functie documenteren in een dergelijk verslag? Waar een functie wordt gebruikt? Waarom je een functie private of public maakt?

Met andere woorden, waar ligt de grens tussen iets begrijpelijks voor noobs en teveel ontinteressante details.

Is het geen eis dat een goed ingenieur in staat is om zelf in heldere taal uit te leggen wat hij gedaan heeft? Of was dat vroeger?

Uiteraard, vandaar deze vraag, maar qua verslaglegging voel ik me gewoon een nOOb op dit gebied.

[NMe]

Boss schreef op woensdag 06 augustus 2008 @ 16:25:
Is het geen eis dat een goed ingenieur in staat is om zelf in heldere taal uit te leggen wat hij gedaan heeft? Of was dat vroeger?

Het beschrijven van de keuzes die je gemaakt hebt voor een computerprogramma gaat echt niet veel anders dan het beschrijven van andere ontwerpkeuzes.

^^

We kunnen er niet veel meer van zeggen dan dat. Beschrijf het doel van jullie applicatie en hoe het ontwerp- en programmeerwerk verlopen is. Als je de opdracht af hebt moet je er toch echt uit jezelf ook wel wat over kunnen schrijven.

Ik doe dit topic op slot; ten eerste omdat het niets met programmeren van doen heeft, en ten tweede omdat je dit gewoon zelf moet kunnen. Ook als Werktuigbouwkunde-afstudeerder.

@je laatste reactie hierboven: hoe een verslag in elkaar dient te zitten verschilt per school, maar meestal wordt gevraagd om grote lijnen zodat het verslag voor een leek ook te lezen valt.

[ Voor 10% gewijzigd door NMe op 06-08-2008 16:36 ]