iiRDS – einfach erklärt

iiRDS – nur ein neues Buzzword oder steckt mehr dahinter?

iiRDS bedeutet „Intelligent Information Request and Delivery Standard“ und befasst sich mit dem Thema, einen Standard für eine dynamische Informationsabfrage und -verbreitung im Bereich der Technischen Dokumentation für das Internet der Dinge und die Industrie 4.0 zu gestalten. iiRDS ermöglicht eine hersteller- und plattformunabhängige Auslieferung und Verschlagwortung von Dokumentationen. Dieser vielversprechende Standard umfasst die Vorgabe von einem Metadatenkonzept, in dem Klassifikationswerte vorgegeben werden. Diese Begriffe werden über Beziehungen untereinander in einen Kontext gesetzt, sodass ein „Wissensnetz“ die vorhandenen Informationen möglichst genau abbilden kann. Neben dem Metadatenkonzept wird ein Paketformat geboten, um den Austausch zwischen diversen Plattformen wie einem Content-Management-System (CMS) zu einem Content-Delivery-Portal (CDP) zu gewährleisten. Die diversen Plattformen können dabei nicht nur firmenintern vorliegen, sondern auch z. B. Zulieferdokumentationen aus firmenexternen Systemen mit einbeziehen.

 

Einführung in die iiRDS-Reise

Die oben genannte Definition von iiRDS ist sehr komplex. Um einen besseren Überblick über das Thema zu erlangen, nehmen wir Sie mit auf die iiRDS-Reise – von der Planung der Reise bis zum Reiseziel. Passend zum Thema gibt es auch einen Blog-Beitrag Mit dem iiRDS-Koffer hinaus in die Content-Delivery-Welt zum Thema iiRDS mit dem Reiseziel Content-Delivery.

Ich packe meinen Koffer und nehme mit…

Was steht vor der eigentlichen Reise an? Natürlich das Kofferpacken. Das Kofferpacken ist auf der iiRDS-Reise ein wichtiger Bestandteil. Ohne das Gepäck kann die Reise nicht gestartet werden. iiRDS gibt vor, welche Koffer zur Mitnahme auf die Reise geeignet sind. Nicht alle Gepäckstücke entsprechen den genauen Gepäckbestimmungen. Der Reiseveranstalter iiRDS gibt außerdem vor, dass die Gepäckstücke einen Gepäckanhänger mit vorgegebenen Informationen tragen müssen – wie man es von Flugreisen kennt. Anhand der Anhänger können die Gepäckstücke dann genauestens identifiziert werden, da der Anhänger Auskunft zum Beispiel zu ihrem Reiseziel, dem Besitzer und dem Inhalt gibt.

Reisekoffer mit identifizierbaren Metadaten


iiRDS

Für die iiRDS-Vorgaben bedeutet das konkret, dass einzelne Dokumentationen als iiRDS-Pakete gespeichert werden, die ZIP-Archiven gleichen. Die einzelnen Pakete müssen identifiziert werden können und daher Metadaten zu der verpackten Dokumentation tragen. Es kann sich zum Beispiel um ein Benutzerhandbuch, eine Wartungsanleitung oder eine Installationsanleitung handeln, die jeweils für unterschiedliche Produkte gültig ist.


Was Sie in Ihrem Gepäckstück mit auf die Reise nehmen, können Sie individuell entscheiden. Je nach Reiseziel und -art kann sich der Inhalt unterscheiden. Für einen Sommerurlaub am Meer wird anderes Equipment benötigt als für einen Winterurlaub in den Bergen. Für den Inhalt des Koffers selbst gibt es daher keine Vorgaben. Dem Reiseveranstalter ist jedoch besonders wichtig, auf welcher Art und Weise der Koffer gepackt wird. Es wird eine genaue Packstruktur und Packliste vorgegeben.

Reisekoffer mit iiRDS


iiRDS

Für die iiRDS-Vorgaben bedeutet das konkret, dass diverse Inhalte z. B. in Form von XML, PDF oder HTML in das ZIP-Archiv gepackt werden können. Die Inhalte müssen jedoch einer vorgegebenen Struktur folgen. In dem ZIP-Archiv, muss eine mimetype-Datei vorliegen, die angibt, um welche Art von Daten es sich handelt – in diesem Fall ein application/iirds+zip. Neben der mimetype-Datei befinden sich 2 Ordner auf oberster Ebene des Pakets:

  • META-INF
    In diesem Ordner befindet sich (nur!) die Datei, die Informationen zu den Metadaten trägt – die metadata.rdf.
  • CONTENT
    In diesem Ordner befinden sich die eigentlichen Inhalte der Dokumentation als Text, Grafik, Video, Audio, etc.

Wo auch immer die Reise hingeht…

Jetzt ist der Koffer schon gepackt, aber bevor Sie sich auf die Reise machen, legen Sie natürlich das Reiseziel und die Reisestrecke fest – wo geht die Reise los und wollen Sie mit ihrem Koffer eigentlich hin? Das gute an dem Reiseveranstalter iiRDS ist, dass der Start- und Zielpunkt der Reise zu jedem gepackten Koffer passt, solange man sich an die Gepäckbestimmungen hält. Es können auch viele unterschiedliche Koffer mit zu einem Reiseziel genommen werden – es gibt keine Gepäckstück-Begrenzung. Außerdem können Sie sich ganz spontan und individuell für ein Reiseziel entscheiden – das ist einer der größten Vorteile von iiRDS.


iiRDS

Für die iiRDS-Vorgaben bedeutet das konkret, dass bestimmt werden muss, in welchem System bzw. in welchen Systemen die benötigten Inhalte vorliegen und was das Zielsystem ist. Zudem muss bestimmt werden, wie die Inhalte aus dem Quellsystem / den Quellsystemen zu einem iiRDS-Paket geschnürt werden können. Die Quelle der Inhalte kann firmenintern sein aber auch Zuliefererdokumentationen umfassen. Das Ziel des iiRDS-Pakets können Anwendungen von CDPs bis hin zu Chatbots (siehe auch https://www.icms.de/chatbots-fuer-die-technische-kommunikation) sein. Für den Import in das Zielsystem muss ebenfalls geprüft bzw. festgelegt werden, wie die Pakete in das System importiert werden können.

Im folgenden Beispiel liegt die Quelle bei der Entstehung der Information in einem CMS und das Ziel bei einer Anzeige der Informationen in einem CDP. Die Übertragung zwischen den Systemen funktioniert über ein iiRDS-Paket.

iiRDS Paket


Sobald der Koffer an seinem Ziel angekommen ist, kann er ausgepackt werden. Durch die konkrete Auszeichnung der Gepäckanhänger zu Beginn der Reise können die Inhalte des Koffers sofort ihrem Zweck am Zielort zugeordnet werden. Je nach gepacktem Inhalt kommen die mitgenommenen Gegenstände in unterschiedlichen Situationen zum Einsatz.


iiRDS

Für iiRDS bedeutet das ganz konkret, dass die Inhalte, die aus diversen Quellen stammen, über ein zentrales System bereitgestellt werden können und über diverse weitere, beliebige Plattformen publiziert werden. Außerdem können Sie vom Endanwender nach individuellen Anforderungen aufgerufen werden. Auch Versionen und Varianten der Pakete werden durch iiRDS gekennzeichnet und können im Zielsystem als solche dargestellt werden.


 

iiRDS ganz konkret

Wie iiRDS funktioniert und was das Ziel von iiRDS ist, haben Sie in der iiRDS-Reise erfahren. Aber was ist zu tun, wenn Sie iiRDS nutzen möchten? Wie packen Sie den iiRDS-Koffer?

iiRDS gibt Metadaten zur Auszeichnung der Dokumentationen vor, die zur Standardisierung von Metadaten im Bereich der Technischen Dokumentation dienen. Wenn Sie den iiRD-Standard nutzen möchten, müssen Sie Ihre Dokumentation mit den standardisierten Metadaten auszeichnen. Am Beispiel der Klassifikation „Gebrauchsanweisung“ wird der Nutzen der Standardisierung deutlich. In einem anderen Unternehmen könnte dasselbe als „Benutzerhandbuch“ oder sogar „Bedienungsanleitung“ bezeichnet werden. Unternehmen müssen ihre Begriffe nicht an das standardisierte Vokabular anpassen – sie müssen nur ihren Begriff auf den in iiRDS definierten Begriff abbilden bzw. mappen. Natürlich können nicht alle firmenspezifischen Besonderheiten standardisiert werden, daher fokussiert sich iiRDS auf die gemeinsamen, firmenübergreifenden Merkmale der Technischen Dokumentation:

  • Informationsklassifikation (Art der Information, Art der Tätigkeit im Produktlebenszyklus, Art der Zielgruppe, Thema der Dokumentation, Dokumentenart)
  • Funktionale Metadaten (Werkzeuge, Arbeitszeit, Qualifikation, Zugriffsrechte, Navigationselemente)

Firmeninterne Klassifikationen wie die Produktmetadaten (Komponenten, Produktvarianten, Produktmerkmale) können pro Projekt individuell festgelegt werden. Alle potentiellen Klassifikationen, die iiRDS vorsieht, sind in der Dokumentation zu finden.

Sobald die Inhalte mit den Metadaten ausgezeichnet sind, kann die Dokumentation in das iiRDS-spezifische Paketformat gebracht werden. Es gibt Systemanbieter, die diesen Export als Standard anbieten. Sollte ihr Systemanbieter diese Funktion nicht anbieten oder ihre Anforderungen individuelle Anpassungen bedürfen, unterstützen wir Sie gerne bei der Anpassung. Kontaktieren Sie uns, wir beraten Sie bei Ihren individuellen Reisewünschen!

Ein Beispiel zur Anschauung

Ein Techniker hat den Auftrag eine Maschine zu warten. Ohne eine dynamische Informationsbereitstellung mit iiRDS müsste er in ein Maschinenhandbuch schauen und nach der gewünschten Information suchen und dafür womöglich tausende Seiten durchblättern. Mit iiRDS wird ihm die Möglichkeit geboten, die passende Information digital im richtigen Kontext abzurufen. Wenn die Maschine beispielsweise eine Fehlermeldung zeigt, kann er nach dieser in einem CDP suchen und erhält sofort die Information, die er benötigt. Denkbar ist auch, dass Inhalte aus einem iiRDS-Paket direkt „onboard“ auf dem Maschinendisplay angezeigt werden, sobald der entsprechende Fehler an der Maschine auftritt. Sollte es sich bei der gesuchten Information um Inhalte aus einer Zulieferer-Dokumentation handeln, müsste der Techniker ohne iiRDS vermutlich ein gesondertes Handbuch zur Hilfe ziehen. Mit iiRDS können interne und externe Informationen zusammen über ein Medium veröffentlicht werden – der Techniker muss den gewohnten Nutzungskontext nicht verlassen.

Wie an diesem Beispiel zu sehen ist, bietet iiRDS eine dynamische Möglichkeit, Informationen über diverse Medien zu verbreiten – zur richtigen Zeit, am richtigen Ort.

 

Vorteile von iiRDS

Die modulare Erfassung der Inhalte und die Auszeichnung der Inhalte durch iiRDS ermöglicht die richtige Information, zur richtigen Zeit, am richtigen Ort. Mit iiRDS kann bei der Industrialisierung auf dem Weg zur Industrie 4.0 ein wichtiger Schritt getan werden: Informationen werden nicht mehr linear als statisches Handbuch veröffentlicht, sondern so flexibel und individuell wie die Produkte in Zukunft sein werden, wird auch die Information geliefert. Anwender fordern Inhalte mehr und mehr über moderne Ausgabemedien wie CDPs oder Chatbots – iiRDS macht es möglich! Für ein Beispiel siehe diese Präsentation von der tekom SummerCon 2020.

iiRDS bietet nicht nur einen gewinnbringenden Nutzen für den Anwender, sondern realisiert auch eine systematische Aufbereitung der Inhalte der Dokumentation für den Ersteller. Nicht nur Inhalte auf Ebene der Technischen Dokumentation können mit iiRDS vereinheitlicht werden, iiRDS ist auch firmenübergreifend nutzbar und legt dadurch z. B. einen Grundstein für einen sog. digitalen Zwilling.

iiRDS wird von einer Arbeitsgruppe der tekom entwickelt. Innerhalb der Arbeitsgruppe „Information 4.0“ begann die tekom bereits 2016 mit der Arbeit an iiRDS. Ab 2018 übernahm das iiRDS-Konsortium die Aufgaben der Arbeitsgruppe „Information 4.0“, um den weiteren Verlauf des Projekts zu steuern. Die ICMS ist Teil dieses Konsortiums. Das bedeutet, ein Pionier in einem vielversprechenden und aufregenden Wandel zu sein und mit zu gestalten, wie die Technische Dokumentation sich entwickeln und profitieren kann.

 

Quellen