Seitenvergleich

...

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

Einsatz von Schriften

• Bitte Überschrift-Typen 2 - 3 verwendet werden. Die anderen Überschriften-Größen sehen unschön aus und nehmen LesbarkeitÜberschriften werden ab H2 beginnend eingesetzt. Es sollte möglichst so strukturiert werden, dass nicht mehr Zwischenüberschriften notwendig sind.
• Überschriften sollen über das Absatz-Menü (oben links) ausgewählt werden und nicht fett markiert oder oder groß gestellt werden.
• Code sollte im Fließtext mit der Festbreitenschriftart gekennzeichnet werden. Neben der Schriftfarbe unter mehr.

...

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

Klickpfade

Generell sollte auf die Beschreibung von Klickpfaden verzichtet werden. Klickpfade ermöglichen eine Beschreibung ohne Screenshot.

Nachteile:

• Änderungen am Klickpfad in der Anwendung müssen nachdokumentiert werden
• Sie verhindern, dass der Anwender die Anwendung verstehtSie sind schwierig gut und einheitlich zu beschreiben

Manchmal ist es jedoch notwendig Klickpfade zu beschreiben. In dem Fall bitte so:

...

Vorteile:

• Sie vermeiden den Einsatz von Screenshots.
• Sie können mit Icons angereichert werden, die in der Anwendung tatsächlich existieren.
• Achten Sie auf eine konkrete Ansprache: 

Beispiel:

• Klicken Sie in der Navigationsleiste auf und wählen Sie Rechte & Rollen → Rollen.
• Klicken Sie in der Toolbar auf  Datensatz anlegen.
• Geben Sie dieser neuen Rolle einen Namen.
• Wählen Sie die Endpunkte für die diese Rolle gelten soll und die zu gewährenden Autorisierungen.  
• Speichern Sie die neue Rolle.
• Um diese Rolle Benutzern zuzuweisen, folgen Sie dieser Beschreibung → Rechte gewähren.

Bilder

• Bilder sollten mit der maximalen Breite von 800px und in guter Qualität eingebunden werden.
• Bilder sollen immer in Original-Größe platziert werden.
• Auf einen Rahmen oder Effekt soll verzichtet werden. 
• Screenshots sollten nur den relevanten Bild-Bereich enthalten und dementsprechend auch ohne unschönen Hintergrund eingebunden werden.

• vermieden werden.

Screenshots

Wenn man unvermeidbar Screenshots in die Dokumentation einbindet, sollten nur die nötigsten Informationen abgebildet werden. Stellt man einen Datensatz oder eine Tabelle dar, sollte man auf die Breadcrumb oder die Buttons am unteren Bildschirmrand verzichten,

da diese sich ändern könnten. Somit müsste man die Dokumentation anpassen, obwohl sich die eigentliche Thematik nicht geändert hat. Beispiel:

Tabellen

Werden Tabellen sollen mit flexibler fixer Breite erstellt werden. Ziehen Sie die Tabelle nach dem Anlegen auf die gesamte Breite.sollen untereinander platzierte Tabellen die gleichen Breiten haben.

$message = 'we ♥ bb';
$myClass = new myClass();
$myClass->myFunction($message);

$message = 'we ♥ bb';
$myClass = new myClass();
$myClass->myFunction($message);

Codebeispiele

Codebeispiele sollten werden 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

• Klicken Sie in der Navigationsleiste auf und wählen Sie Andere Makros.
• Suchen Sie nach „Code“. Verwenden Sie bitte folgende Einstellungen:
  

...

• Image Added

Beispiel:

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

...

Nützliche Shortcuts

...