• Startseite
  • BLOG
  • iiRDS für eine einheitliche Technische Dokumentation

iiRDS für eine einheitliche Technische Dokumentation

Die Vorteile des neuen Standards

Das Papier ist als analoges Trägermedium zahlreichen Grenzen unterworfen. Redakteure, die ihre Technische Dokumentation hingegen als digitale Ressource im Sinne des Electronic Content Delivery publizieren, bieten den verschiedensten Nutzergruppen entlang der gesamten Prozesskette entscheidende Vorteile. Allerdings bringt der digitale Publikationsweg ein zentrales Problem mit sich: Die digitale Technische Dokumentation unterscheidet sich je nach Endgerät des Users und der genutzten Software in ihrer Darstellung. Das bietet unerwünschtes Fehlerpotenzial. Die Gesellschaft für Technische Kommunikation (tekom) und der Verband deutscher Redaktions- und Content Management System Hersteller DERCOM arbeiteten deswegen am Intelligent Information Request and Delivery Standard (iiRDS), einem Format zur intelligenten Informationsbereitstellung.

Standards erleichtern uns in vielen Bereichen das alltägliche Leben. Wenn sie fehlen, merken wir dies schnell. Bereits im Urlaub kann ein Adapter nötig sein, damit der mitgebrachte Stecker in die landestypische Steckdose passt. Auch beim Surfen im Internet können wir die Probleme fehlender Standards anschaulich erleben, wenn der von uns gewählte Browser bestimmte Funktionen einer Webseite nicht unterstützt. In diesem Fall kommt es zu Fehlern – Darstellungen sind verschoben oder die Seite lässt sich im schlimmsten Fall nicht einmal öffnen.

Diese Probleme betreffen auch die Technische Dokumentation. Auf sie greifen verschiedenste Gruppen zu, seien es Anwender oder Servicetechniker. Genauso müssen auch Technische Redakteure, wenn sie Fremddokumentationen in ihre Technische Dokumentation einarbeiten wollen, auf diese zugreifen. So unterschiedlich die Anwenderkreise sind, so unterschiedlich sind die für den Zugriff gewählten Endgeräte und die genutzte Software. Der Grundgedanke, eine Technische Dokumentation digital zur Verfügung zu stellen, ist gut. Sie ist dann stets aktuell, der User kann Volltextsuchen vollziehen und sie mobil abrufen. Doch die Praxis zeigt ein diffiziles Bild: All diese verschiedenen Nutzerkontexte können die eigentlich vom Redakteur gewünschte Darstellung verzerren, bis die Technische Dokumentation im schlimmsten Fall zur schlummernden Gefahr für die Anwender wird. Diesem Problem möchte nicht nur die Gesellschaft für Technische Kommunikation, sondern auch der DERCOM entgegenwirken. Der Verband, in dem auch die gds-Gruppe als Gründungsmitglied vertreten ist, hat die Etablierung von Standards für die Technische Dokumentation zum Ziel und ist unter anderem in einem Arbeitskreis der tekom an der Entwicklung des iiRDS beteiligt.

Die Technische Dokumentation in den Kontext rücken

Das Potenzial für eine Technische Dokumentation, die Informationen hingegen intelligent bereitstellt, wird an einigen Beispielen aus der Praxis deutlich: In Folge einer Fehlermeldung möchte ein Servicetechniker in der Regel Informationen gezielt abrufen. Der Anwender richtet sein Augenmerk hingegen auf die Abschnitte, die den Regelbetrieb oder die Pflege- und Wartungsabläufe beschreiben. In beiden Fällen gilt: Je komplexer die Anlage, desto komplexer zeigt sich die dazugehörige Technische Dokumentation. Hier kommen die Vorzüge des iiRDS voll zum Tragen. Der Standard soll es Usern ermöglichen, passend zum Anwendungskontext die jeweils benötigten Informationen dynamisch und zielgerichtet abzurufen und entsprechend der situativen Bedürfnisse darzustellen. Das gilt sowohl für den Anwender am stationären Desktop-PC als auch für den Servicetechniker, der vor einer Anlage steht und die Technische Dokumentation mit dem Tablet aufruft.

Ein Techniker ruft eine Technische Dokumentation mobil auf. Dank iiRDS sind die Informationen kontextabhängig verfügbar.

Als Voraussetzung für die kontextuelle Aufarbeitung von Informationen muss ein Dokument in einzelne Topics beziehungsweise Themen aufgegliedert werden. Eine Technische Dokumentation ist demnach eine Gesamtmenge zusammenhängender Themen. Bei der klassischen Technischen Dokumentation auf Papier, also beispielsweise einem Benutzerhandbuch für eine Maschine oder Anlage, würde der Anwender das Inhaltsverzeichnis passend zum jeweiligen Kontext nach Schlagwörtern durchsuchen. Zwar bietet der iiRDS eine Suchfunktion, doch unterschiedliche Begriffe bezeichnen manchmal ein und denselben Gegenstand oder Kontext. Bezeichnungen wie „Monteur“ und „Techniker“ oder auch „Fehlercode“ und „Störbericht“ sind dafür gute Beispiele. Um dieses sprachspezifische Problem zu lösen, müssen für die Technische Dokumentation einheitliche Metadaten vergeben werden. Dadurch lassen sich Dokumentationsinhalte über Herstellergrenzen hinweg universell austauschen.

Standardisiert werden dabei die allgemeinen Metadaten, die die Technische Dokumentation selbst, also etwa einzelne Sektionen, näher beschreiben. Dazu gehören jedoch nicht die spezifischen Metadaten, die sich zum Beispiel auf unterschiedliche Produktvarianten beziehen und diese spezifizieren. Dies ist die Voraussetzung dafür, dass der iiRDS die Standardisierung für die Technische Dokumentation ermöglicht, dabei aber die herstellerbedingte Individualität nicht verloren geht.

Technische Dokumentation - clever verpackt

Die Informationspakete des iiRDS bestehen aus einer Inhaltsdatei im HTML- oder XML-Format sowie einer Steuerdatei samt der Metadaten im RDF-Format. Diese Pakete können nun stufenweise mit komplexeren Informationsangeboten gefüllt werden. Auf der niedrigsten Stufe enthält das Paket das komplette Dokument, z. B. als PDF, sowie die dazugehörigen Metadaten. Stufe zwei beinhaltet die Dokumentationsmodule, also etwa Topics in HTML5 oder XML. Hinzu kommen die Metadaten der Module. Erst bei Stufe drei greifen User auf die Dokumentationsmodule inklusive aller Metadaten der Topics sowie weiter aufgefächert auch auf die Fragmente von Topics zu. Das ermöglicht zum Beispiel die feindifferenzierte Auswahl selbst von einzelnen Warnhinweisen innerhalb von Topics.

Noch befindet sich der iiRDS in der Entwicklungsphase. Eine Testversion ist allerdings bereits veröffentlicht. Bald soll die erste Version erscheinen.

Zugehörige Artikel

Bitte Kommentar schreiben

Sie kommentieren als Gast.
Rückruf
Kontakt