Effiziente Technische Dokumentation von Modellvarianten durch Metadaten

Die Industrie macht es vor: Kaum ein Produktionsprozess läuft heute noch ohne die Verwendung standardisierter Komponenten ab, also Modulen, die in unterschiedlichen Modellvarianten immer wieder verarbeitet werden. Bestes Beispiel dafür ist die Automobilbranche. Ein Konzern mit mehreren Marken unter seinem Dach schafft ein Chassis für Kleinwagen, das bei drei Marken jeweils mit unterschiedlichen Karosseriedesigns und sonstigen Ausstattungen versehen, sowie unter verschiedenen Namen verkauft wird. Das Modul "Chassis" ist bei allen Varianten gleich. Auf diese Weise kann der Konzern die Entwicklungs- und Produktionskosten massiv senken.

Kosten senken und Aufwand minimieren durch Modularisierung

Dieses Prinzip lässt sich auch auf die Technische Dokumentation anwenden oder bildet vielmehr die Voraussetzung, wenn ein praktikables Redaktionssystem vorbereitet und geschaffen werden soll. Hier bestehen die Module allerdings nicht aus materiellen Gegenständen, sondern aus Text- und gegebenenfalls Grafikbausteinen. Damit Kosten und Aufwand gesenkt werden können, müssen die einzelnen Module für die Dokumentation möglichst vieler Produkte passen. Das kann sehr einfach sein, aber auch schwierig bis unmöglich. Bedeutsam ist dabei die Frage, wie die Größen und die Inhalte der Module festgelegt werden sollen.

Module und Modulgrößen sinnvoll festlegen

Ein Kapitel "Grundlegende Sicherheitshinweise", beispielsweise für eine Smartphone-Modellserie kann für jede Gerätevariante völlig identisch sein und als ein Modul im Redaktionssystem abgelegt werden. Ähnliches gilt für Beschreibungen zur Reinigung und Pflege. Falls möglich, lassen sich auch differenzierte Sachverhalte durch sprachliche Feinheiten aneinander anpassen. Beispiel: Ein Hersteller batteriebetriebener Radios produziert zwei Geräte. Modell A braucht sechs Batterien, das kleinere Modell B nur vier. In den Anleitungen könnte es beispielsweise heißen: "Legen Sie die sechs mitgelieferten Batterien ein" oder "Legen Sie die vier mitgelieferten Batterien ein". In dem Fall haben Sie zwei Textvarianten für zwei Anleitungen. Sie können aber auch schreiben: "Legen Sie alle mitgelieferten Batterien ein." Dann haben Sie ein Modul, das Sie für jedes Gerät und für jede Anleitung nutzen können. Bringt der Hersteller später noch Radios mit zwei oder acht Batterien auf den Markt, kann das Modul in deren Bedienungsanleitungen ebenfalls unverändert integriert werden.

Bei den genannten Beispielen handelt es sich um Module in den Größen "Ganzes Kapitel" und "Ganzer Satz". Es können aber auch einzelne Wörter ein Modul darstellen, etwa Farbbezeichungen für Gehäuse. Eine Redaktion für Technische Dokumentation muss deshalb die Produktpalette eines Kunden und ihre Funktionen genau kennen, um die Modulgrößen sinnvoll festzulegen.

Modulverwaltung mit Metadaten

Der zweite wichtige Aspekt ist die Verwaltung und Pflege der definierten Module. Dazu müssen sie nach ihrer Art katalogisiert und mit bestimmten Schlüsseln versehen werden. Diese Metadaten können sich zum Beispiel aus Komponenten zusammensetzen, die folgende Fragen beantworten:

  • Welchen Inhalt hat das Modul?
  • Für welche technische Dokumentation wird es verwendet?
  • Wie ist der Dokumentenstatus?
  • Wer ist der verantwortliche Redakteur?
  • Welche Übersetzungen in andere Sprachen sind bereits vorhanden?
  • usw.

Wann lohnt sich eine Modularisierung, wann nicht?

Für Produkte, die nur eine kurze Lebenserwartung am Markt haben, ist ein aufwändiges Modularisierungsverfahren nicht angebracht. Gleiches gilt für Maschinen und Produktionsanlagen, die von einem Hersteller ganz spezifisch auf einen Kunden und dessen individuelle Arbeitsprozesse zugeschnitten werden, also Einzelanfertigungen mit später nicht mehr verwendeten Komponenten. Die Modularisierung technischer Dokumentationen trägt aber erheblich zur Kostensenkung bei, wenn es sich um langlebige Produkte und Produktreihen handelt, die von Generation zu Generation nur geringfügig verändert und immer wieder aus gleichen Teilen zusammengestellt werden. Dadurch lassen sich Fehler vermeiden und veraltete Informationen schnell nachbessern. Darüber hinaus ergeben sich auch im Übersetzungsbereich deutliche Kostenreduktionen.

unique ist Ihr Full Service Dienstleister für alle Fragen rund um die Technische Dokumentation. Seit unserer Gründung im Jahr 1990 setzen führende deutsche Unternehmen aus Fahrzeugbau, Maschinenbau und weiteren technologieorientierten Branchen sowie viele spezialisierte Mittelständer auf die partnerschaftliche Zusammenarbeit mit uns. Langjährige Kundenbeziehungen zeugen vom Vertrauen unserer Partner und deren Wunsch nach einer kontinuierlichen und nachhaltigen Betreuung.


Das könnte Sie auch interessieren:

Sind Sie sicher, dass Ihre technische Dokumentation sicher ist?

Sollten Sie diese Frage nicht mit einem eindeutigen „JA“ beantworten, hilft Ihnen unsere Dokumentationsanalyse die Unsicherheit zu zerstreuen. Mit Hilfe unserer

Mehr Konsistenz und Qualitätssicherheit für Ihre Texte

Kennen Sie das auch: Unterschiedliche Benennungen von eigentlich gleichen Bauteilen, Geräten oder Funktionen führen zu Fehlbestellungen, unnötigen Rückfragen,

Unsere Beratung hilft Ihnen die Synergien in der technischen Kommunikation zu heben

Projekte der Technischen Dokumentation werden häufig noch als isolierte Aufgaben betrachtet. Dabei bestehen viele Schnittstellen, z. B. durch die Nutzung von

  • Ihr Ansprechpartner

    Olaf Niederlein
    • 0211-50 65 37-25
    Kontaktformular
    1. Name
      Bitte Ihren Namen eintragen!
    2. E-Mail
      Bitte E-Mail-Adresse eintragen!
    3. Nachricht
      Bitte Ihre Nachricht eintragen!
    4. Bitte Datenschutzerklärung akzeptieren