News

Treffen Sie uns auf der tekom-Jahrestagung 2018

Die Jahrestagung findet vom 13. bis 15. November 2018 in Stuttgart statt. Unsere Themen: iiRDS, Software-Dokumentation und selbstführende Teams. mehr ...

Was gibt’s Neues bei iiRDS? Treffen Sie uns im iiRDS-Café.

Sie wollen mehr über iiRDS erfahren? Kommen Sie zum iiRDS-Café auf der tekom-Messe und lassen Sie sich Ihre Fragen von Experten beantworten. mehr ...

Blog

Arbeiten in selbstführenden Teams. Oder wie wir das Management abschaffen

Die Welt von heute ist VUCA: volatile, uncertain, complex und ambiguous. Unternehmen stehen vor komplexen Herausforderungen wie Industrie 4.0 und dem Internet der Dinge. Wer nicht schnell genug agiert, wird vom Markt verdrängt. mehr ...

Tiere im Büro, Teil II: Der Miau-Effekt

Im zweiten Teil unserer Mini-Blogserie geht es um zwei Brüder. Und das ist auch vorerst der letzte Teil. Es sei denn, es schleicht sich noch ’ne Maus ins Haus. Oder ein Goldfisch. mehr ...
Suchen

Machen Sie Ihre technische Dokumentation intelligent – der Weg vom Content Management zu Content Delivery

In diesem Beitrag möchten wir Ihnen aufzeigen, wie man CDPs mit technischer Dokumentation so intelligent befüllt, dass die Nutzer schnell und gezielt Antworten auf ihre Fragestellungen bekommen.

Intelligente Informationen

Mit fortschreitender Digitalisierung wird gedruckte Dokumentation zunehmend durch online verfügbare intelligente Informationen ersetzt. Aber was sind denn überhaupt intelligente Informationen? Ist das nicht ein Widerspruch in sich?

Stimmt, Informationen sind per se nicht intelligent. Als intelligente Informationen bezeichnet man gemeinhin solche, die intelligente Anwendungen ermöglichen.

Intelligente InformationenIntelligente Informationen © chombosan | Fotolia.com

Wichtige Eigenschaften intelligenter Informationen sind:

  • Sie sind modular.
  • Sie werden formatneutral erstellt und können daher auf verschiedenen Endgeräten dargestellt werden.
  • Sie besitzen Metadaten und ermöglichen so die semantische Erschließung und kontextgerechte Aufbereitung der Inhalte für verschiedene Benutzer und Anwendungsszenarien.

Intelligente Informationen begegnen uns heute im Marketing, in Wikis, auf Websites und auch in der technischen Dokumentation. Aber was bedeutet das konkret für technische Dokumentation?

Intelligente Informationen in der technischen Kommunikation

Nutzer suchen Informationen nie ohne einen Kontext. Der Kontext spannt sich meist durch das konkret verwendete Produkt sowie die Aufgabe und Rolle des Nutzers auf. Sind diese bekannt, können relevante Informationen zu einer Fragestellung schnell herausgesucht werden.

Es reicht aber nicht, ganze Dokumente in diese Kontextschubladen einzusortieren. Vielmehr ergibt sich erst dann ein wirklicher Mehrwert, wenn die Dokumentation modular – in Topics – vorliegt. Ein Topic ist ein Informationshäppchen, das sich auf eine Frage konzentriert. Beispiele sind:

  • Wie nehme ich mein Handy das erste Mal in Betrieb?
  • Wie funktioniert Bluetooth?
  • Welche Bluetooth-Standards unterstützt mein Handy?
  • Was mache ich, wenn die Bluetooth-Verbindung nicht aufgebaut werden kann?

Die gewählten Beispiele zeigen gleichzeitig die unterschiedlichen Topic-Typen auf: Aufgabe (anleitender Charakter), Beschreibung (erklärender Charakter), Referenz (nachschlagender Charakter) und Störungsbeseitigung.

Ist die passende Lösung jedoch als intelligente Information aufbereitet, kann sie durch wenige Kontextinformationen aus der umfangreichen Dokumentation herausgesucht werden. Wenn der Nutzer ein Problem mit der Bluetooth-Verbindung seines Handys hat, wird er durch Einschränkung auf das Produkt (Handy-Modell), auf die Komponente oder die Funktion („Bluetooth“) und den Topic-Typ „Troubleshooting“ zu der Lösung für sein Problem gelenkt. In der Regel wird es nur ein Topic mit Informationen für diese Kombination von Kriterien geben.

Um Dokumentation intelligent zu machen, kommt es also darauf an, sie im Erstellungsprozess modular und topic-orientiert zu organisieren und mit den richtigen Metadaten zu klassifizieren.

Intelligente Informationen als Mehrwert

Können intelligente Informationen den Stellenwert der technischen Dokumentation erhöhen? In jedem Fall! Zu jedem technischen Produkt erstellen Sie eine Dokumentation, die das Produkt begleitet. Oftmals sind das gedruckte Handbücher oder deren digitale Äquivalente, die PDF-Dateien.

Traditionell ist das Interesse an solcher Dokumentation nicht so sonderlich groß. Im eigenen Unternehmen wird der geschäftliche Wert der Informationen in der Dokumentation nicht anerkannt, und die Kunden selbst möchten die Dokumentation nach Möglichkeit nicht lesen müssen. Sie erwarten einen guten Service, wenn sie mal eine Frage oder ein Problem haben. So fristet die technische Dokumentation ein Mauerblümchendasein und wird oft als Kostenfaktor und notwendiges Übel, aufgrund rechtlicher Rahmenbedingungen, gesehen.

Legt man Hersteller- und Nutzersicht übereinander, stellt man fest, dass das eigentlich zwei Seiten der gleichen Medaille sind: Stellt der Hersteller dem Nutzer intelligente Informationen zur Verfügung, stellt das für den Kunden einen Mehrwert zum gekauften Produkt dar, da er Zeit und Geld bei der Informationssuche spart. Andererseits können sich Hersteller einen Vorteil im Markt verschaffen. Wenn die Produkte der Markbegleiter austauschbarer werden, wird die eigene Position durch besseren Service – hier durch intelligente Informationen – gestärkt.

Die Veröffentlichung von intelligenten Informationen aus der technischen Dokumentation auf Unternehmenswebsites oder Portalen, ggf. auch ihre Kombination mit Marketinginhalten, vergrößern vergrößert außerdem die Sichtbarkeit und Reichweite der Unternehmensinhalte, da technische Dokumentation in der Regel die wesentlichen Begriffe enthält, die Kunden in Internet-Suchen verwenden. Intelligente Informationen schaffen also neue Chancen für Unternehmen, sich von den Marktbegleitern abzuheben, den Kundenservice zu verbessern und ihre Sichtbarkeit zu vergrößern.

Herstellerübergreifende Vernetzung

Es reicht aber nicht, wenn jeder Hersteller nur seine Informationen in seinem Portal veröffentlicht. Für komplexe Anlagen oder Internetanwendungen müssen Informationen aus verschiedenen Quellen und von verschiedenen Herstellern in Applikationen aggregiert werden. Um diese Informationen aber in gleicher Weise auswerten zu können, müssen sie auch die gleichen Metadaten – mit der gleichen Semantik – für die Klassifikation verwenden. Ansonsten wird das Content-Delivery-Portal (oder eine andere Applikation) sehr schnell unübersichtlich, Auswertungen kommen zu falschen Ergebnissen und der eigentliche Mehrwert kommt nicht zum Tragen.

Letztendlich bedarf es Standards, um intelligente Informationen zwischen Systemen und über Hersteller hinweg austauschbar zu machen.

iiRDS: der neue Standard für die Auslieferung technischer Dokumentation

Die tekom (Gesellschaft für Technische Kommunikation – tekom Deutschland e. V.) hat das erkannt und Anfang 2016 eine Arbeitsgruppe mit dem Ziel ins Leben gerufen, einen Austauschstandard für intelligente Informationen zu entwickeln. „The Intelligent Information Request and Delivery Standard“ (kurz „iiRDS“) ist das Ergebnis. Zur tekom-Frühjahrstagung 2018 wird die Version 1.0 erscheinen, und die Weiterentwicklung des Standards geht in die Hände des neu gegründeten iiRDS-Konsortiums über, dem bislang 25 Firmen und Einrichtungen beigetreten sind.

iiRDS definiert ein einheitliches Vokabular für die Metadaten technischer Dokumentation und ein Paketformat für die Auslieferung von Inhalten plus Metadaten. Das Vokabular definiert Metadaten, mit denen technische Dokumentation zu intelligenten Informationen veredelt werden, und die Beziehungen dieser Metadaten untereinander. Das Paketformat ermöglicht den hersteller- und systemübergreifenden Austausch von Informationslieferungen.

Das Metadatenmodell von iiRDS

Im Zentrum von iiRDS steht die Informationseinheit. Sie repräsentiert die Metadaten, mit denen ein Inhaltsmodul klassifiziert wird. Metadaten können für verschieden große Inhalte definiert werden: Dokumente, Topics und Fragmente. Fragmente sind Teile einer größeren Informationseinheit, z. B. die Aufzählung benötigter Werkzeuge für einen Reparaturschritt.

Die Metadaten in iiRDS sind unterteilt in Informationstyp- und Produktmetadaten. Die Informationstypmetadaten beschreiben die Art der Informationen. Die Produktmetadaten definieren, für welches Produkt oder welche Komponente die Informationseinheit zutreffend ist.

Am Beispiel des Bluetooth-Problems können wir die Klassifikation eines Topics zur Bluetooth-Störungsbeseitigung aufzeigen:

TopicMitiiRDSMetadatenEin Topic mit iiRDS-Metadaten. Abbildung: Empolis

Bei komplexeren Geräten werden naturgemäß weitere Klassifikationen benötigt. So können Informationsthemen und die Produktlebenszyklusphase relevant sein:

  • Informationsthemen sind zum Beispiel allgemeine Sicherheitshinweise, technische Daten, Konformitätserklärungen.
  • Zu den Produktlebenszyklusphasen gehören Montage, Inbetriebnahme, Betrieb, Außerbetriebnahme oder Entsorgung.

An zwei weiteren Topics lässt sich die Verwendung aufzeigen.

Zwei Topics mit Produkt und InformationstypklassifikationZwei Topics mit Produkt und Informationstypklassifikation. Abbildung: Empolis

Zusätzlich zu den beschriebenen Metadatenarten bietet iiRDS noch funktionale und administrative Metadaten, auf die wir in diesem Artikel aber nicht weiter eingehen.

Je komplexer die Dokumentation wird, desto wichtiger wird die Klassifikation mit Metadaten. iiRDS erfordert aber nicht, komplett alle Metadaten des Standards zu füllen.

Ein einheitliches Vokabular für technische Dokumentation

In iiRDS werden für die Domäne der technischen Dokumentation Benennungen und Wertelisten (Taxonomie) sprachneutral vordefiniert. Ein Nutzer kann sich damit sicher sein, dass unabhängig vom Hersteller und der verwendeten Software Benennungen und Werte immer die gleiche Bedeutung haben. Am Beispiel der Betriebsanleitung lässt sich das leicht erklären.

Betriebsanleitung ist die deutsche Bezeichnung für eine Dokumentart. In iiRDS ist nicht nur die Definition dieser Dokumentart enthalten, sondern auch die englische Bezeichnung. Ein als „Betriebsanleitung“ klassifiziertes Dokument wird mit der IRI (Internationalized Ressource Identifier) verknüpft und erhält damit eine definierte Semantik.

iiRDS OperatingInstructions

Auch für Informationstypen und Produktlebenszyklusphasen bietet iiRDS vordefinierte Wertelisten. Je komplexer die Dokumentation wird, desto wichtiger wird die Klassifikation mit Metadaten. iiRDS erfordert aber nicht, komplett alle Metadaten des Standards zu füllen. Jedes Unternehmen kann die Metadaten befüllen, die für die Nutzungsszenarien ihrer Anwender relevant sind.

Für Produkte und Komponenten bietet iiRDS geht das naturgemäß keine vordefinierten Wertelisten, weil Produkte und Komponenten nicht, weil diese von Hersteller zu Hersteller unterschiedlich sind. Hersteller pflegen daher für diese Bereiche ihre eigenen Klassifikationen (Taxonomien) für Produkte und Komponenten. In den Metadaten der Informationseinheiten werden dann die eigenen IRIs für die Produkt- und Komponentenmetadaten verwendet.

Von Content-Management zu Content-Delivery

Technische Dokumentation wird in der Regel in einem Redaktionssystem, einem sogenannten Component-Content-Management-System (CCMS) erstellt und verwaltet. Redakteure nutzen diese Systeme, um die Texte zu erfassen, die Module zu verwalten und mit Metadaten zu versehen und ihre Arbeitsprozesse zu steuern.

Wenn ein CCMS das iiRDS-Metadatenschema unterstützt, können Redakteure auf die iiRDS-Taxonomie zugreifen und Dokumentationsmodule entsprechend klassifizieren. Damit ist die Basis geschaffen, technische Dokumentation über iiRDS an Content-Delivery-Portale zu übergeben. Durch die Standardisierung wird gewährleistet, dass Daten aus unterschiedlichen Management- und Autorensystemen aggregiert und an unterschiedliche Content-Delivery-Portale übergeben werden können.

RDS Datenaustausch Management und Content Delivery SystemeniiRDS als Drehscheibe für den Datenaustausch zwischen Management- und Content-Delivery-Systemen. Abbildung: Empolis

Derzeit arbeiten mehrere Hersteller an der Implementierung von iiRDS in der Schnittstelle ihrer Systeme oder bereiten sie vor. Empolis verfügt seit der tekom Jahrestagung 2017 über eine prototypische Implementierung der Importschnittstelle für Empolis Content Express. Die produktive Version befindet sich in der Planung.

iiRDS auf der tekom Frühjahrstagung 2018

Auf der tekom Frühjahrstagung 2018 (19.-20. April in Koblenz) können Sie tiefere Einblicke in iiRDS erhalten:

Fr. 20.4. 11:30 Uhr – Ulrike Parson: Neu in iiRDS – Vorstellung der Version 1.0 des Standards
Fr. 20.4. 13:45 Uhr – Dr. Martin Kreutzer: Mit iiRDS zaubern – praktische Anwendung von iiRDS

Verwandte Artikel

Aufzeichnung des Webinars "Machen Sie Ihre technische Dokumentation intelligent

Über die Autoren

Dr. Martin Kreutzer beschäftigt sich seit 20 Jahren bei der Empolis Information Management GmbH mit der Konzeption von XML-basierten CMS-Anwendungen und in den letzten Jahren zunehmend mit Content Delivery Portalen und dem Austausch intelligenter Informationen. Standards wie XML, DITA, RDF und iiRDS liegen ihm besonders am Herzen. Er ist aktives Mitglied der iiRDS-Arbeitsgruppe und Co-Autor von iiRDS.

Ulrike Parson ist Gründerin des Dienstleistungsunternehmens parson AG, das sich auf technische Kommunikation, technische Beratung und Schulungen spezialisiert hat. Ihr Fokus sind Beratung im Bereich Content-Strategie und Entwicklerdokumentation. Sie ist aktives Mitglied der iiRDS-Arbeitsgruppe und Co-Autor von iiRDS.

  • linkedin
  • xing