Telefon: +49 911 1335-1335

Technische Dokumentation

Nur einmal anfassen

Mit Redaktionssystemen lassen sich Texte und Grafiken für Kataloge, Broschüren und Handbücher effizient verwalten. Doppelarbeit wird vermieden, weil viele Daten mehrfach verwendet werden können. Von Stefan Freisler

Unternehmen, die Industriegüter und andere erklärungsbedürftige Produkte vermarkten, müssen aufwändige Produktinformationen vorhalten. Die Kunden müssen vor einem Verkauf (Presales) mit Katalogen und Broschüren informiert werden. Wenn sie das Produkt erworben haben (Postsales), brauchen sie gut verständliche Handbücher und Trainingsunterlagen.

Die Informationen, die in diese Publikationen einfließen, entstehen entlang des gesamten Entwicklungsprozesses an unterschiedlichen Stellen. Werden diese nicht mit einem zentralen System verwaltet, entstehen hohe Kosten, da Produktbeschreibungen mehrfach erstellt und übersetzt werden. Unternehmen können mit einer durchgängigen Informations- und Dokumentationssystematik Doppelarbeit vermeiden, also vorhandene Synergiepotenziale weitreichend ausschöpfen. Die Qualität kann deutlich gesteigert werden, die Kosten sinken. Industrieunternehmen erstellen zu ihren Produkten unterschiedliche Dokumentationswerke wie Kataloge, Wartungsanleitungen, Anwendungsbeschreibungen, Hilfetexte oder Schulungsunterlagen. Bietet das Unternehmen seine Produkte weltweit an, müssen diese in unterschiedlichen Sprachen verfügbar sein. Ohne geeignete IT-Systeme und eine straffe Organisation geht schnell der Überblick über die Werke verloren, womit der Dokumentationsaufwand ins Unermessliche steigt.

In der Regel setzt sich eine Maschine oder Anlage zu einem überwiegenden Teil aus Standard-Modulen zusammen und nur zu einem geringen Teil aus individuellen Komponenten. Somit ist für eine effiziente Erstellung der technischen Dokumentation eine wesentliche Grundbedingung gegeben: Die Texte und grafischen Objekte können mehrfach verwendet werden.

Entscheidend ist, dass eine durchgängige Informationssystematik eingerichtet wird: Sie muss immer eingesetzt werden, wenn technische Informationen für Produkt-, System- und Anlage-Dokumentationen erstellt werden. Produktinformationen sollten sowohl online als auch für gedruckte Dokumentationen ohne Konvertieraufwand genutzt werden können.

Um dies zu erreichen, ist die Einführung eines XML-basierten Redaktionssystems notwendig. Eine fein gegliederte Verwaltung von einzelnen Informationseinheiten in XML gewährleistet, dass sich Inhalte für unterschiedliche Verwendungszwecke und Zielgruppen darstellen lassen und somit verschiedene Sichten auf die Informationsbasis erlauben. Textbausteine, teilweise ganze Textstrukturen (z.B. Kapitel) und auch Grafiken werden dann mehrfach verwendet. Der Redakteur stellt die Inhalte, die für die zu publizierenden Dokumentationen relevant sind, strukturiert zusammen und definiert damit die Werke als Anwenderhandbuch, technische Anleitung oder Wartungsbeschreibung.

Gleichzeitig reduzieren sich die Übersetzungskosten in hohem Maße. Denn die Mehrfachnutzung von Texten zieht sich über alle Sprachvarianten von Dokumentationen hinweg. Ein zusätzlicher Produktivitätsgewinn entsteht bei Änderungen von Texten und der damit einhergehenden Übersetzung der Modifizierungen. Ändern sich in einer Dokumentation lediglich einige Textpassagen, so werden diese zur Neu-Übersetzung herausgefiltert. Eine komplette Überarbeitung des Gesamtwerkes ist nicht mehr erforderlich.

Ein weiterer Produktivitätsgewinn ergibt sich bei der Publikation der Werke. Dadurch, dass alle Inhalte medienneutral in XML verwaltet werden, sind sie aus einer Quelle auf unterschiedlichen Medien wie CD, Druck oder online publizierbar. Darüber hinaus können quasi per Knopfdruck zielgruppenspezifische Dokumente zusammengestellt werden. Weiterer Vorteil: Qualität und Konsistenz der technischen Dokumentationen verbessern sich.

Nimmt man beispielsweise eine Maschine, die in zehn Varianten ausgeliefert wird, so müssen auch zehn Dokumentationen verfügbar sein. Die Menge an Informationsprodukten potenziert sich, wenn die Werke online, auf CD und als Printausgabe produziert und auch übersetzt werden sollen. Ändert sich in der Maschine ein Teil, müssten nach herkömmlicher Arbeitsweise sämtliche Dokumentationen aktualisiert und übersetzt werden. Mit Hilfe eines XML-basierten Redaktionssystems wird lediglich der jeweilige Informationsbaustein modifiziert und übersetzt. Bei der anschließenden Produktion sind sämtliche Dokumentationen der Maschinenvarianten aktualisiert.

Externer Kontakt: Stefan Freisler ist Geschäftsführer der Schema GmbH Electronic Documentation Solutions, Nürnberg (stefan.freisler@schema.de).
 

WiM – Wirtschaft in Mittelfranken, Ausgabe 11|2009, Seite 34

 
Device Index

Alle Ansprechpartner/innen auf einen Blick