Logo

Erstellung eines Lehrdokuments

Dieser Anwendungsfall beschreibt die effiziente und standardisierte Erstellung von Lehrmaterialien durch Dozierende. Das Lehrdokument wird erstellt und steht Studierenden zur Verfügung.

Idea
Plan
Prototype
Pilot
Live

Übersicht

Mehrwert: Dieser Anwendungsfall beschreibt die effiziente und standardisierte Erstellung von Lehrmaterialien durch Dozierende. Das Lehrdokument wird erstellt und steht Studierenden zur Verfügung.

Problem: Die ineffiziente und inkonsistente Erstellung von Lehrmaterialien aufgrund des Fehlens eines standardisierten, automatisierten und versionskontrollierten Workflows.

Lösung: Das Lehrdokument wird erstellt und steht Studierenden zur Verfügung.

Wer profitiert

Primär

  • Dozierende

Sekundär

  • Studierende, Bildungseinrichtung

Wann geeignet

  • Wenn Dozierende Lehrmaterialien unter Verwendung der git.nrw GitLab-Vorlage mit CI/CD-Automatisierung erstellen.
  • Wenn Versionskontrolle und Peer-Review von Lehrdokumenten erforderlich sind.
  • Wenn Lehrmaterialien als statische Webseiten über Jekyll oder Hugo veröffentlicht werden sollen.
  • Wenn Barrierefreiheit und Unterstützung für Multimedia-Inhalte benötigt werden.

Wann nicht geeignet

  • Wenn kein GitLab- oder CI/CD-Setup verfügbar ist.
  • Wenn Versionierung oder automatisierte Veröffentlichung nicht erforderlich sind.

Prozess

  1. Dozent*in loggt sich bei git.nrw ein.
  2. Erstellen eines neuen Projekts aus der Lehrdokument-Vorlage.
  3. (Optional) Verwendung statischer HTML-Generatoren wie Jekyll oder Hugo, um das Lehrdokument als Webseite zu erstellen und zu veröffentlichen.
  4. Befüllen des Projekts mit Inhalt.
  5. Speichern des Lehrdokuments als Entwurf.
  6. (Optional) Das Dokument wird zur Genehmigung oder für Änderungswünsche an Gutachter*innen gesendet.
  7. Veröffentlichen des Lehrdokuments.
  8. Verlinken des Lehrdokuments im Kurs.

Voraussetzungen

Personen

  • Dozierende
  • Studierende
  • Gutachter*innen
  • GitLab-Administrator*innen

Daten-Inputs

  • Lehrdokument-Vorlagen
  • Multimedia-Assets
  • Kurs-Metadaten

Tools & Systeme

  • GitLab (git.nrw)
  • Jekyll/Hugo
  • GitLab CI/CD-Pipeline

Richtlinien & Compliance

  • DSGVO
  • Sicherheitsrichtlinie der Institution

Risiken & Gegenmaßnahmen

  • Das Lehrdokument konnte nicht erstellt werden, das System bleibt unverändert, der/die Dozent*in erhält eine Fehlermeldung und kann den Vorgang wiederholen.

    • Stakeholder umgehend benachrichtigen
    • Manuelles Fallback-Verfahren bereitstellen

Erste Schritte

Voraussetzungen: Git-Zugriff und konfigurierte Tools/Systeme wie unten aufgeführt.

  1. Repository/Vorlage/Inhalt nach Bedarf vorbereiten
  2. Tools, Berechtigungen und Integrationen konfigurieren
  3. Workflow ausführen und Ergebnisse überprüfen

Ressourcen

FAQ

Wie können Lehrdokumente veröffentlicht werden?

Durch die Verwendung von GitLab CI/CD-Pipelines und statischen Seitengeneratoren wie Jekyll oder Hugo.

Können mehrere Versionen eines Dokuments verwaltet werden?

Ja, die Versionskontrolle wird automatisch durch GitLab-Repositories bereitgestellt.

Können Dokumente Multimedia-Inhalte enthalten?

Ja, Vorlagen unterstützen Text, Bilder, Videos und andere Multimedia-Assets.

Glossar

GitLab Pages
Dienst zum Hosten statischer Webseiten, der in GitLab-Repositories integriert ist.
Jekyll
Generator für statische Seiten zum Erstellen von Webseiten aus Markdown- oder HTML-Vorlagen.
Hugo
Schneller Generator für statische Seiten, geschrieben in Go, zum Erstellen von Webseiten.
CI/CD
Automatisierte Pipeline zum Erstellen, Testen und Bereitstellen von Inhalten.