Confluence Cloud ist eine flexible Plattform mit einer Reihe von Features und Add-ons, die dir helfen, technische Dokumentation zu erfassen, zu verteilen und zu aktualisieren. Im Folgenden findest du einige Tipps, um deinen Dokumentationsbereich einzurichten und den Lebenszyklus deiner Dokumentation effizient zu verwalten.

Dokumentationsbereich erstellen

So richtest du deinen Dokumentationsbereich ein:

1. Wähle Bereiche in der Confluence-Seitenleiste aus, dann Alle Bereiche anzeigen und wähle Einen Bereich erstellen aus.
2. Wähle Dokumentationsbereich aus (er enthält eine angepasste Übersicht mit einem Suchfeld – dem Livesearch-Makro (Englisch) – um nur in deinem Dokumentationsbereich zu suchen, ein Zuletzt-aktualisiert-Makro (Englisch) und weitere nützliche Funktionen) und klicke auf Weiter.
3. Gib deinem Bereich einen Namen und klicke auf Erstellen.

Confluence erstellt automatisch den Bereichsschlüssel und die Bereichsübersicht. Du kannst die Übersicht jederzeit anpassen – die Gestaltung liegt ganz bei dir!

Inhalte wiederverwenden

Wenn du etwas mehrfach in deinem Dokumentationsbereich verwenden möchtest – ob ein Wort, Satz oder Absatz, ein Bild, eine Produktversionsnummer oder etwas anderes – kannst du es einmal erstellen und auf beliebig vielen Seiten einbinden (oder im Header und/oder Footer verwenden). Wiederverwendungen ersparen dir das wiederholte Eintippen und vereinfachen Änderungen – es ist viel besser, eine Information an einer Stelle zu aktualisieren als an 47!

Es gibt drei Makros für die Wiederverwendung von Inhalten:

• Auszug-Makro (Englisch): Definiert einen wiederverwendbaren Abschnitt auf einer Seite – füge Inhalte in dieses Makro ein und verwende sie auf beliebig vielen Seiten wieder.
• Auszug einschließen (Englisch) (excerpt-include): Bezieht den Inhalt eines Auszugs auf eine andere Seite.
• Seite einschließen (Englisch) (include): Bindet den gesamten Inhalt einer Seite auf einer anderen Seite ein.

Angenommen, du erstellst Release Notes für jede Hauptversion deines Produkts und möchtest die Einleitung jeder Release-Notes-Seite auf einer „Was ist neu”-Seite anzeigen. Lege jede Release-Notes-Einleitung in ein Auszug-Makro und füge dann für jede Release-Notes-Seite ein Auszug-einschließen-Makro zur „Was ist neu”-Seite hinzu. Die Einleitungen erscheinen automatisch auf der „Was ist neu”-Seite und aktualisieren sich, wenn du die Release Notes änderst.

1. Auszüge: Die Einleitungen dieser Seiten befinden sich in Auszug-Makros.
2. Auszug einschließen: Dies sind Auszug-einschließen-Makros.

Ein weiteres Beispiel ist eine der Methoden, die Atlassian für das Seite-einschließen-Makro nutzt. Immer wenn das Auslassungszeichen ●●● in der Atlassian-Dokumentation erscheint – zum Beispiel „gehe zu ●●● > Kopieren” – steckt dahinter ein Seite-einschließen-Makro. Atlassian hat eine Seite mit nur diesem Bild, die überall eingebunden wird, wo das Auslassungszeichen benötigt wird.

Warum ein Seite-einschließen-Makro für ein einzelnes Bild? Falls das UI-Element einmal geändert wird: Wenn das Bild auf jeder Seite separat eingebettet ist, müssten unter Umständen 50 Seiten aktualisiert werden – mit dem Seite-einschließen-Makro reicht eine einzige Änderung. Außerdem lässt sich über ●●● > Seiteninformationen nachvollziehen, wie viele Seiten das Bild einbinden.

Inclusions-Bibliothek erstellen (optional)

Du kannst Inhalte von jeder Confluence-Seite einbinden, aber du kannst auch eine „Inclusions-Bibliothek” anlegen, die speziell für Wiederverwendungen gedacht ist. Die Inclusions-Bibliothek ist kein eigenes Confluence-Feature – die Seiten darin sind normale Confluence-Seiten. Das ist nur eine Technik, die du nutzen kannst, wenn du Inhalte speziell zur Wiederverwendung aufbewahren möchtest.

So erstellst du deine Inclusions-Bibliothek:

1. Wähle Erstellen aus und erstelle eine neue Seite in deinem Bereich.
2. Gib einen passenden Titel ein, z.B. „_ConfluenceInclusions” (der Unterstrich vor dem Titel signalisiert, dass diese Seite besonders ist).
3. Füge Inhalte ein und wähle Veröffentlichen aus. Gib Text ein, der den Zweck der Inclusions-Bibliothek und die Wiederverwendung von Inhalten erklärt.
4. Wähle neben dem Bereichsnamen in der Seitenleiste Weitere Aktionen (●●●) aus, dann Bereichseinstellungen.
5. Öffne das Menü Inhalte und wähle Neu anordnen aus.
6. Wähle den spitzen Winkel > aus, um den Seitenbaum aufzuklappen.
7. Ziehe deine neue Seite über die Bereichsübersicht.
8. Gehe zu deiner neuen Inclusions-Seite und wähle Erstellen aus, um untergeordnete Seiten mit wiederverwendbaren Inhalten hinzuzufügen.
9. Speicherort der Inclusions-Bibliothek: Ziehe die Inclusions-Bibliothek über die übrige Dokumentation.

Da die Seiten an den Root des Bereichs verschoben wurden, erscheinen sie nicht im Abschnitt Seiten deines Bereichs. Sie werden jedoch von anderen Suchen erfasst, da es sich um normale Confluence-Seiten handelt.

Seitenvorlagen verwenden

Das Erstellen von Seitenvorlagen spart viel Zeit, wenn du viele Seiten mit demselben Layout erstellst. Wenn du ständig dieselben Makros wie Panels oder Inhaltsverzeichnisse hinzufügst, lohnt es sich, diese in einer Vorlage zu speichern. Du kannst mit einer beginnen, aber erstelle so viele wie du brauchst, um deine Effizienz zu maximieren.

So erstellst du eine Seitenvorlage, die in allen Bereichen verfügbar ist:

1. Wähle ⚙️ oben rechts aus, um die Confluence-Administration zu öffnen.
2. Öffne Einstellungen > Konfiguration in der linken Navigation.
3. Wähle Globale Vorlagen und Blueprints aus.
4. Klicke auf die Schaltfläche Globale Seitenvorlage hinzufügen oben rechts.
5. Erstelle deine Vorlagenseite und klicke auf Speichern.

Für detaillierte Informationen zu Seitenvorlagen, siehe Vorlagen und Blueprints.

Um schnell zu Globale Vorlagen oder einer anderen Admin-Seite zu gelangen, drücke / und beginne den Namen der Admin-Seite einzutippen.

Inhalte entwerfen

Wenn du eine neue Dokumentationsseite erstellst, möchtest du sie schrittweise schreiben, zwischenspeichern und von ausgewählten Personen prüfen lassen. Eine grobe Beschreibung dieses Workflows ist „Entwurf, Überprüfung, Veröffentlichung”.

Du möchtest nicht, dass halbfertige Seiten von deinen Nutzern gesehen werden, und die meisten Dokumentationen müssen vor der Fertigstellung geprüft werden. Hier ist eine Technik für das Entwerfen von Seiten und die Freigabe zur Überprüfung:

1. Erstelle eine Seite und schränke die Berechtigungen ein – beispielsweise so, dass nur dein Team oder bestimmte Personen die Seite sehen können. Auf einer öffentlichen Instanz könntest du die Sichtbarkeit auf Mitarbeiter beschränken, sodass die Allgemeinheit die Seite nicht sehen kann.
2. Schreibe den Seiteninhalt.
3. Teile die Seite mit den Prüfenden und bitte sie um Feedback. (Stelle sicher, dass du ihnen den Zugriff auf die Seite nicht eingeschränkt hast!) Die Prüfenden können Kommentare unten auf der Seite hinzufügen oder Text markieren, um Inline-Kommentare hinzuzufügen. Mit entsprechender Berechtigung können sie den Seiteninhalt auch direkt bearbeiten.
4. Veröffentliche die Seite, wenn sie fertig ist:
   1. Lösche alle Kommentare auf der Seite.
   2. Entferne die Seiteneinschränkungen, damit deine Zielgruppe die Seite sehen kann.

Die Seite ist jetzt veröffentlicht. Die Bereichs- und globalen Berechtigungen bestimmen nun, wer die Seite sehen und/oder bearbeiten kann.

Links und Anker verwenden

Links hinzufügen

In jedem Dokumentationsbereich ist es wichtig, von einer Seite auf eine andere verlinken zu können – und oft auf bestimmte Abschnitte einer Seite. Du kannst jede URL auf einer Confluence-Seite einfügen, und Confluence erkennt sie automatisch und wandelt sie in einen Link um.

Wenn du die URL einer anderen Seite in deiner Confluence-Instanz einfügst, zeigt Confluence den Seitennamen als Linktext an und macht daraus einen relativen Link – ändert sich der Seitenname, passt Confluence den Link automatisch an.

Anker hinzufügen und verlinken

Jede Überschrift in Confluence kann als Anker verwendet werden, um auf eine bestimmte Stelle auf der Seite zu verlinken.

Nützliche Makros

Confluence bietet eine große Auswahl an Makros (Englisch). Hier sind einige, die besonders nützlich für die technische Dokumentation sind:

Inhaltsverzeichnis-Makro

Das Inhaltsverzeichnis-Makro hilft dabei, lange Seiten zu navigieren, indem es die Inhaltsstruktur zusammenfasst und Links zu den Überschriften bietet. Du musst nichts weiter tun, als das Makro hinzuzufügen – es erkennt Überschriften automatisch.

Info-Panels

Oft gibt es beim Erstellen von Dokumentation Elemente auf einer Seite, die du hervorheben oder auf die du die Aufmerksamkeit der Lesenden lenken möchtest. Verwende das Panel-Element (Englisch), um Info-, Warn-, Erfolgs- und andere benutzerdefinierte Panels zu erstellen und wichtige Hinweise hervorzuheben.

Änderungen verfolgen

In Confluence arbeiten oft mehrere Personen an einer einzigen Seite. Als technische Autorin oder Autor musst du wissen, was mit deinen Dokumenten passiert – sowohl während der Überprüfung als auch nach der Veröffentlichung.

Seiten oder den Bereich beobachten

Um über Änderungen informiert zu bleiben, empfiehlt es sich, Seiten oder sogar den gesamten Bereich zu beobachten. So erhältst du E-Mail-Benachrichtigungen, wenn Änderungen an beobachteten Seiten vorgenommen werden oder jemand darauf kommentiert – und erfährst, wer was geändert hat.

Wähle auf einer Seite in deinem Dokumentationsbereich die Schaltfläche Beobachten oben rechts aus. Von dort aus kannst du wahlweise nur diese Seite oder alle Seiten im Bereich beobachten.

Seitenverlauf anzeigen

Confluence erstellt jedes Mal, wenn jemand eine Seite bearbeitet, eine neue Version. Der Seitenverlauf zeigt alle Versionen mit Datum, Autor und etwaigen Kommentaren zur Aktualisierung.

Um den Seitenverlauf anzuzeigen, gehe zur Seite und wähle ●●● > Seitenverlauf aus. Dort kannst du:

• Den Inhalt einer bestimmten Version anzeigen
• Eine bestimmte Version wiederherstellen
• Zwei beliebige Versionen vergleichen, um zu sehen, was sich geändert hat

Liste der Beitragenden anzeigen

Wenn du auf einen Blick sehen möchtest, wer eine Seite aktualisiert hat, kannst du das Beitragende-Makro hinzufügen. Es zeigt eine anpassbare Liste der Personen, die eine Seite erstellt, bearbeitet oder (optional) kommentiert haben.

PDF-Export anpassen

Wenn du eine PDF-Version deiner Dokumentation bereitstellen möchtest – ob per E-Mail, Download, Druck oder auf anderem Weg – kannst du das Aussehen der PDF mit Titelseite, Kopf- und Fußzeile anpassen. Der Prozess hängt davon ab, ob du den PDF-Export für einen einzelnen Bereich oder für deine gesamte Instanz anpassen möchtest. Weitere Details findest du unter PDF-Exporte anpassen.

Weitere nützliche Tools und Apps

Du kannst Apps verwenden, um Confluence entsprechend deinen Dokumentations- und Workflow-Anforderungen zu erweitern. Hier sind einige nützliche Apps aus dem Atlassian Marketplace (Englisch), von denen Atlassian die meisten selbst nutzt:

Copy Space

Copy Space ermöglicht es einem Bereichsadministrator, einen Bereich inklusive aller Seiten zu kopieren – ideal für Bereichsvorlagen. Außerdem nützlich, wenn du beim Versionswechsel eine Archivkopie eines Bereichs erstellen möchtest: Kopiere den Bereich, gib ihm einen neuen Namen und bewahre ihn auf – ohne den bestehenden Bereich zu verlieren.

Die App kopiert derzeit keinen Seitenverlauf, keine Blogbeiträge und keine E-Mails.

Gliffy

Gliffy bietet eine intuitive Drag-and-Drop-Oberfläche zum Erstellen von Diagrammen, Wireframes, Flowcharts und mehr. Exportiere Diagramme in mehreren Formaten (JPEG, PNG, SVG) und füge Flowcharts, UI-Wireframes und Netzwerkdiagramme direkt in Confluence-Seiten ein, um deine Ideen visuell zu kommunizieren und sie leichter verständlich und schneller im Team zu verbreiten.

Lucidchart Diagrams Connector

Lucidchart Diagrams Connector ermöglicht das Erstellen und Einbinden von Diagrammen direkt in der Confluence Cloud-Instanz – Flowcharts, Wireframes, UML-Diagramme, Mind Maps und mehr in einem umfangreichen Editor.