Analyseanhang: mit README, Datenwörterbuch und Skript nachvollziehbar abgeben

1. Den erlaubten und verlangten Abgabeumfang klären

Kläre zuerst, welche Dateien deine Hochschule tatsächlich verlangt und über welchen Weg sie eingereicht werden sollen. Ein öffentlicher Anhang, eine vertrauliche Prüfungsabgabe und eine interne Projektdokumentation sind unterschiedliche Zugangssituationen. Sammle nicht vorsorglich jede vorhandene Datei in einem ZIP-Archiv. Prüfe Rechte, Vertraulichkeit und institutionelle Anforderungen für das konkrete Material. Dokumentation soll die Analyse nachvollziehbar machen, nicht durch unnötige Weitergabe von Namen, Gesprächsaufnahmen oder Zugangsdaten ein neues Problem erzeugen. Bei Unklarheit ist eine zuständige Entscheidung vor der Abgabe erforderlich.

Erstelle eine eigene Paketliste mit Datei, Funktion, Version und erlaubtem Zugang. Markiere Material, das nicht mitgegeben werden darf, und erkläre die dadurch entstehende Grenze des Pakets. Beispielsweise kann ein freigegebenes Skript vorliegen, während die zugrunde liegenden personenbezogenen Daten nur intern zugänglich bleiben. Erfinde keine alternative Datenbasis, die als echter Originaldatensatz erscheint. Ein ausdrücklich synthetischer Testdatensatz kann den technischen Ablauf zeigen, reproduziert aber nicht automatisch die tatsächlichen Befunde. Diese Unterscheidung muss im README sichtbar sein.

2. Im README den Einstieg und die Dateien erklären

Cornell Data Services empfiehlt für Forschungsdaten ein README, das Interpretation und spätere Nutzung erleichtert. Dazu gehören unter anderem Dateibeziehungen, Verarbeitungsschritte, Softwareinformationen, Variablendefinitionen und Einheiten. Die University of Jyväskylä betont außerdem eine logisch gegliederte Beschreibung, die ohne internes Projektwissen verständlich ist. Übertrage diese Orientierung auf dein Abgabepaket. Ein README ist nicht bloß ein Titelblatt mit deinem Namen. Es sollte erklären, womit eine prüfende Person beginnt und welche Datei welchen Teil der Arbeit nachvollziehbar macht.

Schreibe für dein eigenes Paket einen kurzen Startabschnitt: Zweck, Bezug zur finalen Arbeit, enthaltene Dateien und Reihenfolge der Nutzung. Benenne die tatsächlichen Dateinamen statt allgemeiner Hinweise wie siehe Datenordner. Wenn mehrere Ergebnisse aus demselben Skript entstehen, erkläre ihre Zuordnung zu den Tabellen oder Abbildungen der Arbeit. Das folgende Raster ist ein eigener Vorschlag, keine allgemeine Pflichtstruktur. Lasse Felder weg, die für dein Paket keinen Sinn haben, und ergänze besondere Abhängigkeiten, die ohne Erklärung nicht sichtbar wären.

Weiterführend: Cornell Data Services: Writing READMEs for Research Data

Weiterführend: University of Jyväskylä: README Files for Research Data

3. Variablen und Umcodierungen verständlich dokumentieren

Lege für tabellarische Daten ein eigenes Datenwörterbuch an. Es verbindet den tatsächlichen Spaltennamen mit Bedeutung, Einheit, zulässigen Werten und der Kennzeichnung fehlender Angaben. Begriffe wie score oder gruppe erklären allein kaum, wie eine Variable entstanden ist. Beschreibe bei berechneten Werten auch die zugrunde liegenden Felder und die verwendete Regel. Eine umgepolte Skala muss als solche nachvollziehbar sein. Die Erklärung darf sich nicht allein in einem Skriptkommentar verstecken, den die prüfende Person nur mit Spezialwissen verstehen kann.

Im ausdrücklich fiktiven Lernprojekt könnte zeit_s eine gemessene Dauer in Sekunden bezeichnen und messung den Zeitpunkt vor oder nach einer Aufgabe. Das Wörterbuch erklärt dann auch, wie fehlende Messungen codiert sind und welche Kennung die beiden Zeitpunkte verbindet. Trage keine unnötigen Identifikatoren in die Abgabe ein. Prüfe außerdem, dass Dokumentation und tatsächliche Datei dieselben Namen verwenden. Eine später umbenannte Spalte oder geänderte Kategorie muss im Wörterbuch aktualisiert werden, sonst kann die sorgfältige Erklärung gerade beim entscheidenden Feld in die falsche Richtung führen.

4. Den Rechenweg in einem unabhängigen Durchlauf prüfen

Dokumentiere benötigte Software und tatsächliche Versionen sowie die Reihenfolge deiner Skripte. Verwende innerhalb des Pakets nachvollziehbare relative Pfade, wenn der Arbeitsablauf das ermöglicht. Ein Pfad zu deinem persönlichen Desktop funktioniert auf einem anderen Rechner nicht automatisch. Notiere außerdem, welche Eingabedatei jede Ausgabe erzeugt und welche Verarbeitung zuvor nötig ist. Wenn manuelle Entscheidungen enthalten sind, beschreibe sie ausdrücklich. Ein Analyseskript kann nicht allein einen Arbeitsschritt reproduzieren, der nur in deiner Erinnerung oder einer nicht mitgegebenen Tabellenkopie existiert.

Teste die vorgesehene Reihenfolge in einer frischen Arbeitskopie mit den tatsächlich freigegebenen Eingaben. Prüfe, ob die erwarteten Ausgaben neu entstehen und mit dem finalen Bericht übereinstimmen. Lösche dafür keine Originaldaten. Wenn nur synthetische Eingaben verwendet werden dürfen, teste damit den Ablauf und benenne die begrenzte Aussage dieses Tests. Halte Fehlermeldungen und notwendige Handgriffe im README fest. Ein erfolgreich geöffneter Ordner ist noch kein erfolgreicher Reproduktionsversuch, und eine einmal sichtbare Tabelle beweist nicht, dass sie aus dem abgegebenen Skript erzeugt wurde.

5. Das endgültige Paket auf Inhalt und Schutz prüfen

Vergleiche zuletzt Paketliste, README, Wörterbuch, Skripte und finale Arbeit. Prüfe besonders versteckte Dateien, temporäre Exporte, Protokolle und Konfigurationsdateien auf unnötige private Informationen oder Geheimnisse. Kontrolliere Dateinamen und Versionen und öffne die endgültige Abgabedatei nach dem Verpacken erneut. Wenn Materialien bewusst nicht enthalten sind, muss der beschriebene Zugang tatsächlich geklärt sein. Ein pauschaler Satz, Daten seien auf Anfrage verfügbar, ist unzuverlässig, wenn du sie in Wirklichkeit nicht weitergeben darfst oder keinen zuständigen Ablauf vereinbart hast.

Der Abschlusswerk-Abgabecheck kann die inhaltliche Abschlusskontrolle der Arbeit unterstützen. Er führt nicht automatisch deine Analyseskripte aus und bestätigt keine technische Reproduzierbarkeit oder Freigabe der Daten. Nutze ihn deshalb ergänzend und prüfe das Anhangspaket selbst. Ein guter Endstand macht den Weg von Material über Verarbeitung bis zum Bericht verständlich und benennt verbleibende Zugangsbeschränkungen ehrlich. Damit kann eine prüfende Person nachvollziehen, was das Paket ermöglicht, statt aus einer großen Dateimenge auf eine nicht tatsächlich geprüfte Vollständigkeit schließen zu müssen.