Zum Hauptinhalt springen

Experten der Dokuschmiede informieren beim iiRDS-Café

|

Das iiRDS-Café auf der tekom-Tagung 2019 in Stuttgart ermöglichte allen Besuchern den direkten Austausch mit 12 Spezialisten, darunter Eva-Maria Meier und Gerhard Glatz von der Dokuschmiede. Eva und Gerhard wollen vor allem Neulingen einen Zugang zum Standard ermöglichen und gestalteten hierfür an ihrem Stand einen leicht verständlichen Einstieg in iiRDS und das komplexe Thema Zuliefererdokumentation. In diesem Artikel stellen sie die Kernpunkte Ihrer Cafétisch-Präsentation vor.

Zuliefererinformationen vereinen – unmöglich?

Das Vereinen von Zuliefererdokumentation stellt Technische Redaktionen vor einige Herausforderungen: Zum einen sollen sie aus einer Masse in sich abgeschlossener Dokumente eine Gesamtdokumentation für eine riesige Anlage basteln und dabei alle Informationen bewahren. Zum anderen müssen sie Antworten auf spezifische Fragen der Anwender liefern. Diese sind z. B. Anlagenbediener oder Service-Techniker mit Termindruck, die schnell verständliche und eindeutige Informationen benötigen.

Ein Standard und alles flutscht

Der iiRDS-Lösungsansatz klingt toll: Alle nutzen einen Standard und dadurch lassen sich alle Daten einfach zusammenführen und durchsuchen. Ohne Standard sind stundenlange und schweißtreibende Abstimmungen mit allen Beteiligten sowie klare Regeln notwendig:

Entspricht das der Realität? Betrachten wir den Standard genauer und klären, was sich hinter iiRDS verbirgt.

Was ist iiRDS?

iiRDS steht für “Intelligent Information Request and Delivery Standard”. Mit Information ist Technische Dokumentation gemeint. Intelligent wird diese durch die Anreicherung und die Auszeichnung mit Metadaten.

Technisch gesehen ist iiRDS eine ZIP-Datei mit der Dateiendung „iirds“, deren Aufbau im Standard definiert ist:

Das iiRDS-Paketformat

Die metadata.rdf enthält alle Metadaten, mit denen die Inhalte ausgezeichnet wurden, als Ontologie. In dieser Datei wird auf die eigentlichen Inhalte verwiesen, die in beliebig vielen Unterordnern abgelegt sind und in Dateiformaten wie XML/XHTML, PDF, Grafiken oder Word existieren können. Neben einem freien Format, in dem Inhalte in beliebigen Dateiformaten vorliegen dürfen, gibt es auch eine eingeschränkte Version iiRDS/A (in Anlehnung an PDF/A). In dieser darf der Inhalt in einer Teilmenge von XHTML5 bereitgestellt werden und nur definierte Grafik- und Videoformate sind hierin zulässig. Außerdem dürfen in dieser Version keine externen Links vorhanden sein. So wird sichergestellt, dass der Inhalt immer vollständig und wahrscheinlich noch in 20 Jahren dargestellt werden kann.

Grob oder fein? – Die Granularität der Inhalte

Der Standard macht keine Vorgaben bezüglich der Granularität der Inhalte. Eine vollständige Bedienungsanleitung kann sowohl als zweihundertseitiges PDF als auch als Sammlung aus 50 Topics Inhalt eines validen iiRDS-Pakets sein und mit den gleichen Metadaten ausgezeichnet werden:

In der Ausgabe, zum Beispiel in einem Content-Delivery-Portal, werden die iiRDS-Pakete entsprechend ihrer Granularität angezeigt. Im einen Fall ist das das zweihundertseitige PDF, in dem dann der gewünschte Infoschnipsel rausgesucht werden muss. Im anderen Fall kann man direkt auf das gewünschte Topic zugreifen. Damit eine Maschine auf ihrem Steuerdisplay anhand eines Fehlercodes das entsprechende Informationsfragment zur Problemlösung bereitstellen kann, müssen die Inhalte entsprechend feingranular ausgezeichnet sein.

Metadaten – Das Herz des Standards

In iiRDS sind eine Reihe von Metadatenklassen definiert. Für die Domäne der Technischen Dokumentation ist nahezu alles enthalten und kann sofort verwendet werden. Für Maschinenbau und Softwareindustrie existieren außerdem branchenspezifische Metadaten in jeweils eigenen Namespaces.

Die Metadaten innerhalb eines iiRDS-Pakets werden als Ontologie abgebildet. Das bedeutet, dass die Metadaten untereinander in Beziehungen stehen. In der unteren Abbildung sind die folgenden Beispiele dargestellt:

  • Eine Informationseinheit vom Typ Document hat einen DocumentType vom Typ „Betriebsanleitung“ und bezieht sich auf ProductVariant eines bestimmten Produkts.
  • Eine Informationseinheit vom Typ Topic hat einen TopicType „Task“ zum InformationSubject „Process“.

Die in der Grafik dunkelblau dargestellten Klassen sind Anknüpfungspunkte für eigene, produktspezifische Metadatenklassen, beispielsweise eine Produkthierarchie:

Die folgende Abbildung zeigt ein an den tekom-Sample-Content angelehntes Codebeispiel, in dem die oben genannten Metadaten verwendet werden:

Granulare und semantisch klassifizierte Informationen können maschinell weiterverarbeitet und z. B. zu einer Wartungstabelle zusammengefügt werden. Voraussetzung dafür ist, dass alle Knoten wissen, dass sie sich auf die Wartung beziehen. Ein Wartungsintervall, Werkzeuge und notwendige Tätigkeiten müssen angegeben werden. Andernfalls enthält die Tabelle Lücken.

Alles ganz einfach mit iiRDS, oder?

Die Flexibilität des Standards ist Fluch und Segen zugleich: Sehr viele denkbare Szenarien können damit abgebildet werden. Schon bestehende Inhalte und verschiedene Informationsreifegrade sind sofort nutzbar. Für eine nahtlose Integration von Inhalten und fortgeschrittenere Industrie-4.0-Anwendungen sind allerdings umfangreiche Vereinbarungen und Abstimmungen unerlässlich.

Wir empfehlen Ihnen daher diese vier Schritte für das Management von Zuliefererdokumentation mit iiRDS:

  1. Einen Leitfaden mit den folgenden Vorgaben erstellen:
    • Format der zu liefernden Dateien
    • Granularität der Informationseinheiten
    • Metadaten, die kontextabhängig angegeben sein müssen oder können
    • Werte der unternehmens- oder produktspezifisch definierten Metadatenklassen
  2. Organisatorische Vereinbarungen treffen bezüglich:
    • Lieferterminen
    • Verantwortlichkeiten
    • der Einhaltung des Leitfadens
  3. Eine Checkliste oder Prüfskripte für die Eingangskontrolle erstellen.
  4. Je nach Kontext Skripte zur Zusammenführung und Bereinigung der Pakete erstellen.

Wir beraten Sie gerne zu allen Aspekten des Themas iiRDS, insbesondere wenn Sie vor der Herausforderung stehen, Zuliefererdokumentationen zu integrieren. Gemeinsam mit Ihnen wägen wir ab, ob der Einsatz des Standards für Sie sinnvoll ist.

Weitere Informationen:

Ihre Nachricht an Eva-Maria Meier und Gerhard Glatz

* Pflichtfeld

Bei der Kontaktaufnahme (zum Beispiel per Kontaktformular oder E-Mail) werden Ihre Angaben zwecks Bearbeitung der Anfrage sowie für den Fall, dass Anschlussfragen entstehen, gespeichert. Widerruf, Änderungen, Berichtigungen und Aktualisierungen: Sie haben das Recht, auf Antrag unentgeltlich Auskunft zu erhalten über die personenbezogenen Daten, die über Sie gespeichert wurden. Zusätzlich haben Sie das Recht auf Berichtigung unrichtiger Daten, Sperrung und Löschung der personenbezogenen Daten, soweit dem keine gesetzliche Aufbewahrungspflicht entgegensteht.