Wiederverwendung von Inhalten
Was bedeutet Wiederverwendung?
Gebrauchsanleitungen, Software-Dokumentation, Bedienungsanleitungen und ähnliche Informationsprodukte, aber auch Schulungsunterlagen, Datenblätter, Kataloge usw. sind Informationsprodukte, die sich sehr gut standardisieren lassen. Durch die Standardisierung wird eine gewisse Gleichförmigkeit erreicht, was in der technischen Dokumentation etwas Positives ist.
Manche Inhalte können nicht nur innerhalb eines Informationsprodukts mehrfach verwendet werden, sondern in mehreren Informationsprodukten. Beispiele:
- allgemeine Sicherheitshinweise in den Gebrauchsanleitungen ähnlicher Maschinen
- Funktionsbeschreibung eines Gerätes in einer Gebrauchsanleitung, in einem Datenblatt, in einem Schulungsdokument
Wenn solche Inhalte als einzelne Module abgelegt wurden, können sie einfach und effizient wiederverwendet werden - nicht mittels Copy & Paste, sondern durch Referenzieren.
Wiederverwendung mit MS Word® o.ä.
Bei der dokument-basierten Arbeit mit einem Schreib- oder DTP-Programm entstehen durch Kopieren und Duplizieren viele Redundanzen, d.h. die gleichen Inhalte kommen vielfach vor.
Beispiele:
- In einem aktuellen Projekt benötigen Sie einen Warnhinweis. Sie erstellen ihn entweder neu oder sie kopieren ihn aus einem anderen Dokument (Copy & Paste).
- Sie möchten eine Gebrauchsanleitung für ein neues Gerät erstellen. Sie beginnen nicht "bei Null", sondern Sie duplizieren nach Möglichkeit eine vorhandene, ähnliche Gebrauchsanleitung.
Alle Inhalte - auch Redundanzen -, die Sie erstellen, müssen gepflegt, Korrektur gelesen, freigegeben und ggf. übersetzt werden. Inhalte, die in einem anderen Kontext bereits fertig waren, müssen im neuen Kontext diese Prozesse noch einmal durchlaufen.
In Schreib- und DTP-Programmen gibt es Möglichkeiten, Inhalte stattdessen als Module auszulagern und mehrfach zu verwenden, zum Beispiel:
- in MS Word® "Objekt einfügen" (mit "Verknüpfung" aktiviert) oder Zentral- und Filialdokumente
- in Adobe InDesign® die Buchfunktion
- in LibreOffice bzw. OpenOffice Globaldokumente
Diese Funktionen haben im professionellen Einsatz in der technischen Dokumentation jedoch mindestens drei potentielle Nachteile:
- Alle Dokumente und Sub-Dokumente (Module) sind Dateien und müssen als solche mit den sehr begrenzten Mitteln der jeweiligen Software und des Betriebssystems verwaltet werden. Es gibt z. B. keine Funktionen wie Versionierung und Übersetzungsverwaltung.
- Ab einer gewissen Komplexität sind diese Funktionen fehleranfällig.
- Es ist relativ schwierig bzw. erfordert ein besonderes Maß an Disziplin, innerhalb der Dokumente Konsistenz zu wahren, beispielsweise auch hinsichtlich der Formatvorlagen.
Wiederverwendung mit dem Redaktionssystem DoX CMS
Mit dem Redaktionssystem DoX CMS arbeiten sie modul- bzw. topic-basiert. Module, die einmal freigegeben und übersetzt sind, brauchen diesen Prozess nicht noch einmal zu durchlaufen. Sie verwenden diese Module wie Bausteine in beliebig vielen Projekten wieder. Die Vorteile:
- Es entstehen kaum noch Redundanzen.
- Sie brauchen weniger Inhalte zu pfegen, freizugeben, Korrektur zu lesen usw.
- Sie sparen Übersetzungskosten ein.
- Die Inhalte sind automatisch konsistent.
Abbildungen
-
Abb. 1: Topics können in beliebigen Zusammenstellungen ("Topic Tree") via Referenzierung wiederverwendet werden.
Danke für Ihr Interesse an DoX CMS.
Was sind Ihre Bedürfnisse für Ihre technische Dokumentation?
Sehr gern überlegen wir in einem Gespräch mit Ihnen, ob und wie DoX CMS Sie bei der Erstellung von Gebrauchsanleitungen, Software-Dokumentation und anderen Informationsprodukten unterstützen kann.