Die Richtlinien dienen zur Qualitätssicherung, sollen eine einheitliche Lernerfahrung auf serlo.org gewährleisten und beantworten praktische Fragen zur Erstellung und Bearbeitung von Artikeln und Kursen.

Natürlich ist es schwer jede Richtlinien zu berücksichtigen aber keine Sorge, alle Bearbeitungen werden von den erfahrenen Communitymitgliedern korrekturgelesen und sie geben dir Feedback. Gerne kannst du auch das Kommentarfeld unter dem Artikel oder dem Kurs für Fragen nutzen.

Die Richtlinien sind nicht in Stein gemeißelt, wir freuen uns über Ideen und Verbesserungsvorschläge als Kommentar zu dieser Seite.


Inhaltsverzeichnis

Überschriften

Jeder Artikel und manche Kursseiten sind durch (hierarchisch abgestufte) Überschriften gegliedert. Siehe Richtlinien Gliederung der Artikel und Gliederung der Kurse

Überschriften gliedern

Vor die erste Überschrift eines Artikels setzt man im Editor ##, genannt "h2". Die h1 Überschrift ist dem Titel des Artikels überlassen.

Vor die erste Überschrift einer Kursseite setzt man im Editor ###, genannt "h3". Die h1 Überschrift ist dem Titel des gesamten Kurses überlassen und die h2 Überschrift ist dem Titel der Kursseite überlassen.

Vor jede weitere untergeordnete Überschrift setzt man immer eine Raute mehr. ###, ####, usw.

Überschriften und Layout

Um die Gliederung mit h2-Überschriften in Artikeln bzw. h3-Überschriften in Kursseiten auch im Editor zu erkennen wird für jede Überschrift rechts eine neue Layout-Reihe erstellt (rechts auf das Plus klicken und auswählen).

Welches Layout du wählst, ist abhängig vom Inhalt und deinen eigenen Überlegungen zum Aufbau des Artikels. Ein paar Hinweise zur Anordnung von Grafiken und Beispielen findest du weiter unten.

Überschriften verlinken

In Artikeln und Kursen sollen die Überschriften nicht direkt verlinkt werden.

Hervorhebungen

  • [Verlinkt]() werden alle Begriffe zu denen ein in diesem Kontext relevanter Artikel existiert - nach jeder großen Überschrift genau einmal. Verlinkte Begriffe werden nicht zusätzlich fett oder kursiv geschrieben.

  • Fettgedruckt werden die wichtigsten Begriffe des Artikels, wenn sie nicht als Links dargestellt werden. Beispiele:

  • Eine Nullstelle ist die Lösung …

  • … löst man mit der Mitternachtsformel

  • Kursiv können alle "metawichtigen" Begriffe geschrieben werden, z. B. Arbeitsschritte oder alles, das einem selbst bei einem Artikel wichtig ist.

Satzzeichen werden außerhalb der Formatierungsumgebungen gesetzt.

Formeln im Text

Alle mathematischen Symbole (Formeln, Funktionen, Parameter, Variablen, etc.) werden in der Formelumgebung "%%\%\%\;\%\% %%" geschrieben: %%f(x)=2x^2+1%% statt f(x)=2x²-1.

Willst du eine wichtige Formel schreiben, die abgesetzt vom Text steht, verwendest du die Formelumgebung %%\$\$\;\$\$%% $$a^2+b^2=c^2$$

Details zur Formelformatierung findest du auf der entsprechenden Seite.

Platzierung von Grafiken

Für das Platzieren von Grafiken und Bildern gibt es mehrere Möglichkeiten.

Grafiken werden an den linken Rand gesetzt, wenn sie das wichtige Element sind und der Text nur das Bild beschreibt oder erklärt.

An den rechten Rand kommen sie, wenn die Bilder den Text unterstützen und zur Veranschaulichung dienen.

Du kannst allerdings auch Bilder so platzieren, dass sie sich über die ganze Seitenbreite erstrecken. Das ist möglich, wenn die Grafik besonders wichtig ist, wichtige Ergebnisse präsentiert oder ansonsten zu klein wäre.

Tabellen

Die schönste Möglichkeit Tabellen anzulegen ist durch Verwendung eines mehrspaltigen Layouts im Editor.

Falls du aber mehr Spalten brauchst oder gerne ein Gitter in der Tabelle hättest, ist auch eine selbstangelegte Tabelle im Editor möglich. Das ist z. B. der Fall bei Wertetabellen. Eine Anleitung für das Anlegen von Tabellen findest du auf der Hilfeseite für Markdown.

Beispielaufgaben

Bei vielen Artikeln und Kursen werden Beispiele vorgerechnet und weitere Aufgaben eingebunden - siehe Richtlinie: Artikel - Gliederung. Das Beispiel, das direkt in dem Artikel oder Kurs vorgerechnet wird sollte sich vom Layout an der Richtlinie: Aufgabenlösungenorientieren. Dafür ist ein mehrspaltiges Layout nötig. Darin schreibst du dann den Rechenschritt in die linke Spalte und das weitere Vorgehen in die rechte Spalte. In der Regel erhält jeder Rechenschritt eine neue Zeile im Layout.

Abkürzungen, Einschübe und Listen

Texte müssen nicht immer ganz ausgeschrieben werden. Geläufige Abkürzung wie z. B. "z. B." schreibst du aber bitte mit einem Leerzeichen zwischen Wörtern.

Auch bei Einschüben mit Strichen - die hier - oder Klammern ( ) setzt du bitte aus Übersichtlichkeitsgründen davor und dahinter ein Leerzeichen.

Bei Listen gibt es im Editor zwei Varianten. Setzt du im Editor eine Leerzeile, dann kommt ein Abstand zwischen die Listenelemente; schreibst du die Zeilen direkt untereinander, dann werden sie auch so ausgegeben.

Verbesserung der Übersichtlichkeit

Um Artikel so zu schreiben, dass jeder neue Helfer sich auch sofort im Editor des Artikels zurechtfindet, solltest du auch dort sauber gliedern und schreiben, aber ohne zuviel Platz zu benutzen. Optimal wäre es, wenn der Quelltext in der Struktur möglichst nahe am gerenderten Text ist. (Das ist aber mehr als Schönheitsideal gedacht und nicht immer umzusetzen.)

So solltest du unnötige Leerzeilen, -zeichen oder Tabstopps vermeiden, dabei aber auch genug Absätze einfügen, um den Fließtext lesbarer zu machen.

Kommentieren Kommentare