Wie dokumentiere ich bei einer Abschlussarbeit?

Hallo Zusammen,

ich hoffe einfach mal, dass der Smalltalk bereich halbwegs passend ist für diese kleine Frage. 😃

ich bin Masterstudent der Elektrotechnik und habe mit programmieren gar nicht mal so viel am Hut, habe mir aber für meine Masterarbeit C# angeeignet und ein Programm geschrieben. Logischerweise ist eben auch eine Programmbeschreibung bestandteil der Arbeit. Da ich sowas im Studium nie gehabt habe (ein wenig programmieren ja, aber nicht, wie man sowas richtig dokumentiert) und sich ja hier massenweise Programmierer tummeln, wollte ich mal fragen, ob ihr ein paar Tipps oder so habt, wie man sein Programm für eine solche Arbeit richtig dokumentiert?

Ich habe keine Ahnung, was mit rein kommt und was nicht, wie tief geht das ganze?

Natürlich weiß ich, dass ich meinen Hauptalgorithmus (der essenzielle Teil, der quasi die Arbeit macht) z.B. über einen Pab oder so darstellen und diesen relativ genau beschreiben werde.

Vorher findet jedoch eine ganze Menge Kleinkram statt. Neben dem Einlesen aus der Datenbank, dem Erstellen von Haufenweise Klasse auch Sortiererei mit Graphalgorithmen/Suchalgorithmen etc pp. Würde ich sowas im Pab mit einem Vorgang wie z.B. "Datenanalyse" zusammenfassen und ein einem Absatz ein paar Worte darüber verlieren oder einfach weglassen?

Ich hoffe, ihr habt ein paar gute Ansätze für mich =)
Gruß Tobias

Hallo tobi45f,

eine allgemeine Lösung ist da schwer anzugeben. Grundlegend solltest du je einen Betreuer für die Masterarbeit haben. Der sollte dir genau sagen können was und in welcher Form dort erwartet wird.

Ich kenne es jetzt so, das im eigentlichen Teil der Masterarbeit nur die Relevanten Aspekte des Quellcodes Angesprochen / Dargestellt werden. Das kann dann direkt der Quellcode sein, weil du dir da einen Algoritmus erarbeitet hast. Ein Klassendiagramm weil das Zusammenspiel der Klassen wichtig ist. Ein Flussdiagram weil der Ablauf wichtig ist u.s.w. Im Allgemeinen wird dann der ganze Quellcode im Anhang veröffentlicht oder auf CD mitgegeben. Falls du es für eine Firma entwickelt hast, musst du hier deren Copy Right Bedingung beachten. Es kann sein das du den Quellcode dann gar nicht in deiner Masterarbeit verwenden darfst.

Aber wie gesagt frag da deinen Betreuer.

Moin,
bei mir war das z.B. so, dass ich überhaupt keinen Quelltext in der MA direkt haben durfte. Alles, was an Quelltext abgegeben wurde, war Bestandteil des Anhangs.
Dieser ist komplett mit XML-Kommentaren versehen und sonstige wichtige Stellen durch Kommentare zwischendurch.
Die eingesetzten Entwurfsmuster wurden kurz erklärt.
An Diagrammen hatte ich einen Überblick über die Architektur und ansonsten das, was gerade passte. Wurde z.B. Kommunikation beschrieben, gab es ein entsprechendes Sequenzdiagramm, das dem Detailgrad der dazugehörigen Beschreibung entsprach.

Wie Palin aber schon schrieb, können dir deine Betreuer da mehr zu sagen.
Die solltest du auch auf jeden Fall fragen, da sie es sind, die das letztendlich bewerten und deshalb auch genau wissen sollten, wie sie das gern hätten.
Solltest du unterschiedliche Antworten erhalten, dann kannst du die das auch untereinander abstimmen lassen und bist selbst aus der Diskussion fein raus.

Hi!
Danke für die schnellen Antworten. Ok, also ist das immer verschieden und indiviuell je nach Betreuer. Hätte ja sein können, dass es da eine Art Musterweg gibt, den man einzuhalten hat. Dann werde ich mich mal mit meinem Betreuer absprechen. Danke!

Grüße Tobias

Ich habe einen essenziellen Codeabschnitt (~30 Zeilen) dabei gehabt, allerdings als Anhang auf den ich bei der Erläuterung des Verfahrens hingewiesen habe. Innerhalb meiner Arbeit(en) ist Code eigentlich grundsätzlich nicht zu sehen - wozu auch? Der Algorithmus, den ich entwickelt habe, wurde als Muster von mir ein mal implementiert. Das sollte aber auch in jeder anderen brauchbaren Sprache möglich sein, insofern ist mein C#-Code zwar nice to have, aber zum Verstehen des Ablaufs völlig überflüssig.

Hey,

ich kann zum Thema Masterarbeit jetzt nicht viel mitreden. Was ich dir aber sagen kann ist wie ich meine Abschlussarbeit von meiner Ausbildung Dokumentiert hab.
Da war auch die Aufgabe, ein Programm zu schreiben und zu Dokumentieren. Bei dieser Dokumentation richtet sich das allerdings mehr an 'Laien' als an Experten. (Außerdem ist da viel mit zeiteinplannung, management, Kostenanalyse, etc. dabei was du ja glaub ich nicht brauchst).
Soweit man die beiden Dokumentation aber vom Inhalt her vergleichen kann reichen, wie bredator bereits meinte, sind ein paar gut komentierte zeilen code die das Herzstück des Programms zeigen ausreichend, solange du in deiner Doku drum herum alles verständlich formulierst.

Wie gesagt ich kenn' mich mit Masterarbeiten nicht aus, also mein Wort nicht für bare münze nehmen 😉

MfG
Eniplay

Hallo,
ich hatte in meiner Bachelorarbeit auch einiges an Code produziert. (Allerdings C++) In Absprache mit meinem Betreuer habe ich wirklich wesentliche Code Abschnitte (so maximal 3-8 Zeilen) zur Verdeutlichung bzw. Illustration der im Text getroffenen Aussagen direkt in die eigentliche Arbeit eingebunden. Ich finde eine Beschreibung der Implementierung kann sonst sehr trocken werden unter Umständen.

Alle längeren Codesnippets (Aber bei weitem nicht der komplette Code) kamen in den Anhang. Da war aber auch kein Snippet dabei, das größer als eine DINA4 Seite war (LaTex formatiert)

Hätte ich die Arbeit direkt am Institut wo ich dann abgeben habe gemacht, hätte ich den kompletten Code dann auf CD beilegen müssen. Da ich aber extern die Arbeit geschrieben habe, wurde mir von dort untersagt, den kompletten Code dem Institut zu geben.