iiRDS - der neue Auslieferungsstandard für die Technische Dokumentation

von Ulrike Parson am 17. November 2016

Oder: Was wir für die Standardisierung der Content-Delivery von intelligenten Informationen tun können

Auf der tekom-Herbsttagung 2016 stellte die Arbeitsgruppe „Information 4.0“ der Gesellschaft für Technische Kommunikation die ersten Arbeitsergebnisse zum neuen Auslieferungsstandard für Technische Dokumentation im Zeitalter von Industrie 4.0 vor: iiRDS.

Warum iiRDS?

iiRDS steht für Intelligent Information Request and Delivery Standard. Die Arbeitsgruppe „Information 4.0“ beschäftigt sich mit der Frage, in welcher Form und mit welchen Eigenschaften Technische Dokumentation im Zeitalter von Industrie 4.0 bereitgestellt werden muss. Es geht also primär um die technischen Eigenschaften der Auslieferung, nicht um die Inhalte der Dokumentation selbst.

Mit der fortschreitenden Digitalisierung, Industrie 4.0 und dem Internet of Things ist das Handbuchkonzept für technische Informationen überholt. Technische Dokumentation wird zu intelligenten Informationen, die folgende Funktionen erfüllen:

Sich dynamisch an Benutzer und Anwendungskontext anpassen.
Zielgerichtete Informationen für alle Lebenszyklusphasen, von der Spezifikation bis zur Wartung, liefern.
Zum ausgelieferten System passen und dies auch nach Konfigurationsänderungen und Updates.
Assistenzinformationen, Sensorinformationen und Betriebsparameter dynamisch integrieren.
Vielfältige Such- und Filterfunktionen unterstützen.
Auf verschiedenen Endgeräten anzeigbar sind.
Vom Benutzer erweiterbar sind.
Sichere Kommunikation unterstützen.
Sich mit anderen intelligenten Informationen, z.B. von anderen Herstellern, vernetzen.

Setzen auch Sie auf intelligente Informationen und iiRDS. So geht's.

Auch wenn iiRDS etwas sperrig klingt, so ist es doch wichtig, dass in diesem Akronym nicht nur „delivery“, also Auslieferung, sondern auch das Abfragen (request) intelligenter Informationen seinen gleichberechtigten Platz erhält. Denn der Zugriff auf intelligente Informationen ist genauso wichtig wie ihre Auslieferung.

Topics und Metadaten in vernetzter Dokumentation

Der gezielte und granulare Zugriff auf Informationen und die dynamische Anpassung von Dokumentation an Benutzer, Kontext und Gerät erfordern, dass Dokumentation nicht mehr als Dokument, sondern als eine Menge von einzelnen Themen (Topics) ausgeliefert wird. Zu Zeiten des klassischen Handbuchs wurde die Zugehörigkeit eines Abschnitts zu einem Produkt, einer Zielgruppe, einer Lebenszyklusphase aus dem Kontext des Dokuments deutlich, wenn er z.B. zum Wartungshandbuch für Service-Techniker des Produkts ABC gehörte.

Lösen wir das Handbuch als Dokument auf und liefern einzelne Topics aus, dann brauchen wir Metadaten, um diesen Kontext herzustellen und aus der großen Menge von Topics den richtigen für einen bestimmten Anwendungszweck oder Nutzer zu finden. Metadaten liefern diesen Kontext und gehören deshalb genauso zur Auslieferung wie die Inhalte selbst.

Einer der Grundgedanken von Industrie 4.0 und dem Internet der Dinge ist es, dass sich Anlagen, Geräte und Komponenten intelligent miteinander vernetzen, um bestimmte Funktionen oder Dienste bereitzustellen. Im Rahmen von Industrie 4.0 entwickeln sich zahlreiche Standards, um die Definition und Kommunikation technischer Komponenten zu standardisieren. Einige Beispiele sind OPC-UA¹, AutomationML² und das allgemeine Referenzarchitekturmodell RAMI 4.0³.

Doch wie vernetzt sich die Dokumentation der Geräte verschiedener Hersteller? Vielleicht heißt das „Wartungshandbuch“ bei dem anderen ja „Reparaturanleitung“ und der Servicetechniker heißt Monteur? Wie steuert eine Anwendung, die Topics für einen Servicetechniker abrufen soll, die Suche und Darstellung der Informationen?

Die Metadaten, die wir mit unserer Dokumentation ausliefern und unsere Inhalte semantisch erschließbar machen, müssen also standardisiert sein. Nur so werden Dokumentationsinhalte über Herstellergrenzen hinweg austauschbar und nutzbar. Das ist das Grundanliegen von iiRDS.

Was lässt sich standardisieren?

Die PI-Klassifikationsmethode von Prof. Ziegler⁴ bietet eine hervorragende Methode zur Definition von Metadaten für modulare Inhalte wie Topics. Die Inhalte werden nach Produkt- und Informationskriterien klassifiziert, z.B. der Zugehörigkeit zu einem bestimmten Produkt oder einer Komponente, der Beschreibung spezifischer Funktionen oder der Eignung für bestimmte Zielgruppen.

Metadatenkonzepte nach der PI-Klassifikationsmethode werden oft firmenspezifisch entwickelt, weil jedes Unternehmen eine andere Produktstruktur und andere variantengebende Faktoren hat.

Variantengebende Faktoren bestimmen den Unterschied in der Dokumentation für verschiedene Produktvarianten, z.B. die Automodelle innerhalb einer Automarke. Wie sollen wir das vereinheitlichen? Ganz einfach: Wir standardisieren die allgemeinen Metadaten, die technische Dokumentation als solche beschreiben, und nicht die produktspezifischen Metadatendaten.

iiRDS konzentriert sich deshalb zunächst auf die Metadaten zu den Informationen selbst und bietet Andockpunkte für produktspezifische und variantengebende Metadaten, die von den Unternehmen selbst definiert werden. Damit sich an den Andockpunkten andere Metadaten-Klassifikationen anbinden können, verwendet iiRDS Technologien des semantischen Webs und definiert seine Taxonomie im RDFS-Format⁵.

Standardisierte Metadaten

Der erste Entwurf von iiRDS soll Ende März 2017 veröffentlicht werden. Die Grundstrukturen wurden jedoch bereits auf der tekom-Herbsttagung kurz vorgestellt:

Die zentrale Informationseinheit ist die InformationUnit, die entweder ein Paket, ein Dokument, einen Topic oder ein Fragment innerhalb eines Topics repräsentiert. Jede Informationseinheit ist über eine IRI (Internationalized_Resource_Identifier) direkt ansprechbar.

iiRDS bietet definierte Typen für Dokumente, u.a. Betriebsanleitung und Wartungsanleitung. Auch die Topic-Arten werden definiert, u.a. Aufgabe und Lernen.
Zu jeder Informationseinheit gibt es funktionale Metadaten und Produktmetadaten. Zu den funktionalen Metadaten zählen z.B. benötigte Werkzeuge, Wartungsintervalle, Ereignisse wie Fehlermeldungen oder Qualifikationen der Zielgruppe. Zu den Produktmetadaten zählen Produktvarianten, variantengebende Metadaten wie Funktionen oder Komponenten.

Diese Metadaten bilden damit erstmalig ein standardisiertes Vokabular für technische Dokumentation ab. iiRDS wird in der ersten Fassung in Deutsch und Englisch verfügbar sein.

Die iiRDS-Metadaten können verwendet werden, um Informationen entsprechend des Kontextes abzufragen, z.B. die Handlungsanweisungen für einen Servicetechniker, die zu einer bestimmten Störungsmeldung gehören:

Standardisiertes Paketformat

Ebenfalls auf der Herbsttagung vorgestellt wurde ein erster Entwurf des Paketformats, in dem iiRDS-konforme Daten ausgeliefert werden können. Ein Auslieferungspaket mit technischer Dokumentation wird aus Inhaltsdateien (z.B. im HTML- oder XML-Format) und einer Steuerdatei mit den Metadaten im RDF-Format bestehen.

Noch nicht alle Unternehmen erstellen Topic-basierte Dokumentation. Zudem gibt es viel Bestandsdokumentation, die nicht in neue Formate wie HTML5 konvertiert werden kann. Aus diesem Grunde arbeitet die Arbeitsgruppe „Information 4.0“ an einem Stufenkonzept für das Paketformat:

Auf Level 1 enthält das Auslieferungspaket komplette Dokumente, z.B. im PDF-Format, und dazugehörige Metadaten.
Auf Level 2 enthält das Auslieferungspaket Dokumentationsmodule, z.B. Topics in HTML5 oder XML, und Metadaten für die Module.
Auf Level 3 enthält das Auslieferungspaket Dokumentationsmodule inklusive Metadaten für Topics und Fragmente von Topics. So lassen sich auch einzelne Warnhinweise innerhalb von Topics adressieren.

Bei der Demonstration des Datenaustauschs solcher Pakete zwischen verschiedenen Herstellern auf der tekom-Herbsttagung wurde deutlich, dass die standardisierten Metadaten und das Paketformat die Auslieferung von intelligenten Informationen über Hersteller hinweg möglich machen. Zu den Herstellern, die sich beteiligt haben, gehörten u.a. Adobe, Schema Systems GmbH, Empolis Information Management GmbH, FCT AG, Docufy GmbH, Acolada GmbH und practice innovation.

Was iiRDS nicht ist: Ein Erfassungsstandard

iiRDS soll die Austauschbarkeit von technischer Dokumentation über Hersteller- und Gerätegrenzen hinweg ermöglichen. Dazu dienen ein einheitliches Paketformat und Metadaten, die das Vokabular für technische Dokumentation standardisieren. Deswegen müssen wir aber nicht in diesem Standard schreiben. Vielmehr muss der Auslieferung der Dokumentation, bei der Erzeugung der Ausgabeformate sichergestellt werden, dass die erzeugten Dokumentationspakete dem iiRDS-Standard entsprechen. Das Metadatum für Ereignisse z.B. kann also in ihrem Redaktionssystem ganz anders heißen, wichtig ist nur, dass die Ausgabemechanismen das als iiRDS-Metadatum ausliefern. Analog können Informationen, die in iiRDS als Metadaten modelliert werden, beim Schreiben jedoch als semantische XML-Elemente erfasst werden, bei der Erzeugung der Ausgabe umgesetzt werden. Beispiele hierfür sind Informationen zu Wartungsintervallen oder benötigten Werkzeugen, die vom Technischen Redakteur in XML-Elementen erfasst werden, bei der Ausgabe aber zusätzlich als Metadatum des entsprechenden Topics angelegt werden.

iiRDS regelt auch nicht die Darstellung der Inhalte. Damit die Inhalte verschiedener Hersteller gleich gut aussehen, bedarf es noch einer Verarbeitung auf dem Server oder der Empfängerseite, also einer intelligenten Anwendung zum Rendering.

Vorteile von iiRDS im Überblick

Technische Kommunikation wird Teil von Industrie 4.0 / Smart Factory
Standardisierte Metadaten erleichtern Datenaustausch und -abfrage
Redaktionssysteme und andere Informationsquellen mit Content Delivery Systemen herstellerunabhängig koppeln

Noch längst nicht fertig

iiRDS ist gerade in der ersten Entwicklungsphase. Es gibt noch viel zu tun. Und nach der Veröffentlichung der ersten Version, die für Ende März 2017 geplant ist, wird hoffentlich viel Feedback von implementierenden Parteien zurückfließen. iiRDS wird also weiter wachsen und sich verändern, als gemeinsame Anstrengung der Dokumentationswelt. iiRDS wird als Open Resource unter der Creative Commons License zur Verfügung gestellt.