Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

  • 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 vermieden werden.

...

Codebeispiele werden mit dem Makro Code dargestellt werden.

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

Beispiel:

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

...

Auf Bildern, Screenshots und Videos dürfen keine Personen oder Gegenstände gezeigt werden die das nicht möchten oder nicht lizenziert sind. Es sollen auch keine Namen von echten Personen verwendet werden. Namen können mit bspw. mit https://uinames.com/ generiert werden.

Verknüpfungen

Confluence bietet die Möglichkeit auf andere Seiten zu verweise wie z.B. Button. Diese Funktion findet sich im Menü unter Verknüpfung einfügen (strg + k). Dort wählen Sie einfach die relevante Seite aus.

Info
iconfalse
titleTipp

Es kann dort auch bei „Erweitert“ auf eine spezielle Überschrift verknüpft werden. Ein Beispiel.

Nützliche Shortcuts

...

.

...