Informationen mit Dynamik

Text: Regine Ceglarek Andreas Wolf

Mit iiRDS lässt sich der Austausch von Produktinformationen vereinfachen. Dazu liefert der Standard ein Paket mit einheitlichen Definitionen für die Elemente einer Technischen Dokumentation. In der Praxis eignen sie sich etwa für den Austausch zwischen einer Maschine und einem ERP-System.

Inhaltsübersicht

Lesedauer: 09:15 Minuten

Das Unternehmen HOMAG mit Hauptsitz in Schopfloch fertigt Lösungen für die Holzbearbeitung, von der einzelnen Säge, Bohrmaschine und Oberfräse für kleine Werkstätten bis hin zu integrierten Modulsystemen für ganze Fabriken mit verknüpften Produktionslinien. Die Produkte des Unternehmens sind in mehr als 100 Ländern mit 33 Sprachen im Einsatz.

Beim Thema „Fabrik der Zukunft, Industrie 4.0“ ist HOMAG vorne dabei und setzt auf den dynamischen Austausch von Informationen durch das Internet der Dinge (IoT), um Computer, Maschinen und Menschen miteinander zu verbinden. Alle Personen, die mit den Holzbearbeitungsmaschinen zu tun haben, brauchen eine lückenlose Technische Dokumentation, um effizient und sicher mit den Maschinen arbeiten zu können. Dazu stellt das Maschinenbauunternehmen Inhalte direkt an der Maschine bereit.

Die Technische Dokumentation wurde bislang veröffentlicht, indem die Quellinhalte direkt den im ERP-System gespeicherten Stücklisten zugeordnet wurden. Sobald eine Holzbearbeitungsmaschine auftragsbezogen im ERP-System konfiguriert wurde, stellte ein mit den ERP-Daten verknüpftes Dokumentensystem automatisch entsprechende PDF-Inhalte zusammen. Betriebsanleitungen, Servicehandbücher oder auch Schulungsunterlagen standen unverzüglich digital zur Verfügung.

Neue Prozesse schaffen Bedarf

Die dahinterliegende Systemumgebung, um die Technische Dokumentation an die Maschine zu bringen, war 2016 in die Jahre gekommen und aufgrund der enorm großen Anzahl von Dokumenten schwer beherrschbar. Als auch noch eine Ablösung des alten ERP-Systems anstand, nutzte das Team der Technischen Dokumentation unter Leitung von Andreas Wolf die Chance für eine neue Lösung. Die Anforderungen an diese Lösung lauteten:

  • Beibehalten der baugruppenspezifischen Dokumentation – dieser Ansatz hatte sich in der Praxis bewährt und wurde von der Kundschaft sehr geschätzt.
  • Erneuerung und Standardisierung der Publikationsumgebung – der Erstell- und Verwaltungsprozess für die Technische Redaktion war zu aufwändig geworden und die beteiligten Softwarekomponenten kamen an ihre Grenzen.
  • Beschleunigung des Übersetzungsprozesses – zusätzlich zum aufwändigen und komplexen Erstellprozess war vor der Einführung der neuen System­umgebung der Übersetzungsprozess ein weiteres Sorgenkind. Übersetzungen wurden fast ausschließlich manuell gemanagt. HOMAG schickte Word- Dateien per E-Mail an externe Über­setzungsagenturen und bekam die übersetzten Word-Dateien auf dem gleichen Weg zurück. Dann mussten sie manuell nummeriert, in ein PDF umgewandelt und in das damalige Dokumentensystem hochgeladen werden. Ein aufwändiger und zeit­fressender Prozess, der automatisiert und damit beschleunigt werden sollte.
  • Bereitstellen von Informationen aus der Technischen Dokumentation in der HOMAG Cloud – das Personal für die Maschinenbedienung und der Service sollten ganz leicht und unkompliziert über Probleme an einer Maschine informiert werden und unmittelbar, und, ohne selbst suchen zu müssen, die passenden Informationen präsentiert bekommen.

Erneuerung der Systemumgebung

Zunächst erfolgte die Umstellung von Microsoft Word auf Adobe FrameMaker. Die Software bietet eine komfortable Editierumgebung. Außerdem bietet sie die notwendigen Funktionen für die automatisierte Dokumentengenerierung und die Implementierung von Standards. Gemäß dem Single-Source-Prinzip lassen sich mit FrameMaker sowohl PDF-Daten publizieren als auch XLIFF-Daten für die Übersetzung generieren. Und – nicht zu unterschätzen – es ist eine Anwendung, bei der man die DITA/XML-Funktionen in den Hintergrund stellen kann, damit sich Fachanwenderinnen und -anwender aus Technischer Redaktion, Entwicklung und Konstruktion auf die Erstellung der Inhalte konzentrieren können.

Das Schreiben neuer Informationen findet im Editor von FrameMaker statt. Ein FrameMaker-Plug-in (entwickelt von c-rex.net) sorgt dafür, dass der Redaktion die richtigen und vollständigen Daten zur Verfügung stehen, sie alle notwendigen Informationen bearbeitet und anschließend wieder ins SAP-ERP-System zurückspielen kann, auf einfache Weise:

  • Autorinnen und Autoren checken HOMAG DITA Exchange Packages (HDXP) aus SAP aus.
  • Adobe FrameMaker wird mit dem HDXP als Parameter gestartet.
  • Das FrameMaker-Plug-in entpackt die darin enthaltenen Dateien und öffnet die DITA-Map.
  • Autorinnen und Autoren bearbeiten DITA-Dateien in FrameMaker.

Beim Speichern mit der speziell programmierten Funktion „Save Package“ oder „Publish Package“ wird alles wieder verpackt und in den Ordner gelegt, in dem SAP die Dateien wieder einchecken kann.

Entscheidung für DITA

Die Verwendung des offenen XML-Standards „Darwin Information Typing Architecture“ (DITA) ermöglicht es, die Erstellung topicbasierter Inhalte zu automatisieren und zu standardisieren. Außerdem lassen sich Daten mit Dritten austauschen und verschiedene Arten von Inhalten, einschließlich XML, HTML5, Videos und Grafiken, verwalten.

Verringern der Übersetzungszeit

Im neuen Prozess legt die Redaktion für die Übersetzung in andere Sprachen die benötigten Sprachvarianten an. Dadurch werden in SAP automatisch externe Übersetzungsagenturen beauftragt, denen HOMAG einen direkten SAP-Zugang gewährt hat. Nach der Übersetzung checkt die Übersetzungsagentur die übersetzten XLIFF-Dateien selbstständig wieder in SAP ein. Die zurückgegebene Datei wird in FrameMaker geöffnet und dann für alle Ausgaben, die für verschiedene Dokumententypen benötigt werden, veröffentlicht. Die Automatisierung dieses Prozesses hat die Übersetzungszeiten für die 33 Sprachen auf etwa 50 Prozent verringert.

Die Umgebungen verknüpfen

Die Struktur jeder HOMAG-Maschine – wie sie aufgebaut ist und welche Komponenten verwendet werden – wird vollständig im SAP ERP abgebildet. Während DITA einzelne, eigenständige Inhalte zu einem bestimmten Thema mit identifizier­barem Zweck, die so genannten Topics, zum Aufbau von Dokumenten verwendet, setzt das SAP DMS auf das genaue Gegenteil. Es verwendet eine Komponenten­hierarchie, in der die oberste Komponente eine ganze Maschine ist, gefolgt von den Teilen, aus denen sie besteht. Jede Maschine im ERP-System ist mit einem Auftrag verknüpft. Ihm ist die gesamte Technische Dokumentation zugeordnet und wird darin verwaltet.

Beide Systeme hatten also eine eigene Logik, wie Inhalte organisiert werden. Dafür galt es, eine Lösung zu finden. Diese Lösung bestand in der Einführung der so genannten baugruppenorientierten Dokumentation.

Wir sorgten in der Projektumsetzung dafür, dass in SAP die gesamte zu einer Maschine dazugehörige Dokumentation gebündelt abgelegt werden kann. Als neue Einheit wurden die Macro-Topics eingeführt. Das sind Dokumentationspakete, die in unserem Fall einer bestimmten Komponente oder Einheit einer Maschine zugeordnet sind.

Jedes Macro-Topic wird in einem HOMAG DITA eXchange Package (HDXP) gespeichert, einem speziellen Dateibündel, das bei der Publikation in FrameMaker erstellt wird. Jedes HDXP enthält Assets wie eine DITA-Map, DITA-Topics und SAP-Metadaten (etwa Titel oder Komponenteninformationen), Bilder, Videos und Verweise auf andere Inhaltsmodule und HDXP-Dateien. Abbildung 01 zeigt, wie der neue Publikationsprozess aussieht.

Übersicht über den Publikationsprozess.
Abb. 01 Der neue Publikationsprozess nutzt den DITA-Standard. Quelle Regine Ceglarek und Andreas Wolf

Eine Dokumentation zusammenstellen

Wenn ein neuer Auftrag in das ERP-System eingegeben wird, sammelt die Kompositionssoftware SAP CADDI alle Dokumentations- und Steuerdateien, die mit dem Auftrag zusammenhängen. Sie kombiniert automatisch die PDF-Dateien, erstellt ein Inhaltsverzeichnis und generiert ein Metadatenpaket. Die Dateien werden dann direkt an die HOMAG-Maschine (oder Maschinen für einen großen Fabrikauftrag) exportiert und zur Archivierung zurück ins ERP-System publiziert.

Der Standard im Einsatz

Die bisher beschriebenen Elemente der neuen Systemumgebung und der neu aufgesetzten Prozesse hatten eines der Ziele von HOMAG erfüllt: die Systemlandschaft zu modernisieren und auf zukunftsfähige Beine zu stellen. Nun sollten zusätzliche Vorteile entstehen. Informationen zu den HOMAG-Maschinen sollten nicht nur als gesamte PDF-Dokumente zur Verfügung gestellt werden. Stattdessen sollte es möglich sein, Informationen aus der Technischen Dokumentation so eng mit den Maschinen zu verzahnen, dass Servicepersonal je nach Maschinenzustand automatisch über notwendige Handlungsschritte von Wartungsarbeiten an den Maschinen informiert wird.

Damit eine solche Zusammenstellung von Informationen funktioniert, müssen spezielle Metadaten aus der Technischen Dokumentation geliefert werden. Diese Anforderungen hat die HOMAG-Entwicklung in einer Schnittstellendefinition festgelegt und angegeben, welche Metadaten aus der Technischen Dokumentation benötigt werden.

Weil es bei der Aufgabenstellung um den Austausch von Informationen zwischen zwei verschiedenen Systemen ging, nämlich zwischen der in SAP enthaltenen Technischen Dokumentation und den HOMAG-Maschinen, lag der Blick Richtung iiRDS auf der Hand. Denn iiRDS ist genau der Standard, der die dynamische Abfrage und Bereitstellung von Informationen im Zeitalter des Internets der Dinge und von Industrie 4.0 ermöglichen soll.

Wir prüften, welche der in der HOMAG- Spezifikation geforderten Metadaten in iiRDS vorhanden sind. Dabei stellte sich heraus, dass die Übereinstimmung sehr groß war und es nur wenige Anforderungen gab, die durch iiRDS nicht direkt abgedeckt waren. Es wurde klar, dass der Austausch der Informationen zwischen der Technischen Dokumentation und der HOMAG-Cloud mit Hilfe von iiRDS gelingen könnte (Abb. 02).

Schaubild zum Informationsaustausch.
Abb. 02 iiRDS als Schnittstelle zwischen Systemen. Quelle Regine Ceglarek und Andreas Wolf

Den Standard erweitern

Was sich nicht so ohne Weiteres in iiRDS abbilden ließ, haben wir über die so genannten docking points des iiRDS-Standards ergänzt. Diese dienen dazu, Metadaten aus anderen Standards (zum Beispiel ECLASS) oder eben auch custom-Strukturen für Produkte und Baugruppen zu hinterlegen.

Ein Beispiel dafür ist das Metadatum „QualityFactor“. Es gibt an, zu wie viel Prozent eine in der Technischen Dokumentation beschriebene Prozedur zur Fehlerbehebung in der Vergangenheit zum Erfolg geführt hat. Diese Angabe spielt eine wichtige Rolle für HOMAG, ist so in iiRDS jedoch nicht definiert. Deshalb haben wir die Erweiterungsmöglichkeit von iiRDS genutzt und für den „Quality Factor“ ein so genanntes „custom property“ angelegt. Der dem iiRDS-Standard zugrundeliegende RDF-Standard bot die passende Lösung dafür.

Spezialisierte DITA-Topics nutzen

Im nächsten Schritt haben wir analysiert, was in der bestehenden DITA-Editierumgebung geändert werden musste. Werfen wir dazu einen Blick auf die DITA-Strukturen, die in den HOMAG Dokumentationen vorhanden waren. Dort sind bereits zwei spezialisierte Topics vorhanden:

  • HomagFCR (Fault Cause Remedy) – dieser leitet sich vom Standard- Topictyp „Troubleshooting“ ab.
  • HomagTask – dieser leitet sich vom Standard-Topictyp „Task“ ab.

Diese beiden spezialisierten Topic-Typen haben wir so erweitert, dass bei der Technischen Redaktion von Fehlerbeschreibungen zum einen die benötigten Metadaten erfasst und zum anderen Beziehungen über Links im „Remedy“ zu den Lösungen hergestellt werden können.

Das Arbeiten verändert sich

In der Technischen Redaktion werden die Inhalte wie bislang in der FrameMaker-Umgebung erstellt. Als neue erweiterte Aufgabe müssen nun zusätzlich Metadaten im Prolog des DITA-Topics definiert werden.

Der Aufbau der Topic-Art „Fehlerbeschreibung“ hat sich geändert, um die neuen Anforderungen mit Blick auf iiRDS abzudecken. Handlungsschritte, die die Abhilfe (remedy) zu einem Fehler (fault) beschreiben, werden nicht mehr wie bisher direkt in diesem Topic beschrieben, sondern als Querverweis auf einen Task-Topic angelegt. Das sind geringfügige Erweiterungen in der redaktionellen Arbeit mit vielen positiven Effekten in Nachfolgeprozessen.

Der Publikationsprozess hatte zuvor schon unterschiedliche Kanäle bedient und dafür etwa XLIFF, PDF, Control-files für die Maschine und Trainingsfolien zur Verfügung gestellt. Dieser Prozess wurde nun so erweitert, dass für die Dokumentart „Fehlerbehebung“ ein iiRDS-Paket generiert und zusätzlich zu den anderen Informationen baugruppenbezogen in SAP abgelegt wird.

Der Schlüssel zum Erfolg waren folgende Eigenschaften der HOMAG Erstell- und Publikationsumgebung:

  • baugruppenbezogene Dokumentation mit Hilfe von DITA
  • Spezialisierung von DITA Topics
  • Nutzung und Erweiterung von iiRDS

Die letzte Abbildung zeigt, wie der Prozess heute aussieht.

Übersicht über den Erstellungsprozess.
Abb. 03 Der neue Publikationsprozess basiert auf FrameMaker, DITA und dem ERP-System; mit der Hilfe von iiRDS werden Informationen mit der Maschine ausgetauscht. Quelle Regine Ceglarek und Andreas Wolf

Fachwörter und Abkürzungen definiert

 

  • iiRDS (intelligent information Request and Delivery Standard) ist ein technischer Standard für die Auslieferung digitaler Anwenderinformationen. Der Standard wird seit 2016 von einer Expertengruppe der tekom entwickelt. Seit 2018 wird er vom iiRDS-Konsortium gepflegt und weiterentwickelt.
  • RDF steht für Resource Description Framework. Es bezeichnet eine technische Herangehensweise zur Formulierung logischer Aussagen über beliebige Dinge (Ressourcen). Im RDF-Modell besteht jede Aussage aus den drei Einheiten Subjekt, Prädikat und Objekt, wobei eine Ressource als Subjekt mit einer anderen Ressource oder einem Wert als Objekt näher beschrieben wird.
  • Die Darwin Information Typing Architecture (DITA) ist ein XML-basiertes Format zur Erstellung topicorientierter Inhalte. DITA wird vom OASIS DITA Technical Committee als freie Architektur entwickelt und steht als Dokum­ent­typ­definition (DTD) kostenlos zur Verfügung. DITA basiert auf XML.
  • HDXP ist die Abkürzung für HOMAG DITA eXchange Package, ein spezielles Dateibündel, das zur Ablage in SAP genutzt wird.
  • Information 4.0 könnte man als die Informationskomponente von Industrie 4.0 bezeichnen. Diese Informationen zeichnen sich dadurch aus, dass Informations­nutzende (Menschen oder Maschinen) je nach Bedarf genau die nötigen Informationen für das entsprechende Szenario aufrufen oder unterstützend angeboten bekommen.
  • Docking points (Andockpunkte) sind ein Merkmal von iiRDS, das es Unternehmen ermöglicht, dem Standard eigenes Vokabular hinzuzufügen. iiRDS stellt ein gemeinsames Vokabular für Inhalte der Technischen Dokumentation zur Verfügung. Es ermöglicht Anwendern und Anwendungen, Inhalte auf der Grundlage gemeinsamer Begriffe zu suchen und abzurufen. Beispiele hierfür sind standardisierte Begriffe für Produkt­lebenszyklusphasen (etwa Wartung und Betrieb) und Informationstypen (zum Beispiel Aufgabe und Lernen). iiRDS standardisiert keine Begriffe, die vom Hersteller oder Lieferanten des Produkts definiert werden, wie zum Beispiel Komponentennamen oder Produktmerkmale. Für diese Fälle bietet iiRDS Andockpunkte, die es iiRDS-Generatoren ermöglichen, ihr eigenes Vokabular hinzuzufügen.
  • Die ausgeschriebene Bezeichnung von XLIFF lautet „XML Localization Interchange File Format“. Das erklärt schon eine Menge. Wir haben es mit einem standardisierten XML-Dateiformat zu tun, das eingeführt wurde, um den Datenaustausch zwischen verschiedenen Tools im Lokalisierungsprozess zu standardisieren. Es ermöglicht die Strukturierung der zu übersetzenden Daten und das Hinzufügen von kontextbezogenen Metadaten, um eine kontextsensitive Übersetzung zu gewährleisten.
 

 

Titelseite von Ausgabe 06 2022.