Automatisierte, konfigurationsspezifische Dokumentation bei Endress+Hauser

Ausgangssituation

Endress+Hauser, ein weltweit führender Anbieter von Mess- und Automatisierungstechnik, will seine Technische Dokumentation auf die Anforderungen der digitalen Produktwelt ausrichten. Die Inhalte liegen zwar bereits strukturiert in XML in einem Redaktionssystem vor, jedoch nicht in der erforderlichen Granularität für eine konfigurationsspezifische und wiederverwendbare Nutzung. 

Mit der ständig wachsenden Produktvielfalt und zunehmenden Variantenkomplexität entstand bei Endress+Hauser der Wunsch, die Technische Dokumentation noch stärker an der jeweiligen Produktkonfiguration auszurichten und Inhalte gezielt wiederzuverwenden. Gleichzeitig sollten Produktdaten aus unterschiedlichen Systemen besser zusammengeführt und für die Dokumentation nutzbar gemacht werden. 

Im Fokus standen dabei folgende Anforderungen: 

  • Bereitstellung passgenauer Dokumentation entsprechend der konkreten Produktkonfiguration – einschließlich der Einhaltung regulatorischer Anforderungen 

  • Konsistente Verfügbarkeit und Nutzbarkeit von Produktdaten aus unterschiedlichen Systemen und Standorten für die Dokumentation 

  • Integration zusätzlicher, technisch relevanter Informationen für spezifische Varianten 

  • Berücksichtigung von Software- und weiteren technischen Datenquellen neben klassischen Produktdaten  

  • Durchgängige Automatisierung der Publikationsprozesse, insbesondere für PDF-Ausgaben 

Projektziele 

Übergreifendes Ziel ist es, Produktdaten, Dokumentationsinhalte und Content-Prozesse enger miteinander zu verzahnen und damit eine skalierbare Grundlage für konfigurationsspezifische, digitale Dokumentation zu schaffen. 

Konkret verfolgte das Projekt mehrere strategische und operative Ziele: 

  • Entwicklung einer nachhaltigen Informationsarchitektur inkl. definierter Workflows für Redaktion und angrenzende Bereiche wie Produktmanagement 

  • Harmonisierung von Produktdaten aus unterschiedlichen Systemen (z. B. PIM) und Einspeisung in einen Knowledge-Graph

Ausschnitt aus dem Knowledge-Graph in Empolis Content Connect
  • Nutzung der Produktdaten als Steuerungsbasis für die Dokumentation: Variantengebende Metadaten sollten nicht mehr manuell im Redaktionssystem gepflegt werden, sondern aus dem Knowledge-Graph kommen und die Dokumentation automatisch steuern. 

  • Umstellung auf topic-basiertes Schreiben mit DITA-XML 

  • Aufbau einer automatisierten Publikationspipeline für PDF-Ausgaben 

  • Ablösung des bestehenden Redaktionssystems durch Content Connect von Empolis mit Oxygen XML Author, inklusive einer Bearbeitungskomponente für die Informationsarchitektur 

parson unterstützt bei Implementierung 

Als technisches System wurde in einem Vorprojekt Empolis Content Connect ausgewählt, das einen Knowledge-Graphen für die Verwaltung der vielfältigen Produktdaten mit einem DITA-Redaktionssystem kombiniert. 

parson unterstützte Endress+Hauser bei der Einführung von Empolis Content Connect entlang der gesamten Content- und Datenkette – von der Produktmodellierung bis zur Publikation. 

Informationsarchitektur und Produktmodell 

  • Unterstützung bei der Harmonisierung der Produktdaten aus den verschiedenen Produktdatensystemen 

  • Konzeption zur konsistenten Nutzung der PIM-Daten im Knowledge-Graph und Schaffung einer Möglichkeit für die Informationsarchitekten von Endress+Hauser, die Produktdaten im Knowledge-Graph zukünftig selbständig zu ergänzen 

  • Unterstützung bei der Einspeisung von Daten, z.B. Software-Parameter, aus firmeneigenen Softwaresystemen in den Knowledge-Graph, die als Grundlage für die Softwaredokumentation dienen

  • Langfristige Unterstützung beim Aufbau eines einheitlichen, unternehmensweiten Produktmodells 

Implementierung der variantengesteuerten Dokumentation 

Gemeinsam setzen Endress+Hauser, Empolis und parson ein Konzept zur automatischen Erzeugung von Dokumentationsvarianten auf Basis verknüpfter Produktdaten um. Dieses Konzept beruht auf drei Säulen: 

Informationsmodell 

  • Definiert Kategorien für alle redaktionellen Inhalte der Endress+Hauser-Produktdokumentation entlang des Produktlebenszyklus vom Einkauf, Transport über die Inbetriebnahme bis zur Wartung 

Ausschnitt des Informationsmodells

Produktmodell 

  • Enthält Produktdaten, die aus Systemen wie PIM, ERP und Softwarekonfiguration importiert werden 

  • Verbindet diese Daten in einem Knowledge-Graph

  • Kennzeichnet variantengebende Produktmerkmale für die Technische Dokumentation 

Variantenauswahlen 

  • Verknüpfen Produktmodell und Informationsmodell 

  • Steuern, welche Dokumentationsinhalte für welche Produktkonfiguration angelegt, wiederverwendet und ausgeliefert werden 

In der redaktionellen Arbeit ist der Redaktionsauftrag ein zentrales Element

  • Er fragt über das Produkt- und Informationsmodell ab, für welche Produktvariante und welche Inhaltskategorien redaktionelle Inhalte benötigt werden.

  • Auf dieser Basis stellt er automatisch die erforderlichen Informationen zusammen und übergibt sie an das Redaktionssystem. 

  • Der/die Technische Redakteur:in erhält ein fertig konfiguriertes Dokumentationsprojekt mit allen notwendigen Informationseinheiten, die über den Knowledge-Graphen schon vollständig mit Metadaten ausgestattet sind. 

Beispielhafter Redaktionsauftrag in Empolis Content Connect

Content-Reengineering 

  • Unterstützung bei der Umstellung auf topic-basiertes Schreiben mit DITA im Redaktionssystem 

  • Überarbeitung der Bestandsdokumentation zur sauberen Trennung von Informationsarten 

  • Vorbereitung auf spätere Auslieferung in ein Content-Delivery-Portal 

Technische Umsetzung 

  • Anpassungen der DITA-DTD an projektspezifische Anforderungen 

  • Einrichtung eines Endress+Hauser-spezifischen Frameworks in Oxygen XML Author, integriert in das Redaktionssystem 

  • Entwicklung einer Publikationspipeline inkl. PDF-Ausgabe mithilfe eines DITA-OT-Plugins 

Testing und Qualitätssicherung 

  • Konzeption und Durchführung funktionaler Tests mit ALM Octane 

  • Bugtracking und Anforderungsmanagement mit Jira 

Projektergebnisse 

Im Projekt wurden die zentralen Grundlagen für eine produktdatengetriebene, konfigurationsspezifische Technische Dokumentation geschaffen: 

  • Nachhaltige Informationsarchitektur 

  • Einheitliches, erweiterbares Produktmodell im Knowledge-Graph 

  • Durchgängige Redaktions- und Publikations-Workflows 

Damit wird Endress+Hauser in der Lage sein, Dokumentation passgenau zur jeweiligen Bestellkonfiguration automatisch zu erzeugen und auszuliefern. 

Die Verknüpfung von Produktmodell und Informationsmodell über den Knowledge-Graph ist für uns ein strategischer Schritt hin zu einer durchgängig automatisierten, variantengesteuerten Dokumentation. parson hat uns nicht nur bei der Systemeinführung begleitet, sondern auch maßgeblich bei der konzeptionellen und strukturellen Ausgestaltung unterstützt. Besonders die Expertise in Produktmodellierung, Metadatenkonzept und Informationsarchitektur war entscheidend dafür, dass wir heute eine tragfähige, skalierbare Grundlage für unsere zukünftige Dokumentationsstrategie haben.

Thomas Ziesing, Technical Content & Translation Process Manager, Endress+Hauser Group Services AG

Ausblick 

Das Projekt wird schrittweise weiter ausgebaut. Geplant sind folgende Aufgaben: 

parson begleitet Endress+Hauser weiterhin mit: 

  • Anpassungen am DITA Open Toolkit 

  • Weiterentwicklung von Oxygen XML und Redaktions-Workflows 

  • Content-Engineering-Leistungen sowie Optimierung von Layouts und PDF-Ausgabe 

Damit bleibt parson ein zentraler Partner für die Digitalisierung der Technischen Dokumentation – mit Fokus auf Content-Strategie, Informationsarchitektur und smarte, produktdatengetriebene Automatisierung von Dokumentationsprozessen.

Über Endress+Hauser AG

Die Endress+Hauser AG ist ein weltweit führender Anbieter von Messgeräten, Dienstleistungen und Lösungen für die industrielle Verfahrenstechnik. Das Unternehmen bietet Prozesslösungen für Durchfluss-, Füllstand-, Druck- und Temperaturmessung, für analytische Messungen sowie Messwertregistrierung und digitale Kommunikation und optimiert so Prozesse hinsichtlich wirtschaftlicher Effizienz, Sicherheit und Auswirkungen auf die Umwelt. Kunden von Endress+Hauser sind in unterschiedlichen Branchen tätig, wie Chemie, Energie und Kraftwerke, Grundstoffe und Metall, Lebensmittel, Life Sciences, Öl und Gas sowie Wasser / Abwasser.