Dokumentation

Um ein Einheitliches Bild zu erhalten sollten sich alle Dokumentationen an die folgenden Richtlinien halten.

Sprache

• Förmliche Anrede verwenden wie Sie, Ihre, usw.
• Möglichkeit statt Zwang verwenden. Z.B. statt: Sie müssen das und das → Sie können mit xy das und das erreichen

Einsatz von Schriften

• Es sollte nicht mehr als Überschrift 3 verwendet werden
• Überschriften über das Menü oben links auswählen und nicht selbst fett oder groß darstellen
• Code sollte im Fließtext mit der Festbreitenschriftart gekennzeichnet werden. Neben der Schriftfarbe unter mehr

Tipp: Um die Formatierung zurück zu setzen finden Sie neben der Schriftfarbe unter mehr -> Formatierung zurücksetzen

Abstände und Umbrüche

Abstände sollten durch die jeweilige Auszeichnung der Textes definiert werden. Bedeute, man sollte vor oder nach einer Überschrift keine händische Leerzeile einfügen. Die Darstellung in der Bearbeiten-Ansicht kann sich gegenüber der tatsächlichen Darstellung unterscheiden. Fließtext sollten auch ohne Umbrüche geschrieben werden da das Styling der Seite die Umbrüche selbst definiert.

Bilder

Tabellen

Codebeispiele

Codebeispiele sollten mit dem Makro Code dargestellt werden. Das findet sich im Menü unter dem Plus-Icon unter Andere Makros (oder strg + shift + a). Dort kann man nach Code suchen. Folgende Einstellungen sollten verwendet werden:

ergibt:

// Man beachte die Code-Guidelines
$foo = 'bar';
$fooA = [
  'index' => 'value'
];

Verknüpfungen

Nützliche Shortcuts