Logo

Effektive Kursinhalte Schreiben

Effektive Kursinhalte Schreiben

In diesem Kapitel lernen Sie, wie Sie ansprechende und informative Kursinhalte mit Markdown erstellen. Wir werden bewährte Praktiken zur Strukturierung Ihrer Inhalte, zur effektiven Verwendung der Markdown-Syntax und zum Schreiben klarer und präziser Erklärungen behandeln.

Grundlagen von Markdown

Markdown ist eine leichtgewichtige Auszeichnungssprache, die Sie verwenden werden, um Ihre Kursinhalte zu schreiben. Hier sind einige grundlegende Markdown-Elemente:

Überschriften

Verwenden Sie # für Überschriften. Mehr #-Symbole erzeugen kleinere Überschriften:

# Hauptüberschrift
## Unterüberschrift
### Kleinere Unterüberschrift

Listen

Für ungeordnete Listen verwenden Sie - oder *. Für geordnete Listen verwenden Sie Zahlen:

- Punkt 1
- Punkt 2

1. Erster Punkt
2. Zweiter Punkt

Codeblöcke

Für Inline-Code verwenden Sie einfache Backticks. Für Codeblöcke verwenden Sie dreifache Backticks:

Verwenden Sie `git commit`, um Ihre Änderungen zu übernehmen.

git add .
git commit -m "Ihre Commit-Nachricht"
git push origin main

[Link-Text](URL)
![Alternativtext](Bild-URL)

Bewährte Praktiken für das Schreiben von Kursinhalten

  1. Mit einem kurzen Einstieg beginnen, nicht mit einer Formel: Vermeiden Sie in jeder Lektion denselben Satz wie „In dieser Lektion lernen Sie …“. Ein kurzer, konkreter Einstiegssatz ist meist besser.

  2. Goal gezielt einsetzen: Verwenden Sie ## Goal, wenn die Lektion einen klaren Arbeitsauftrag hat. Erzwingen Sie es nicht in jeder Lektion.

  3. Verwenden Sie klare, prägnante Sprache: Erklären Sie Konzepte in einfachen Worten und vermeiden Sie technische Fachbegriffe, soweit möglich.

  4. Organisieren Sie Inhalte in Abschnitte: Verwenden Sie Überschriften, um Ihre Inhalte in logische Abschnitte zu unterteilen.

  5. Beispiele einfügen: Geben Sie praktische Beispiele, um Konzepte zu veranschaulichen.

  6. Visuelle Elemente verwenden: Fügen Sie Diagramme, Screenshots oder andere visuelle Hilfen hinzu, um das Verständnis zu fördern.

  7. Takeaway und Check bewusst verwenden:

    • ## Takeaway sollte die Lektion zu einer Regel, einem Muster oder einem mentalen Modell verdichten.
    • ## Check sollte der letzte Selbsttest-Block der Lektion sein.
    • Platzieren Sie danach kein weiteres vollständiges Fazit.

  8. Interaktive Fragen für Selbst-Erklärung nutzen: Reveal-Fragen eignen sich gut, wenn Lernende einen Begriff erklären, zwei Dinge unterscheiden oder eine Diagnoseentscheidung begründen sollen.

  9. Reveal-Antworten als echte Antworten schreiben: Formulierungen wie „Erklären Sie, warum …“ oder „Nennen Sie …“ gehören in die Frage, nicht in die Antwort. Im Reveal sollte bereits eine kurze Musterantwort stehen.

  10. Lektionsenden sauber halten: Wenn eine Lektion bereits mit ## Check endet, sollte danach kein weiterer großer Abschlussblock mehr folgen. Der Check soll sich wie das Ende anfühlen.

Empfohlenes Lektionsmuster

Ein praxistaugliches Standardmuster sieht so aus:

# Titel der Lektion

Ein kurzer Einstiegssatz, der die Lektion einordnet.

## Goal

Nur verwenden, wenn Lernende etwas Konkretes tun sollen.

## Do

Die eigentliche Erklärung, Beispiele und Schritte.

## Takeaway

Eine verdichtete Regel, ein Muster oder eine kurze Zusammenfassung.

## Check

Fragen, Reveal-Prompts oder ein kurzer Selbsttest.

Bei konzeptionellen Lektionen kann ## Goal entfallen.
Bei Abschlusslektionen kann es sinnvoll sein, ## Verify your result von ## Check zu trennen.

Reveal-Fragen gut einsetzen

Reveal-Fragen sind besonders nützlich, wenn sie Lernende dazu bringen, etwas Wichtiges selbst zu erklären:

  • Setup von generiertem Zustand unterscheiden
  • begründen, warum ein Validierungsschritt wichtig ist
  • entscheiden, welche Datei oder welcher Befehl zuerst geprüft werden sollte

Weniger hilfreich sind sie, wenn nur isoliertes Faktenwissen abgefragt wird.

Gute Reveal-Frage:

{{< reveal question="Warum sollten Sie generierten Zustand prüfen statt ihn zu bearbeiten?" >}}
Weil der generierte Zustand dokumentiert, was das Werkzeug tatsächlich erzeugt hat, und Ihnen hilft, das Ergebnis zu verifizieren.
{{< /reveal >}}

Schwache Reveal-Frage:

{{< reveal question="Warum sollten Sie generierten Zustand prüfen statt ihn zu bearbeiten?" >}}
Erklären Sie, warum generierter Zustand wichtig ist.
{{< /reveal >}}

Übung: Schreiben Sie eine Lektion

  1. Wählen Sie eine der Lektionendateien aus, die Sie in der vorherigen Übung erstellt haben.
  2. Schreiben Sie den Inhalt für diese Lektion und wenden Sie die Markdown-Syntax sowie die besprochenen Best Practices an.
  3. Fügen Sie mindestens einen Codeblock, eine Liste und ein Bild in Ihre Lektion ein.
  4. Entscheiden Sie bewusst, ob Ihre Lektion ## Goal, ## Takeaway und ## Check braucht.
  5. Wenn Sie Reveal-Fragen verwenden, schreiben Sie dafür vollständige Musterantworten.

In der nächsten Lektion werden wir behandeln, wie man Medienressourcen für Ihren Kurs hinzufügt und verwaltet.