Metadaten in der Technischen Dokumentation

Metadaten beschreiben Daten. In der Technischen Redaktion arbeiten insbesondere XML-Redaktionssysteme mit Metadaten, um Informationsbausteine wie Texte, Grafiken oder Illustrationen zu klassifizieren. Aber auch Redakteure, die keine spezielle Software verwenden, nutzen solche Beschreibungen oft unbewusst, wenn sie eine Datei nach einer bestimmten Art benennen. So sind ein Schlüsselbegriff für den Inhalt, das aktuelle Datum und die Version im Dateinamen im weiteren Sinne ebenfalls Metadaten.

Metadaten können unter anderem folgende Informationen beinhalten:

• Textart (anleitend, beschreibend, warnend)
• Produktgültigkeit (zum Beispiel für Variante A)
• Relevanz in einer bestimmten Phase des Produktlebenszyklus (zum Beispiel Wartung)
• Zielgruppe (zum Beispiel Servicetechniker)
• formale Angaben wie das Erstellungsdatum, der Übersetzungsstatus, erfolgte Freigabe, Autor etc.

Metadaten sorgen für Übersicht in einem Dokumentenbestand, der ohne sie in vielen Technischen Redaktionen kaum noch zu überblicken wäre. Sie führen zu einer enormen Zeitersparnis, denn das persönliche „Anschauen“ von Informationsbausteinen, um ihren Inhalt zu erfassen, ist sehr aufwendig oder bei großen Datenmengen gar unmöglich.

Ohne Metadaten kann es zu folgenden Problemen kommen:

• Chaos in der Dokumentenverwaltung
• kein Überblick über Änderungen und Versionen, was Risiken in der Compliance birgt
• Zeitverluste bei der Suche nach Dokumenten
• sinkende Qualität, da das Fehlerrisiko steigt

Insbesondere, wenn Unternehmen mehrere Zielmärkte bedienen oder Produktvarianten anbieten, sind Metadaten unerlässlich. Die Transparenz im Dokumentenbestand ist dabei nicht der einzige Vorteil, wenn Sie mit Metadaten in der Technischen Dokumentation arbeiten. Viele Vorhaben lassen sich ohne sie nicht oder nur umständlich umsetzen, wie wir im folgenden Abschnitt sehen werden.

In einem Redaktionssystem erstellen Sie Inhaltsbausteine, zum Beispiel einzelne Bilder, Grafiken und Textabschnitte. Dieses Prinzip wird als Modularisierung bezeichnet. Werden diese Inhaltsbausteine mit Metadaten versehen, finden Sie diese sehr leicht über die Such- und Filterfunktion. Dies wiederum ermöglicht es Ihnen, bereits erstellte Inhaltsbausteine wiederzuverwenden. So erstellen Sie aus diesen Modulen Betriebsanleitungen und weitere Dokumente automatisiert im jeweils vorab definierten Layout. Das spart Zeit und reduziert redundante Inhalte. Konkret ermöglicht Ihnen dies:

• Publikation für bestimmte Zielgruppen: Mithilfe der Filterfunktion wählen Sie jene Inhalte aus, die sich an eine bestimmte Zielgruppe richten, zum Beispiel Servicetechniker oder Verbraucher. So erstellen Sie zielgruppengerechte Dokumente.
• Wartungspläne generieren: Nicht nur nach der Zielgruppe lässt sich filtern, sondern auch nach der relevanten Phase im Produktlebenszyklus. So entstehen Wartungspläne auf Knopfdruck.
• Publikationen zu bestimmten Produktvarianten: Wächst Ihr Produktportfolio, greifen Sie auf bereits erstellte Inhalte zurück, die auch für eine neue Variante gültig sind. Nur die Inhalte, die sich auf das neue Produkt beziehen, müssen Sie neu erstellen.

Darüber hinaus sind Metadaten für weitere Einsatzzwecke Ihrer Technischen Dokumentation unabdingbar:

• Suchfunktion auf Internetportalen: Produktanwender und Servicetechniker profitieren von einer komfortablen und zielgerichteten Suche auf einer Online-Plattform, auf der sie auf die Inhalte der Technischen Dokumentation zugreifen können.
• Chatbots: Wenn Sie einen Chatbot anbieten möchten, um Anwender oder Servicetechniker mit Ihrer Technischen Dokumentation interagieren zu lassen, sind Metadaten unerlässlich für korrekte Ergebnisse.

Redaktionsintern profitieren Sie von diesen Vorteilen:

• Überblick über Bearbeitungsstatus: Sie verlieren nie wieder den Überblick, in welcher Version, welchem Übersetzungs- oder Freigabestatus sich ein Dokument aktuell befindet.
• Reduzierung der Übersetzungskosten: Sie können Inhalte, die noch nicht übersetzt wurden, leicht erkennen und nur diese in die Übersetzung schicken.
• Identifizieren von Dubletten: Anhand der Metadaten finden Sie identische Inhaltsbausteine und können Dubletten entfernen. Das reduziert Ihren Verwaltungsaufwand und kommt vor allem bei Migrationen zum Tragen.

Anwender eines Redaktionssystems für die Technische Dokumentation können das Potenzial ihrer Software besser ausschöpfen, wenn sie mit Metadaten arbeiten. Diese müssen sie aber nicht alle manuell vergeben: In der Regel zeichnet das Redaktionssystem Bausteine bereits automatisch mit bestimmten Metadaten aus, zum Beispiel mit dem Namen des Autors, dem Freigabe- und Übersetzungsstatus sowie dem Erstellungs- und Änderungsdatum.

Um Metadaten in der Technischen Redaktion zu implementieren, bedarf es einer Strategie und eines Metadatenmodells. Schließlich soll die Metadatenvergabe innerhalb des Teams einheitlich erfolgen, damit sie wirklich einen Nutzen bringt. Oftmals wird das Thema als zu komplex und / oder umfangreich eingeschätzt, um es überhaupt anzugehen.

Tipp: Beschränken Sie sich zunächst auf Metadaten, die in Ihrem Arbeitsalltag relevant und für Ihre Aufgaben wirklich notwendig sind. Mit iiRDS hat die Gesellschaft für Technische Kommunikation (tekom) einen Standard entwickelt, an dem Sie sich orientieren können.

In vielen Technischen Redaktionen besteht Termindruck. Manche Mitarbeitende sehen nicht den Effizienznutzen, sondern vor allem die Zeit, die notwendig ist, um Metadaten zu vergeben.

Tipp: Machen Sie die Vorteile von Metadaten sichtbar und führen Sie den Mitarbeitenden vor Augen, dass das Nachpflegen von vielen Metadaten deutlich aufwändiger ist, als sie direkt beim Erstellen des Inhalts zu vergeben. Achten Sie darauf, dass Metadaten nicht ignoriert oder schlampig angelegt werden: Redaktionssysteme bieten zwar die Möglichkeit, Pflichtfelder zu definieren, aber diese schützen nicht vor falschen Eingaben. Hier hilft es, Motivation zu schaffen und im Review-Prozess auch die Metadaten mitzuprüfen – nicht nur den Inhalt.

Darüber hinaus gilt: Weniger ist oft mehr. Metadatenmodelle sollten sich auf die Informationen konzentrieren, die kurzfristig tatsächlich einen Nutzen für Redaktion oder Endnutzer bringen. Ein überladenes Modell mit zu vielen theoretischen Feldern schreckt eher ab und verstärkt den Eindruck unnötigen Aufwands.

Ist die Metadatenvergabe umständlich und damit ein Störfaktor im Redaktionsalltag, hält dies Mitarbeitende davon ab, die Funktion zu nutzen.

Tipp: Achten Sie bei der Auswahl eines Redaktionssystems darauf, dass es bei der Vergabe der Metadaten leicht und flüssig zu bedienen ist. Im besten Fall verfügt es über eine Automatisierungsfunktion, um viele Inhalte schnell mit Metadaten zu versehen. Im Redaktionssystem SCHEMA ST4 steht dafür AI Jetpack bereit, eine KI-gestützte Plug&Play-Lösung.

Metadaten sind eine Investition in die Zukunftsfähigkeit der Technischen Dokumentation. Mit ihnen sorgen Sie nicht nur für mehr Effizienz in Ihrer Redaktion und Transparenz in der Dokumentenverwaltung. Sie sind auch Grundlage, um Betriebsanleitungen für Ihre Zielgruppen auf benutzerfreundliche Weise zur Verfügung zu stellen. Mit Metadaten schaffen Sie darüber hinaus die Grundlage, um zukunftsweisende Einsatzgebiete wie Chatbots realisieren zu können. Als Technische Redaktion sollten Sie sich daher nicht von möglichen Hindernissen abhalten lassen, sondern das Thema Schritt für Schritt angehen, um langfristig von Metadaten und ihren Vorteilen zu profitieren.