...
- Förmliche Anrede verwenden wie Sie, Ihre, usw.
- Möglichkeit statt Zwang verwenden. Z.B. stattBeispiel: Sie müssen das und das → Sie können mit xy das und das erreichen
Einsatz von Schriften
- Es sollte nicht mehr als Überschrift Bitte Überschrift-Typen 1 - 3 verwendet werden. Die nachfolgenden Überschriften sehen unschön aus und nehmen Lesbarkeit.
- Überschriften sollen über das Absatz-Menü (oben links auswählen ) ausgewählt werden und nicht selbst fett oder groß darstellenmarkiert oder oder großgestellt werden.
- 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. BedeuteBedeutet, man sollte darf 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 sollten mit der maximalen Breite von 800px und in guter Qualität eingebunden werden. Auf einen Rahmen oder Effekt sollte soll verzichtet werden. Screenshots sollten nur den relevanten Bild-Bereich enthalten und dementsprechend auch ohne unschönen Hintergrund eingebunden werden.
Tipp: Firefox bietet eine Screenshot-Funktion mit der es Möglich ist einen speziellen DOM-Node zu screenshotten um tatsächlich nur dieses Element auf dem Screenshot zu haben https://developer.mozilla.org/en-US/docs/Tools/Taking_screenshots#Taking_a_screenshot_of_an_element.
Tabellen
Tabellen sollten sollen mit flexible flexibler Breite erstellt werden. Ziehen Sie die Tabelle nach dem Anlegen auf die gesamte Breite.
Überschrift | Beschreibung | |||||||
---|---|---|---|---|---|---|---|---|
->myFuntion(
| Codebeispiel in einer Tabelle |
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 werdenVerwenden Sie bitte folgende Einstellungen:
ergibt:
Codeblock | ||||||
---|---|---|---|---|---|---|
| ||||||
// Man beachte die Code-Guidelines $foo = 'bar'; $fooA = [ 'index' => 'value' ]; |
...