people text - Technische Dokumentation. Verständlich. Schnell. Professionell. Technische Dokumentation. Verständlich. Schnell. Professionell.

Was ist Single Source Publishing?

Single Source Publishing ist eine Methode, mit der systematisch wiederverwendbare Inhalte erstellt werden. Die Informationen werden in Modulen angelegt und anschließend für verschiedene Ausgabeformate zusammengestellt. Mit dieser Methode ändert sich also die gesamte Arbeitsweise bei der Dokumentationserstellung in der Technischen Redaktion. Während sonst eher vom Kapitel aus gedacht und die Dokumentation linear erstellt wird, steht bei diesem Prinzip das Modul im Mittelpunkt.

Folgende Aspekte sind relevant:

  • Modulare Erstellung der Inhalte 
    Module können gleichzeitig in verschiedenen Ausgabeformaten verwendet werden. Die Module stehen für sich und sind unabhängig vom Layout, das ihnen erst später zugewiesen wird.
  • Wiederverwendung der Inhalte 
    Wiederverwendbare Inhalte können in vielen verschiedenen Dokumenten verwendet werden. Inhalt und Form sind getrennt: Während des Erstellungsprozesses konzentrieren sich die Redakteure auf die Technische Dokumentation. Formatierungsarbeiten kommen nicht vor.
  • Zusammenstellung der Dokumente
    Die Dokumente entstehen durch die Zusammenstellung einzelner Module. Ein Redaktionssystem verfügt über die Funktionen, aus den modularen Inhalten verschiedene Ausgabeformate zu konvertieren, zum Beispiel Online-Hilfen und Bedienungsanleitungen.

Warum ist Single Source Publishing sinnvoll?

Folgende Gründe sprechen für den Einsatz des Single-Source-Publishing-Verfahrens:

  • Zeit und Geld sparen
    Wenn Sie Inhalte in verschiedenen Dokumenten wiederverwenden, dann sparen Sie Zeit bei der Erstellung. Sie erstellen keine Inhalte doppelt oder noch öfter. Und sie werden nur einmal in die Zielsprache übersetzt.
  • Konsistente Inhalte erstellen 
    Durch die Wiederverwendung der Inhalte wird die Konsistenz von Inhalten unterstützt. Die Qualität Ihrer Inhalte verbessert sich durch diese modulare Arbeitsweise.
  • Mit vielen Redakteuren an einem Dokument arbeiten
    Wenn Inhalte nicht länger in Dokumenten gefangen und im Dateisystem versteckt sind, sondern als Module in einer Datenbank liegen, dann können beliebig viele Autoren gleichzeitig Module erstellen und zu Dokumenten zusammenbauen. Aus mein Dokument wird unser Inhalt.

Wie funktioniert Single Source Publishing?

Voraussetzung für den Einsatz der Single-Source-Publishing-Methode ist die modulare Erstellung der Inhalte. Dazu werden bei der Planung der Technischen Dokumentation Informationsklassen oder –typen entwickelt, um die Inhalte zu klassifizieren. Häufig werden zum Beispiel Handlungsanweisungen und beschreibende Module angelegt. Alle weiteren Klassen oder Typen sind sehr stark abhängig von der zu erstellenden Technischen Dokumentation bzw. von den Ausgabeformaten. Wenn die Vorarbeit der Erstellung der Informationsklassen geleistet ist, werden die Inhalte strukturiert und in den Modulen im Redaktionssystem angelegt. Im letzten Schritt werden die Dokumente zusammengestellt und in ein oder mehrere Ausgabeformate publiziert.

Beispiel: Informationsklasse Releasenote mit der Single-Source-Publishing-Methode wiederverwenden

Releasenotes können in der Bedienungsanleitung, in der Online-Hilfe und in den Trainingsunterlagen vorkommen. Jede einzelne Releasenote wurde im Modul Releasenote angelegt und im Redaktionssystem an entsprechender Stelle abgelegt. Wenn die Bedienungsanleitung erstellt wird, verlinken die Redakteure die Releasenotes aus der Datenbank. Die Releasenotes werden im Dokument angezeigt, bleiben aber in der Datenbank als Quelle. In den Trainingsunterlagen sollen die Teilnehmer ebenfalls über neue Funktionen informiert werden. Wieder nimmt der Redakteur das bereits erstellte Modul und verlinkt es mit seinem Dokument.

Dies ist nur ein Beispiel für das Single Source Publishing. Dieses Prinzip bietet sich besonders im Bereich Maschinenbau mit seinen vielen wiederverwendbaren Kapiteln in den Bedienungsanleitungen als Verfahren an. Und so sparen Sie auch bei der Übersetzung Zeit und Geld.

Wie im Detail die Wiederverwendung bei der Erstellung der Bedienungsanleitung oder anderen Dokumentationen funktioniert, hängt vom Redaktionssystem ab.

Sie haben Fragen? Kontaktieren Sie uns!