iiRDS - Sie fragen, wir antworten

von parson am 01. Juli 2020

iiRDS ermöglicht die Auslieferung und den Austausch intelligenter Informationen. Der Standard wird seit 2016 unter der Schirmherrschaft der tekom entwickelt. Mithilfe von iiRDS können wir Inhalte verschiedener Hersteller über Metadaten miteinander verknüpfen, für Maschinen und Menschen gezielt abrufbar machen und über ein einheitliches Format zwischen Systemen austauschen.

© chombosan | Fotolia.com

Seit Beginn arbeitet parson an der Entwicklung und Dokumentation des Standards mit. Auf Veranstaltungen und in Vorträgen berichten wir über den aktuellen Entwicklungsstand und die praktische Anwendung. Immer wieder erhalten wir Fragen von Teilnehmern. Einige der häufigsten Fragen beantworten wir in laufender Folge in diesem Blog.

Ihre Fragen

Wie kann ich iiRDS-Pakete erstellen?

Seit neuestem können Sie iiRDS-Pakete mit dem iiRDS Open Toolkit erstellen. Dafür müssen Sie kein Experte sein. So geht’s:

  1. Öffnen Sie die Webanwendung des iiRDS Open Toolkit.
  2. Laden Sie Inhalte hoch.
  3. Vergeben Sie die iiRDS-Metadaten. Sie können auch eigene Metadaten hinzufügen.
  4. Generieren Sie das iiRDS-Paket.
iiRDS Open Toolkit: https://iirds-ot.plusmeta.de/iirds-open-toolkit/start

Um einen Blick in iiRDS-Paket zu werfen, ändern Sie die Dateiendung von .iirds in .zip. Jetzt müssen Sie das Paket nur noch auspacken. Anschließend sehen Sie die Ordnerstruktur, die Inhalte und die Metadatendatei Ihres iiRDS-Pakets.

Das iiRDS Open Toolkit wurde gemeinsam von plusmeta GmbH und ICMS GmbH entwickelt. Das iiRDS OT ist kostenlos.

Weitere Informationen finden Sie im Blog von plusmeta und auf der iiRDS-Website. 

Wie erzeuge ich iiRDS aus meinem Redaktionssystem?

Wenn Sie mit einem Redaktionssystem arbeiten, sind Sie grundsätzlich gut aufgestellt für die Lieferung intelligenter Informationen. Denn Sie arbeiten schon modular und können Metadaten verwenden. Konzeptionell funktioniert die Erzeugung von iiRDS-Paketen aus einem Redaktionssystem so:

1. Sie definieren die Metadaten, die Sie für Ihre Content-Delivery-Szenarien benötigen. Beispiel: Sie wollen, dass die Nutzer Ihres Dokumentationsportals nur die Inhalte angezeigt bekommen, die zu ihrer Rolle passen, z.B. Servicetechniker oder Vertriebsmitarbeiter. Dazu benötigen Sie Metadaten für die Zielgruppe der Dokumentation.

2. Sie weisen die definierten Metadaten den Inhalten im Redaktionssystem zu.

3. Sie konfigurieren die iiRDS-Ausgabe im Redaktionssystem. Dazu gehört:

  • Sie konfigurieren die iiRDS-Standardmetadaten, die mit den Inhalten ausgeliefert werden. Metadaten aus Ihrem Redaktionssystem können auf iiRDS-Standardmetadatan gemappt werden. Dazu gehören z.B. Produktlebenszyklusphasen oder Informationsarten.
  • Sie konfigurieren ihre eigenen, iiRDS-kompatiblen Metadaten, die mit den Inhalten ausgeliefert werden. Um auf das Beispiel mit der Zielgruppe zurückzukommen: Da das Standard-Metadatum DocumentationMetadata > FunctionalMetadata > Qualification > Role nur ein leerer Andockpunkt in iiRDS ist, müssen Sie das iiRDS-Metadatenmodell um Ihre Zielgruppe „Servicetechniker“ erweitern, z.B. indem Sie der Klasse Role eine Instanz „service-technician“ hinzufügen.
  • Sie legen die Ausgabeformate für den Inhalt fest, z.B. HTML5.

4. Sie erzeugen aus dem Redaktionssystem ein iiRDS-Paket.

Noch ist die Anzahl an Redaktionssystemen mit integrierter iiRDS-Unterstützung begrenzt. Unseres Wissens unterstützen folgende Redaktionssysteme direkt iiRDS. Wenn Sie von anderen wissen, kommentieren Sie gerne und wir erweitern die Liste.

Wenn Ihr Redaktionsystem kein iiRDS unterstützt, dann können Sie auch einen eigenen Konverter für den Export der Daten und die Erzeugung des iiRDS-Pakets entwickeln. Die meisten Redaktionssysteme bieten entsprechende Export-Schnittstellen (APIs). Fachkundige Unterstützung erhalten Sie dafür u.a. von Dienstleistern wie parson und ICMS oder Softwareanbietern wie c-rex.net und plusmeta.

Muss ich alle Metadaten mit der Hand zuweisen?

Nein und zwar aus mehreren Gründen:

1. Sie nutzen in der Regel nur die Metadaten aus dem iiRDS-Vokabular, die Sie auch für Ihre Content-Delivery-Szenarien brauchen. Beispiele:

  • Sie wollen, dass die Nutzer Ihres Dokumentationsportals nur die Inhalte angezeigt bekommen, die zu ihrer Rolle passen, z.B. Servicetechniker oder Vertriebsmitarbeiter. Dazu benötigen Sie Metadaten für die Zielgruppe der Dokumentation.
  • Sie wollen, dass die Nutzer Ihres Dokumentationsportals nach Produkten filtern können. Dazu benötigen Sie Produktmetadaten.

2. Viele Metadaten, die sich im iiRDS-Paket wiederfinden und mit den Inhalten ausgeliefert werden, werden automatisch erzeugt:

  • Von Ihrer Autorenumgebung aus den Metadaten, die Sie im System für die Auszeichnung von Varianten benutzen.
  • Von Ihrer Autorenumgebung aus den Inhaltstypen und -vorlagen, die Sie zum Schreiben verwenden. Beispiele: Vorlagen für Topic-Arten, Fragment-Arten, Warnhinweise.
  • Aus den Dokumentstrukturen und Verzeichnissen, die Sie im Autorensystem anlegen, zum Beispiel Inhaltsverzeichnissen, Tabellen- und Abbildungsverzeichnissen.

3. Metadaten an Topics oder Fragmenten können bei der Erzeugung von iiRDS von übergeordneten Elementen, z.B. Kapitelelementen oder Informationsprodukten, vererbt werden.

Das Format iiRDS legt nur die Metadaten fest. Da iiRDS kein Autorenstandard ist, liegt die Art und Weise, wie Sie Metadaten zuweisen und verwenden, nicht in seiner Macht.

Welche Firmen setzen iiRDS bereits ein?

Mehrere Firmen setzen iiRDS ein oder arbeiten an der Umsetzung des Standards. Prominente Beispiele sind Siemens, SMA und Zeiss. Weitere Informationen finden Sie zum Beispiel in Vorträgen dieser Unternehmen und Beraterkollegen von der tekom-Tagung sowie auf der Website des iiRDS-Konsortiums (best practices).

Zeiss und Pantopix

Siemens, IAI Linguistic Content und DOSCO

Industrie-Beispiele in iiRDS-Vortrag von parson

Brauche ich ein Redaktionssystem, um iiRDS zu verwenden?

Nein, das brauchen Sie nicht. Grundsätzlich benötigen Sie für iiRDS die folgenden Tools:

iiRDS-Toolkette

  • XML-Editor zum Erstellen strukturierter Inhalte und Zuweisen der Metadaten. Sie können strukturierte Inhalte mit iiRDS-Metadaten auch mit einem XML-Editor ohne Redaktionssystem erstellen, z.B. in DITA mit oXygen. Hier benötigen Sie eine DITA-Spezialisierung für die iiRDS-Metadaten. Die können Sie selbst entwickeln oder Sie nutzen fertige Plugins wie parson Smart Content.
  • Konverter zum Erzeugen der Ausgabeformate und der iiRDS-Pakete. Zum Erzeugen von iiRDS-Paketen, auch aus Bestandsdokumenten in PDF, können Sie zudem Konverter-Tools von plusmeta oder c-rex.net verwenden.
  • Content-Delivery-Plattform zum Importieren und Verarbeiten der iiRDS-Pakete und Veröffentlichen der intelligenten Informationen

Muss ich alle iiRDS-Metadaten verwenden?

Nein, das müssen Sie nicht. Sie können die Metadaten auswählen, die Ihren Content-Delivery-Szenarien entsprechen.

Nutzen Sie die Metadaten, die Ihre Inhalte für Ihre Zielgruppen besser auffindbar und filterbar machen. In der iiRDS-Spezifikation sind übrigens alle Pflicht-Elemente des Standards mit MUST ausgezeichnet. Das sind nur sehr wenige, u.a. muss die Verzeichnisstruktur im iiRDS-Paket eingehalten werden und jede InformationUnit muss eine eindeutige Identifikation (IRI) haben. Siehe iiRDS-Spezifikation (Registrierung erforderlich).

Sie haben auch eine Frage zu iiRDS?

Nutzen Sie die Kommentarfunktion oder schreiben Sie uns an contact@parson-europe.com .

Alle Informationen rund um iiRDS finden Sie auch auf unserer Website.

Neuen Kommentar hinzufügen

Ihre E-Mail-Adresse wird nicht veröffentlicht.

Das könnte Sie auch interessieren

Sprung ins kalte Wasser oder wie ich das erstmal Mal slammte. Bericht von der tekom-Tagung, 2. Teil

von Ulrike Parson am 18. November 2019

Eigentlich bin ich ja ein alter Hase bei der tekom-Tagung und sollte nicht mehr allzu aufgeregt sein, wenn ich einen Vortrag halte. Aber als Dieter Gust und ich unsere Feierabend-Schnapsidee einer scherzhaften Debatte (Trend-Slam) auf die Bühne brachten, war mir doch etwas flau im Magen. Wie würde das wohl ankommen? mehr...

iiRDS - der Standard für intelligente Inhalte

von Uta Lange am 02. Oktober 2019

Die fortschreitende Digitalisierung zwingt uns dazu, über anspruchsvollere Technologien für die Bereitstellung und Veröffentlichung von Inhalten nachzudenken. Heute wollen wir für einen bestimmten Anwendungsfall oder eine bestimmte Situation die passende Information zur Verfügung stellen. Deshalb weisen wir den Inhalten Metadaten zu und machen so unsere Informationen intelligent. So weit, so gut. mehr...

Ulrike Parson spricht auf Adobe DITA World: From DITA to iiRDS

19. September 2019

Die Adobe DITA World ist die weltgrößte Online-DITA-Konferenz für Experten aus Marketing und Technical Communication. Die kostenlose Konferenz findet vom 9. – 11. Oktober 2019 statt. Ulrike Parson spricht am 9. Oktober 2019, 1.00 pm (PDT), 10.00 pm (CEST, Berlin). mehr...