Dokumentation von Forschungsdaten

Forschungsdaten-Dokumentation dient dazu, die vorliegenden Daten und ihre Generierung und Bearbeitung zu beschreiben. Und zwar so ausführlich, dass Personen, die auf Ihre Daten zugreifen, Entstehungsprozess, Verarbeitung, ggf. Bereinigung, Analyse und Interpretation der Daten nachvollziehen und die Ergebnisse reproduzieren können. Wie Ihre Forschungsdaten-Dokumentation aussieht, richtet sich in erster Linie nach Ihrer Disziplin und den Gepflogenheiten Ihres Forschungsbereichs.

 

Unten finden Sie ganz konkrete Dokumentationsbeispiele für die TU Wien:

  • Informationen aus dem Lab-Journal: Proben, Vorgeschichte, Kalibrierung des Gerätes, Umgebungsbedingungen, z.B. Raumtemperatur, Luftdruck, Uhrzeit, Sonneneinstrahlung etc., Dokumentation/Archivierung des Originalzustands
  • Informationen darüber, wie ein Monitoringsystem validiert wurde
  • Kontext der Datenerhebung: Struktur und Organisation von Datenfeldern, Variablennamen und Beschreibung
  • Methodik der Datenerhebung: Definition von Codes für den Zugriff auf die Daten und Klassifizierungsschemata
  • Algorithmen zur Transformation und Verarbeitung von Daten: Codes zur Umwandlung von Rohdaten in Daten, die physikalisch interpretiert werden können
  • Codes, z.B. für die Visualisierung: Algorithmen, die zur Erzeugung von Bildern und Filmen benötigt werden
  • README Files
  • Metadaten-Textfiles
  • Codebooks (z.B. bei Befragungen) mit Variablennamen und -beschreibungen
  • theoretische Beschreibung zu den Messdaten (z.B. mit Asyst, LabVIEW)

 

Die Forschungsdaten-Dokumentation stellt eine Ergänzung zur Beschreibung durch Metadaten dar: Metadaten enthalten nur eine Untermenge der in der Dokumentation gesammelten Informationen und dienen in erster Linie der Auffindbarkeit Ihrer Forschungsdaten. Soweit wie möglich sollten Sie aber auch in der Dokumentation Normdaten und kontrollierte Vokabulare für die Beschreibung Ihrer Daten verwenden. In vielen Fällen empfiehlt sich Englisch als Dokumentationssprache.

 

Die Dokumentation hilft den Projektbeteiligten und dem Fördergeber, aber auch interessierten Fachkolleg_innen und Nachnutzer_innen der Daten, die Inhalte richtig einzuordnen und die Forschungsarbeit nachzuvollziehen. Darüber hinaus ist eine Dokumentation aber auch für Sie selbst nützlich, denn sie unterstützt Sie dabei, die Übersicht über Ihre Daten zu behalten und Ihre Tätigkeiten klar zu strukturieren.

Die groben Inhalte und die Struktur Ihrer Dokumentation sollten bereits vor der Erhebung der Daten vorhanden sein und mit dem Fortschreiten des Projektes verfeinert werden. Spätestens bei Projektabschluss sollte auch die Dokumentation vollständig vorliegen, damit die Details zur Datensammlung und Bearbeitung nicht in Vergessenheit geraten. Auf diese Weise können Sie den Aufwand für die Erstellung der Dokumentation minimieren und Verzögerungen bei der Veröffentlichung der Daten vermeiden.

Unabhängig davon, ob für Sie README-Files, data dictionaries, Code-Bücher, Electronic Lab Notebooks oder eine Kombination aus allem das Mittel zum Zweck sind: die wesentlichen Informationen über Ihre Daten müssen klar dokumentiert und gemeinsam mit den Daten verfügbar sein.

Auch inhaltlich variieren die Dokumentationen entsprechend Projektart und Disziplin. Einige der wichtigsten Inhalte haben wir für Sie zusammengestellt:

  • Beschreibung des Entstehungskontextes und der Rand- und Versuchsbedingungen
  • Beschreibung der eingesetzten Methode zur Datenerhebung und –verarbeitung einschließlich der verwendeten Werkzeuge (Geräte und Software)
  • Inhalte aus Versuchsprotokollen, Feldberichten, Laborbüchern
  • gerätespezifische Informationen, die für eine Interpretation der Daten erforderlich sind
  • Beschreibung der durchgeführten Maßnahmen und Verfahren zur Qualitätssicherung
  • Informationen über technische Standards und Kalibrierungen
  • Dokumentation und Erläuterung der benutzten Parameter, Variablen, Abkürzungen und Codes einschließlich der Spaltenüberschriften in Datentabellen
  • Angabe der Datenquelle bei der Verwendung bereits vorhandener Daten (Referenzen, DOI)
  • Dokumentation der beteiligten Personen und ihrer Aufgaben
  • Dokumentation der Rahmenbedingungen für die langfristige Aufbewahrung und Nachnutzung der Daten (Lizenzen, Nutzungsrestriktionen, Embargofristen, Löschungsregeln)
  • Liste aller zugehörigen Dateien und Ordner und eine Beschreibung ihrer Formate und Inhalte
  • Links zu Publikationen, in denen die Daten verwendet oder zitiert werden
  • Links zu zugehörigen oder verwandten Unterlagen und Datensets
  • Links zu allen öffentlich zugänglichen Ablageorten der Daten
  • empfohlene Zitierung der Daten

 

Der Begriff Electronic Lab Notebook (ELN) umfasst Software, die Forschern hilft, Experimente zu dokumentieren, aber auch als Kollaborationswerkzeug und zur Verwaltung des Laborinventars dient. Die Software hilft dabei, den Workflow im Labor digital zu vereinfachen.

Ein elektronisches Laborbuch kann zum Beispiel anstelle eines Papier-Laborbuchs oder -journals für die Dokumentation von Experimenten und Untersuchungen verwendet werden. Es gilt ebenso wie das klassische Papier-Laborbuch in Patentverfahren oder Rechtsstreitigkeiten über das geistige Eigentum als rechtliches Dokument.

Mit Hilfe eines Electronic Lab Notebooks können Sie Ihre experimentellen Verfahren, Notizen und Protokolle organisieren und speichern. Ein Vorteil dieser Art der Datendokumentation ist, dass Metadaten automatisch in der Software angelegt werden.

Weitere Vorteile der ELN-Software:

  • Verwendung auf PCs, Tablets und Handys
  • mehrere Nutzer und kollaboratives Arbeiten möglich
  • direkte Übernahme von Daten aus Analysegeräten
  • Datenintegrität gesichert, Belegbarkeit durch Zeitstempel
  • erhöhte Sicherheit durch Zugriffskontrollen
  • unkompliziertes Speichern und Sichern
  • einfaches Kopieren, Importieren, Exportieren und Verknüpfen von Daten
  • Anbindung an andere Systeme (API)
  • Volltextsuche in sämtlichen Inhalten
  • Verwaltung des Laborinventars

 

An der TU Wien werden Jupyter Notebooks zum Testen von ELN angeboten.
Bei Interesse wenden Sie sich bitte an datalab@tuwien.ac.at.

 

Jupyter Notebook als elektronisches Laborbuch

An der TU Wien werden Jupyter Notebooks als Electronic Lab Notebooks zum Testen angeboten.

Bei Interesse wenden Sie sich bitte an datalab@tuwien.ac.at.