Wie stellt man seine selbstgeschriebene Software in seiner Abschlussarbeit dar?

[hmm]

Hi Leute,

ich habe jetzt meine Masterarbeit im Studiengang Mathematik zum Thema Blockchain fast fertig. Die Arbeit handelt großteils von dem Mathematischen Modell, allerdings habe ich auch selber eine kleine Blockchain implementiert und würde gerne in einem Kapitel darauf eingehen.

Wie würdet ihr eure Software in einer Abschlussarbeit beschrieben? Ich würde aktuell so vorgehen, dass ich den Code ins Github pumpe und in der Masterarbeit darauf verweise und beschreibe die man den Code startet. Eine Kompelierte Version des Programms wäre dann im Target. Ich habe ein paar UML Diagramme erstellt, aber leider passen die nicht gut ins DIN4 Format.... würdet ihr UMLs verwenden oder lieber etwas per Freihand skizzieren?

Macht es Sinn den Code zusätzlich dazu in die Arbeit zu übernehmen? Z.B. in den Appendix? Falls ja, wie macht man das am schlausten? Ich habe die Arbeit mit latex geschrieben und möchte ungerne 2000 Zeilen Code einlatexen... ich habe die Software als Spring Applikation gebaut, sollte ich in der Arbeit eine Quelle zu Spring angeben?

[ThomasM]

Hallo hmm,

Wie würdet ihr eure Software in einer Abschlussarbeit beschrieben? Ich würde aktuell so vorgehen, dass ich den Code ins Github pumpe und in der Masterarbeit darauf verweise und beschreibe die man den Code startet. Eine Kompelierte Version des Programms wäre dann im Target.

Am besten mal die Betreuenden fragen, die das ja dann auch bewerten.

Ich würde schon auf Ausführlichkeit setzen, wenn die Software maßgeblich für das Thema ist. Codeteile im Anhang und Komplettdaten auf einem "nichtflüchtigen" Medium fände ich praktikabel. Kenne jetzt die Gegebenheiten nicht, aber PDF-Abgabe auf CD-ROM ist noch gängig an Hochschulen/Hochschulbibliotheken und dann kann Code & Co. mit drauf.

Grüße,
Thomas

[MudGuard]

Hi,

Wie würdet ihr eure Software in einer Abschlussarbeit beschrieben? Ich würde aktuell so vorgehen, dass ich den Code ins Github pumpe und in der Masterarbeit darauf verweise und beschreibe die man den Code startet. Eine Kompelierte Version des Programms wäre dann im Target.

Bei meiner Facharbeit für's Abitur und bei meiner Diplomarbeit hab ich das so gemacht:

1. relevante Quelltextteile (also der jeweils wichtige Algorithmus) wurden in den Text kopiert, einmal als gesamter Block für den Überblick und die Algorithmus-Erklärung
2. soweit nötig, nochmal einzelne Zeilen, wenn es dazu gezielt Anmerkungen zu machen gab.
3. Die restlichen Quelltextteile wie z.B. Parameter-Prüfung, Aufbereitung der Ausgabe, triviale Hilfsfunktionen usw. kamen nicht in den Text.
4. der komplette Quelltext wurde auf Datenträger mitgeliefert (Diskette bei der Facharbeit - damals war CD-Brenner noch nicht alltäglich; CD-Rom bei der Diplomarbeit)

cu,
Andreas a/k/a MudGuard

[Robert B.]

Hallo @hmm,

Wie würdet ihr eure Software in einer Abschlussarbeit beschrieben? Ich würde aktuell so vorgehen, dass ich den Code ins Github pumpe und in der Masterarbeit darauf verweise und beschreibe die man den Code startet. Eine Kompelierte Version des Programms wäre dann im Target. Ich habe ein paar UML Diagramme erstellt, aber leider passen die nicht gut ins DIN4 Format.... würdet ihr UMLs verwenden oder lieber etwas per Freihand skizzieren?

Zuallererst die wichtigste Frage: Gibt es eine Vorgabe seitens der Uni oder des Lehrstuhls?

Ansonsten hängt es ein bisschen vom Umfang des Codes ab. Ich beschriebe aber mindestens den Code, auch mit Diagrammen und Codeschnipseln oder Pseudocode, so dass das Funktionsprinzip verständlich ist.

Übrigens wird Code kompiliert.

Macht es Sinn den Code zusätzlich dazu in die Arbeit zu übernehmen? Z.B. in den Appendix?

Wie gesagt, das hängt von der Länge ab. Du bekommst irgendwas zwischen 50 und 100 Zeilen Code auf eine Seite.

Falls ja, wie macht man das am schlausten? Ich habe die Arbeit mit latex geschrieben und möchte ungerne 2000 Zeilen Code einlatexen…

2000 Zeilen Code sind dann mehr als 20 Seiten Anhang. Die kannst du übrigens in drei Zeilen einLaTeXen:

% in der Präambel:
\usepackage{listings}
\lstset{language=…}

% im document:
\lstinputlisting{…}

Das listings-Paket gehört eigentlich zu jeder „vernünftigen“ LaTeX-Distribution.

ich habe die Software als Spring Applikation gebaut, sollte ich in der Arbeit eine Quelle zu Spring angeben?

Ich halte es für sinnvoll die externen Abhängigkeiten mit anzugeben.

Viele Grüße
Robert