Mit Versionen im Dokumentationssystem arbeiten

Im Abschnitt Versionen des Dokumentationssystems können Sie für Ihre Dokumentationen Versionen anlegen und verwalten und Ihre Dokumentationen anschließend in diversen Versionen erstellen, etwa wenn Ihr Produkt mehrere parallel laufende Softwareversionen besitzt und Sie zu jeder Softwareversion eine Dokumentation pflegen müssen.

Versionen verwalten

---

Eine Version anlegen

Sie können beliebig viele Versionen für Ihre Dokumentationen anlegen. Die Version steht Ihnen nach dem Anlegen zur Auswahl bei allen Dokumentationen zur Verfügung.

1. Klicken Sie im Abschnitt Versionen auf Versionen verwalten.
2. Klicken Sie auf .
3. Geben Sie eine Version an.
   
    
   

   Eine Version anlegen
4. Wählen Sie, ob die Version Aktiv sein soll. Wenn Sie eine neue Version anlegen, veröffentlichen Sie die Version in der Regel nicht direkt, weil sie sich inhaltlich nicht von der letzten Version unterscheidet. Für Informationen zum Veröffentlichen einer Version siehe Version aktiv schalten.
5. Speichern Sie.
   
   Ergebnis: Das System erstellt die neue Version. Sie können jetzt Dokumentationen zu dieser Version anlegen.

   Tipp: Wenn Sie den Haken bei Aktiv nicht setzen, können Sie die Dokumentation anschauen, indem Sie auf die Schaltfläche Anschauen im Dokumentationseditor klicken und den Bereich und die passende Version wählen. Voraussetzung dafür ist, dass das System die Übersicht für die Version nachts erzeugt hat.

Eine Version aktiv schalten (veröffentlichen)

Sie veröffentlichen eine Dokumentationsversion in der Regel, wenn Sie alle Inhalte, die sich in dieser Version von der letzten Dokumentationsversion unterscheiden, mit der entsprechenden Versionszuordnung erstellt und geprüft haben.

Durch die Veröffentlichung einer Dokumentationsversion wird diese Version aktiv geschaltet. Sie ist dann nicht mehr nur im Dokumentationseditor sichtbar, sondern für Anwender im Dokumentationsbereich als neue, aktuelle Version verfügbar. Beim Veröffentlichen werden die Baumstruktur der Dokumentation und die Verlinkungen aktualisiert. Dabei werden die Dokumentationsseiten mit der neuen Version berücksichtigt, sofern vorhanden, sonst die letzte verfügbare Version.

Gehen Sie wie folgt vor, um eine neue Version der Dokumentation zu veröffentlichen:

1. Klicken Sie im Abschnitt Versionen der Hauptseite eines Dokumentationsbereichs auf Versionen verwalten.
2. Setzen Sie einen Haken im Feld Aktiv bei der Version, die Sie veröffentlichen wollen.
3. Erzeugen Sie die Struktur für die Version mit , wenn Sie die Version direkt manuell erzeugen wollen. Andernfalls wird die Struktur in der folgenden Nacht erstellt.
4. Öffnen Sie die Hauptseiten der anderen Dokumentationsbereiche und führen Sie die Schritte 2 und 3 aus.
   
   Ergebnis: Das System veröffentlicht die neue Version. Sie sehen die neue Version im Dokumentationsbereich: 
   

   Eine Version in der Dokumentationsansicht wählen

Eine Version verschieben

Versionen können Sie in der Liste mit  oder  verschieben, um sie neu anzuordnen.

• Die erste Version in der Liste stellt dabei für das System die neuste Version dar, unabhängig davon, welchen Namen die Version trägt.
• Das System stellt diese erste Version standardmäßig ebenfalls in der Dokumentationsansicht als neuste Version dar. Öffnet also ein Leser eine Dokumentation, stellt das System immer die Dokumentation derjenigen Version dar, die an erster Stelle in der Liste der Versionen steht. Existiert dazu keine Dokumentation, stellt das System die Dokumentation der zweiten Version in der Liste dar, sofern zu dieser Version eine Dokumentation vorhanden ist. Dasselbe Verhalten gilt für alle nachfolgenden Versionen, die in der Liste folgen.

Eine Version löschen

Benötigen Sie eine Version nicht mehr, können Sie sie löschen. Voraussetzung ist, dass keine Dokumentation mehr zu dieser Version existiert.

1. Klicken Sie im Abschnitt Versionen auf Versionen verwalten.
2. Klicken Sie bei der zu löschenden Version auf .
   
   Das System informiert Sie, wenn zu der zu löschenden Version noch Dokumentationen existieren. Speichern ist dann nicht möglich.
3. Speichern Sie.

Eine Dokumentation zu einer bestimmten Version anlegen

---

Nachdem Sie Ihre Versionen angelegt haben, können Sie Ihre Dokumentation in einer dieser Versionen anlegen.

1. Klicken Sie im Abschnitt Versionen auf Neue Version erstellen.
2. Wählen Sie eine Version sowie eine Sprache aus.
3. Klicken Sie auf OK.
   
   Ergebnis: Das System erstellt die Dokumentation in der gewählten Version und Sprache. Sie ist für diese Version und alle nachfolgenden Versionen so lange gültig, bis Sie eine Version der Dokumentation erstellen, die neuer ist als diese Version, also in der Liste der Versionen höher priorisiert ist.
   
   • Damit die Dokumention auch in der Dokumentationsansicht für andere Leser zu sehen ist, warten Sie den nächtlichen Automatismus ab, der die Übersichten erzeugt.
   • Sie können die Übersicht pro Version und Sprache mit auch manuell erzeugen.

 

Schaltfläche „Setze Version von“

Definiert, dass eine Dokumentation ausschließlich ab einer bestimmten Version gilt.

• Wählt ein Leser eine ältere Version in der Dokumentationsansicht, erhält er dort die Dokumentation etwa nicht zur Auswahl, wenn er nach ihr sucht.
• Die Dokumentation ist ab dieser Version so lange gültig, bis Sie eine Version der Dokumentation erstellen, die neuer ist als diese Version, also in der Liste der Versionen höher priorisiert ist.

Schaltfläche „Setze Version bis“

Definiert, dass eine Dokumentation ausschließlich bis zu einer bestimmten Version gilt.

Wählt ein Leser eine neuere Version in der Dokumentationsansicht, erhält er dort die Dokumentation etwa nicht zur Auswahl, wenn er nach ihr sucht.

Eine Dokumentation in einer bestimmten Version bearbeiten

---

Möchten Sie eine bestimmte Version einer Dokumentation bearbeiten, klicken Sie auf die Schaltfläche Version wechseln, sobald sich der Dokumentationseditor öffnet.

Das System stellt die derzeit geöffnete Dokumentation und Version mit dem Zusatz (Aktuell) dar.