Technische Dokumentation: So gelingt eine effiziente Digitalisierung

Verantwortlicher Redakteur:in: Rainer Trummer 4 min Lesedauer

Anbieter zum Thema

„Was Digitalisierung bringt?“, hat sich die Abteilung Technische Dokumentation der Jenaer Antriebstechnik (JAT) gefragt. Einen Einblick in die gefundenen Antworten gibt dieser Beitrag.

(Quelle:)
(Quelle:)

Technische Dokumentation in der Praxis: Neben mehr Effektivität und Effizienz im Arbeiten trägt die Digitalisierung der Technischen Dokumentation zu nachhaltigerem Wirtschaften bei. Auf physische Trägermedien wie Papier, CDs und USB-Sticks kann dadurch verzichtet werden, soweit es rechtlich möglich ist. Doch es gilt dabei, einiges zu beachten und eine umfassende Strategie zu entwickeln. Genau diesen Weg ist JAT gegangen.

Die Digitalisierungsstrategie in der Technischen Dokumentation von JAT besteht aus drei prinzipiellen Konzepten:

  1. Fragmentierung

  2. Metadaten

  3. Bereitstellung

1. Fragmentierung

Fragmentierung bedeutet das Entwickeln eines neuen Verständnisses von Informationsbausteinen, aus denen Dokumente zusammengesetzt sind: Ein Dokument besteht demnach aus verschiedenen Informationsbausteinen, manche sind individuell und gehören nur zu einem einzigen Dokument, andere sind hingegen standardisiert und befinden sich in vielen Dokumenten. Das Dokument „Wartungsplan“ für das System „FPD-400x550-000“ enthält beispielsweise spezifische Angaben über Wartungsintervalle und zur Art des Schmierfetts, aber ebenso allgemeine Warnhinweise zum Umgang mit mechatronischen Systemen und rechtlichen Verweisen, die Bestandteil der Wartungspläne aller Systeme sind, die JAT herstellt.

Der grundlegende Schritt in der Digitalisierung der technischen Dokumentation ist der Einsatz eines Redaktionssystems, wobei JAT sich für bloXedia von pgx software solutions entschieden hat. Diese Software ist im Grunde eine Datenbank, die sich mit Informationsbausteinen füllen lässt. Diese Bausteine werden mittels einer inhaltlichen Struktur zu Dokumenten zusammengesetzt.

Somit liegen Gleichbausteine wie Warnhinweise nur einmal als Quelldatei vor, sind jedoch mittels Zuweisung in allen Dokumenten enthalten, in denen sie benötigt werden. Das garantiert nicht nur weniger Aufwand bei nachträglichen Änderungen und erhöhte Fehlersicherheit, sondern bietet ebenfalls eine sehr gute Übersicht über den gesamten Informations- und Dokumentenbestand. Durch die sprachneutrale Dokumentenstruktur lassen sich Übersetzungen einfach mitverwalten. Übergeordnete Formatierungen ermöglichen eine einheitliche und ansprechende Dokumentengestaltung von Informationen aus verschiedenen Quellen.

2. Metadaten

Mittels Metadaten wird ein einzelner Informationsbaustein in Kontext zum vollständigen Dokument gesetzt: Der individuelle Baustein „Wartungsintervall“ des oben genannten Systems erhält das Metadatum „FPD-400x550-000“, womit dieser Baustein auch unabhängig vom Rest des Dokuments identifizierbar ist. Zudem lassen sich viele zusätzliche Metadaten zuweisen. Der Baustein Wartungsintervall erhält beispielsweise die Zusatzinformationen Dokumentenart: „Wartungsplan“, Produktmerkmal: „Mehrachssystem“, Seriennummer: „UXXXX01220801243“ und die Benutzerrolle: „Servicepersonal“.

Ebenso interessant für das Servicepersonal ist die spezifische Fehlerbehandlung. Statt einer Auflistung aller möglichen Fehler in einer Tabelle als Anhang in einem Servoverstärker-Handbuch, ist jeder Fehler als individueller Informationsbaustein mit passenden Metadaten angelegt, der die Fehlermeldung, Fehlerbeschreibung sowie die entsprechende Maßnahme zur Fehlerbehebung enthält. So trägt die technische Dokumentation dazu bei, dass das Servicepersonal im Störfall schnell, effizient und angemessen reagieren kann.

JAT setzt auf den intelligent information Request and Delivery Standard (iiRDS), der es ermöglicht, Informationsblöcke inklusive Metadaten zwischen kompatiblen Systemen auszutauschen. Für den Export der Textblöcke nutzt JAT die Dateiformate PDF und HTML, wobei HTML-Topics (Textquelle + Metadaten) ein zielgenaues Anspringen einer einzelnen Information sowie das Verlinken zu externen weiterführenden Inhalten ermöglichen. Beispielsweise verlinkt die Hilfe der Ecostudio-Inbetriebnahmesoftware auf passende Informationen in den Servoverstärker-Handbüchern. iiRDS ermöglicht es ebenfalls, JAT Dokumente wie etwa den Wartungsplan des obengenannten Beispiel-Antriebssystems, in die Maschinendokumentation des Kunden zu übernehmen.

3. Bereitstellung der Daten für die technische Dokumentation

Neben der Verarbeitung von Informationen ist die Art der Informationsbereitstellung von fundamentaler Bedeutung für die Digitalisierung der Technischen Dokumentation. Erst die Bereitstellung der fragmentierten Informationen und zusammengesetzten Dokumente stellt sicher, dass die gesuchten Informationen schnell, einfach und sicher auffindbar sind. Um diese Anforderungen zu erfüllen, hat JAT ein Informationsportal entwickelt. Es ist unter www.jat-gmbh.info jederzeit und von überall erreichbar. Es basiert auf der Content-Delivery-Portal-Software easybrowse von gds und wird in Zusammenarbeit mit dem Anbieter kontinuierlich weiterentwickelt.

Jetzt Newsletter abonnieren

Verpassen Sie nicht unsere besten Inhalte

Mit Klick auf „Newsletter abonnieren“ erkläre ich mich mit der Verarbeitung und Nutzung meiner Daten gemäß Einwilligungserklärung (bitte aufklappen für Details) einverstanden und akzeptiere die Nutzungsbedingungen. Weitere Informationen finde ich in unserer Datenschutzerklärung. Die Einwilligungserklärung bezieht sich u. a. auf die Zusendung von redaktionellen Newslettern per E-Mail und auf den Datenabgleich zu Marketingzwecken mit ausgewählten Werbepartnern (z. B. LinkedIn, Google, Meta).

Aufklappen für Details zu Ihrer Einwilligung

Neben der technischen Produktdokumentation – Datenblätter, Handbücher, Begleitpapiere – aus dem Redaktionssystem finden sich hier ebenfalls weiterführende Dokumente und Dateien, von denen die Anwender profitieren. Für Servomotoren und Rundtischsysteme stehen CAD-Daten zur Verfügung, für Servoverstärker zusätzlich Eplan-Daten und aktuelle Firmware. Zertifikate zu allen Produkten und Software-Downloads vervollständigen den Datenbestand, der für die System-Anwender relevant ist.

Die technische Dokumentation für mechatronische Systeme befindet sich in einem kundenindividuellen und passwortgeschützten Bereich. Kunden mit entsprechenden Rechten haben Zugriff auf die Begleitdokumentation ihrer Systeme. Diese umfasst Einbauerklärung, Montageanleitung, Verkabelungsplan, Prüfprotokoll, Wartungsplan, Zusammenbauzeichnung und Ersatzteilliste. All diese Dokumente sind mittels Metadaten nach den individuellen Seriennummern der ausgelieferten Systeme indexiert.

Das Informationsportal stellt dem Nutzer alle Informationen, Dokumente und Softwarebausteine in Zusammenhang mit dem Produktportfolio bereit, jederzeit und von überall abrufbar. Das garantiert komfortables und effizientes Arbeiten mit den Produkten.

In einem letzten Schritt werden die informationelle und physische Existenzebene der Produkte miteinander verheiratet: Für Windows, iOS und Android ist eine App verfügbar. Via Smartphone Kamera kann der Nutzer den Bar- oder Data-Matrix-Code scannen, der auf dem Typenschild jedes JAT-Produkts zu finden ist. Dieser Code ist via Metadaten mit den Produktinformationen verbunden. Das Scannen des Data Matrix Codes am System FPD-400x550-000 ruft seriennummernspezifisch die vollständigen Begleitdokumente des Systems ab, inklusive Prüfprotokolle, Wartungsplan und Ersatzteilliste. Sollte an der Maschine keine Verbindung zum Internet existieren, kann der Dokumentenbestand vorher heruntergeladen und offline genutzt werden.

Technische Dokumentation: Ein Ausblick

Künftig sollen nicht nur Systeme, sondern auch alle definierten Ersatzteile, einen eigenen Data-Matrix-Code erhalten, sodass es möglich ist, per Scan eines defekten Teils direkt die Ersatzteilbestellung auszu­führen.

Matthias Seitz ist Prozessingenieur Digitalisierung bei Jenaer Antriebstechnik (JAT).

Lesen Sie auch: Guided Selling: Wie es den Verkaufsprozess von Industriegütern erleichtert