Logo

Onboarding und Archivierung von Forschungsprojekten

Dieser Anwendungsfall bietet einen standardisierten Prozess für Forschungssoftwareprojekte, um deren langfristige Erhaltung und Wiederverwendbarkeit sicherzustellen. Er hilft, den Verlust wertvoller Software zu verhindern, wenn Forschende die Einrichtung verlassen, indem klare Richtlinien für Projekteinrichtung, Versionskontrolle und Dokumentation etabliert werden.

Repository
Idea
Plan
Prototype
Pilot
Live

Übersicht

Mehrwert: Dieser Anwendungsfall bietet einen standardisierten Prozess für Forschungssoftwareprojekte, um deren langfristige Erhaltung und Wiederverwendbarkeit sicherzustellen. Er hilft, den Verlust wertvoller Software zu verhindern, wenn Forschende die Einrichtung verlassen, indem klare Richtlinien für Projekteinrichtung, Versionskontrolle und Dokumentation etabliert werden.

Problem: In Forschungsprojekten entwickelte Software wird oft unbrauchbar oder geht verloren, wenn das Projekt endet oder der/die Hauptforscher*in geht. Dies liegt oft an fehlenden standardisierten Praktiken zur Versionskontrolle und inkonsistenter Dokumentation, wobei die steile Lernkurve von Tools wie Git als Barriere für die Einführung wirkt.

Lösung: Implementierung eines zentralen und nachhaltigen Systems zur Verwaltung von Forschungssoftware durch die Verwendung von Projektvorlagen zur Durchsetzung standardisierter Dokumentation und Versionskontrolle. Dieser Ansatz beinhaltet die Erstellung einer zentralen Landing Page, die alle zugehörigen Projekte präsentiert und sie für die breitere Forschungsgemeinschaft auffindbar und zugänglich macht.

Wer profitiert

Primär

  • Forschende und Ingenieur*innen an der RWTH Aachen
    • Ein klarer, standardisierter Prozess für die Initiierung und Verwaltung von Softwareprojekten.
    • Gesicherte Erhaltung und langfristige Verfügbarkeit ihrer Arbeit.
    • Vereinfachtes Onboarding in Best Practices der Versionskontrolle.

Sekundär

  • Die breitere Forschungsgemeinschaft
    • Zugriff auf eine wiederverwendbare und gut dokumentierte Sammlung von Forschungssoftware.
    • Erhöhte Transparenz und Potenzial für Zusammenarbeit.

Wann geeignet

  • Für jedes neue Forschungsprojekt, das Softwareentwicklung beinhaltet.
  • Wenn das Ziel ist, Forschungssoftware langfristig wiederverwendbar und zitierfähig zu machen.

Wann nicht geeignet

  • Für Projekte, die keine Softwareentwicklung oder digitalen Artefakte beinhalten.

Prozess

  1. 1. Ein*e Forscher*in initiiert ein neues Projekt unter Verwendung einer standardisierten GitLab-Projektvorlage.
  2. 2. Die Vorlage füllt das Repository automatisch mit einer Standardstruktur, einschließlich einer README und einem Wiki.
  3. 3. Der/die Forscher*in entwickelt die Software und folgt dabei den Richtlinien für Versionskontrolle und Dokumentation.
  4. 4. Das Projekt wird automatisch auf einer zentralen Landing Page für die Auffindbarkeit gelistet.
  5. 5. Nach Abschluss wird das Projekt archiviert, um den langfristigen Zugriff zu sichern.

Voraussetzungen

Personen

  • Forschende mit geringen oder uneinheitlichen Kenntnissen in Git.
  • Ein Support-Team zur Bereitstellung von Schulungen und Anleitung.

Daten-Inputs

  • Quellcode für Forschungssoftware.
  • Projektdokumentation und Forschungsdaten.

Tools & Systeme

  • Eine zentrale Git-Plattform (z. B. git.rwth-aachen.de).
  • Ein System, das Projektvorlagen unterstützt.
  • Ein Tool zur automatischen Generierung einer Projekt-Landing-Page.

Richtlinien & Compliance

  • Öffentliche/interne Auffindbarkeit mit Zugriffskontrollen auf Repository-Ebene.
  • Ein obligatorischer Schnellstartkurs zu Git, READMEs, Wikis und Markdown für alle teilnehmenden Forschenden.

Risiken & Gegenmaßnahmen

  • Forschende könnten Widerstand gegen die Einführung neuer, standardisierter Arbeitsabläufe aufgrund der anfänglichen Lernkurve leisten.

    • Bereitstellung eines obligatorischen, aber zugänglichen Schnellstart-Schulungskurses.
    • Verwendung von Projektvorlagen, um den Einrichtungsprozess zu vereinfachen und die Einstiegshürde zu senken.
    • Angebot von direktem Support für Projekteinrichtung und -verwaltung.

Erste Schritte

Zu Beginn benötigen Sie Zugriff auf die angegebene Git-Plattform. Ein obligatorischer Schnellstart-Leitfaden wird bereitgestellt, um die Grundlagen von Git, Dokumentation und dem Projektworkflow abzudecken.

  1. Absolvieren Sie den obligatorischen Schulungskurs zu Git und Projektstandards.
  2. Erstellen Sie ein neues Projekt unter Verwendung einer der verfügbaren Forschungsprojektvorlagen.
  3. Folgen Sie dem standardisierten Workflow für Entwicklung, Dokumentation und Versionskontrolle.

Ressourcen

FAQ

Sind Vorkenntnisse in Git erforderlich?

Nein, aber ein obligatorischer Schnellstartkurs ist erforderlich, um sicherzustellen, dass alle Teammitglieder ein grundlegendes Verständnis der Tools und Workflows haben.

Wie werden Projekte auffindbar gemacht?

Projekte werden automatisch gesammelt und auf einer zentralen, öffentlich zugänglichen Landing Page angezeigt.

Glossar

Projektvorlage
Ein vorkonfiguriertes Repository, das eine standardisierte Struktur und Dateien (z. B. README, Lizenz, CI/CD-Konfiguration) für neue Projekte bereitstellt, um Konsistenz zu gewährleisten.
Landing Page
Eine zentrale Webseite, die mehrere Forschungssoftwareprojekte aggregiert und einen Überblick bietet, um deren Auffindbarkeit zu verbessern.