Verzweigungen
Die Verzweigung dient dazu, mehrere Versionen von zusammenhängenden Inhalten zu erstellen. Diese Funktion ähnelt dem Kopieren, ist aber umfangreicher und bietet Ihnen mehr Möglichkeiten, mit Ihren Inhalten zu arbeiten. Mit einem Zweig erstellen Sie eine neue Version einer Publikation oder eines Topics, der sich wie eine Kopie verhält, von der Paligo jedoch weiß, dass er mit der Originalversion in Verbindung steht. Das bedeutet, dass das Original und der Zweig separat als parallele Versionen verwendet werden können oder später wieder zu einer einzigen Version zusammengeführt werden können. Wählen Sie einen der beiden Verzweigungsmodi von Paligo, siehe Verzweigungsmodus auswählen.
Mit einem Zweig erstellen Sie eine neue Version einer Publikation oder eines Topics. Diese neue Version verhält sich wie eine Kopie, aber Paligo erkennt, dass sie mit der Originalversion verwandt ist. Je nach Ihren Anforderung können Sie Folgendes tun:
-
Originalversion und verzweigte Version separat als Parallelversion verwenden
-
Führen Sie das Original und die verzweigte Version später wieder zu einer einzigen Version zusammen.
In der folgenden Abbildung wurde beispielsweise das Benutzerhandbuch „Acme HomeHub“ verzweigt. Das Original (1) und die verzweigte Version (2) existieren beide als separate Publikationen mit getrennten Topics. Sie können sie weiterhin als separate Versionen verwenden oder sie zu einer Publikation zusammenführen.
 |
1 = Original, 2 = Verzweigte Version
Dies ist nur eine Möglichkeit, Verzweigungen zu verwenden. Sie könnten auch verzweigte Publikationen mit wiederverwendeten Topics oder eine Mischung aus wiederverwendeten und eindeutigen Topics haben. Es gibt unzählige Möglichkeiten.
Tipp
Verzweigungen vorsichtig verwenden. Es ist eine leistungsstarke Funktion, die Ihnen helfen kann, Zeit zu sparen, indem Sie verschiedene Versionen von Inhalten erstellen und zusammenführen. Aber ohne sorgfältige Planung kann es auch dazu führen, dass Ihre Inhalte zu kompliziert und schwieriger zu verwalten sind. Wir empfehlen Ihnen, überkomplizierte Verzweigungsstrukturen zu vermeiden.
Häufige Anwendungsfälle für Verzweigungen
Die häufigsten Anwendungsfälle für die Arbeit mit Zweigen:
-
Bearbeitung während eines Versions-Updates – Sie arbeiten an einer Version für ein bestimmtes Produkt, das sich noch in der Entwicklung befindet und gerade aktualisiert wird. Dann steht die nächste Aktualisierung des Produkts an und Sie müssen mit der Arbeit an der Dokumentation für diese Version beginnen, siehe ???.
Sie verwenden eine Verzweigung für die Veröffentlichung der offiziellen Dokumentation für die neueste Produktfreigabe. Sie verwenden die andere Verzweigung, um an Aktualisierungen für die nächste Produktveröffentlichung zu arbeiten.
-
Zwei verschiedene Versionen, die parallel verwendet werden und für die Änderungen erforderlich sind, die leicht in beide Versionen übernommen werden können.
Sie müssen zwei ähnliche, aber unterschiedliche Publikationen aktualisieren und veröffentlichen. Zum Beispiel, wenn Sie Benutzerhandbücher für zwei verschiedene Modelle eines Produkts haben, die nur geringfügige Abweichungen aufweisen.
-
Mit dem Inhalt experimentieren – Sie erwägen einige größere Änderungen an der Dokumentation und der Struktur und Sie möchten experimentieren, bevor Sie die alte Version aufgeben. Führen Sie einen Zweig mit einem anderen Zweig zusammen, siehe Zweige zusammenführen.
Sie erwägen einige wesentliche Änderungen an der Dokumentation und ihrer Struktur. Sie erstellen also eine Verzweigung und verwenden die Originalversion für die Veröffentlichung und experimentieren dann mit einer neuen Struktur in der verzweigten Version. Wenn das Experiment gut verläuft, können Sie die Verzweigung später zusammenführen.
-
Arbeiten an größeren Änderungen, die einige Zeit in Anspruch nehmen werden – Sie arbeiten an einer größeren Änderung für die Dokumentation, die einige Zeit in Anspruch nehmen wird, aber das Entwicklungsteam nimmt viele kleine kontinuierliche Aktualisierungen vor, die Aktualisierungen in der Live-Dokumentation erfordern. Sie müssen also in der Lage sein, zwischenzeitlich zu veröffentlichen, bis die umfassende Überarbeitung der Dokumentation abgeschlossen ist.
Sie müssen Änderungen vornehmen, die viel Zeit in Anspruch nehmen, aber auch regelmäßig kleinere Aktualisierungen veröffentlichen. Sie können eine Verzweigung für Ihre langfristigen Änderungen erstellen und dann entweder die ursprüngliche Verzweigung oder eine andere Verzweigung für die schnellen Aktualisierungen verwenden.
-
Arbeiten während eines Übersetzungsprojekts – Verzweigungen sind notwendig, damit Sie an weiteren Entwicklungen arbeiten können, während die Inhalte übersetzt werden. Lesen Sie hierzu auch Inhalt aktualisieren, wenn Übersetzung nicht abgeschlossen ist.
Sie müssen Inhalte zur Übersetzung senden, aber auch an der nächsten Version der Inhalte arbeiten, während Sie auf die Rücksendung der Übersetzung warten. Dazu müssen Sie Verzweigungen verwenden.
Anmerkung
Verzweigung ist ein leistungsstarkes Tool, das Ihnen viel Zeit spart und die Verwaltung mehrerer Versionen Ihres Inhalts erleichtert. Aber es kann auch komplex zu verwalten sein, daher empfehlen wir Ihnen, es nur zu verwenden, wenn Sie es brauchen, und Sie sollten auch versuchen, Ihre Verzweigung so einfach wie möglich zu halten. Je komplexer Ihre Verzweigung ist, desto schwieriger wird es für die Leute zu verstehen, wie der Inhalt verzweigt wird und an welchen Verzweigungen sie arbeiten sollten.
Erste Schritte mit Verzweigungen
Um Ihre Inhalte in Paligo zu verzweigen, empfehlen wir Ihnen:
-
Stellen Sie sicher, dass Sie die Grundlagen der Verzweigung und Zusammenführung verstehen.
In diesen Einführungsabschnitten erklären wir, wie Verzweigung in Paligo funktioniert:
-
Legen Sie den Verzweigungsmodus für Ihre Paligo-Instanz fest. Wir empfehlen Ihnen, den Modus Konsekutive Verzweigung zu aktivieren, da er die Verzweigung von anderen Verzweigungen ermöglicht, was Ihnen mehr Möglichkeiten bei der Verzweigung bietet. Wenn Sie jedoch einen bestimmten Bedarf haben, nur von der ursprünglichen Verzweigung zu verzweigen, können Sie Paligo stattdessen auf den Modus Vereinfachte Verzweigung einstellen.
Weitere Informationen erhalten Sie unter Verzweigungsmodus auswählen.
-
Entscheiden Sie, welche Teile Ihres Inhalts verzweigt werden müssen und wählen Sie die geeignete Verzweigungsmethode.
Paligo verfügt über mehrere verschiedene Verzweigungsmethoden, die jeweils unterschiedlich funktionieren, da sie für unterschiedliche Szenarien ausgelegt sind. Um herauszufinden, welche Methode für Ihre Anforderungen am besten geeignet ist, siehe Wählen Sie die geeignete Verzweigungsmethode.
-
Ihre Verzweigung erstellen
Weitere Informationen erhalten Sie unter:
-
Wenn Sie eine Verzweigung mit einer früheren oder der ursprünglichen Verzweigung zusammenführen müssen, siehe Einen Topic-Zweig zusammenführen oder Einen Publikationszweig zusammenführen.