Deutsch

Richtlinie für die Technische Dokumentation: VDI 2770

Chancen und Herausforderungen für Lieferanten im Anlagenbau

CREATEPROVIDE
Richtlinie für die Technische Dokumentation: VDI 2770

Stücklisten, Schaltpläne, Prüfberichte und Wartungsanleitungen:
Die Fülle an technischen Unterlagen ist enorm, die Hersteller mit jeder neuen Maschine an ihre Kunden übermitteln. Wird die Dokumentation auch digital zur Verfügung gestellt, stehen Hersteller häufig vor der Frage: Wie kann die Vielzahl an Dateien in einer sinnvollen und nutzbaren Struktur an den Betreiber übergeben werden? Bislang war es üblich, dass die Hersteller die Dateipakete nach einem individuellen Vorgehen – oft entsprechend den spezifischen Anforderungen des Betreibers – zusammengestellt haben.

Das Problem hierbei: Die fehlende Einheitlichkeit beim Dateien-Management mindert den Nutzen der digitalen Dokumentation erheblich. So werden Zugriff und Einordnung der übermittelten Dokumente unnötig erschwert. Häufig muss jedes einzelne Dokument aufwendig aus einem unübersichtlichen Ordnersystem herausgesucht und händisch in die Struktur des Betreibersystems überführt werden.

Wie geht es besser?
Der Verein Deutscher Ingenieure (VDI) hat einen wichtigen Schritt zur Vereinheitlichung der digitalen Dokumentation unternommen und eine Richtlinie für die Bereitstellung der Dokumente entwickelt. Das Ergebnis ist die Richtlinie VDI 2770 Blatt 1 „Betrieb verfahrenstechnischer Anlagen – Mindestanforderungen an digitale Herstellerinformationen für die Prozessindustrie – Grundlagen“ oder kurz gesagt VDI 2770.

 

Welches konkrete Ziel wird mit der Richtlinie VDI 2770 verfolgt?

Mit der Festlegung von Dateiformaten und Metadaten sowie der Definition einer festen Ablagestruktur soll die Übergabe der Herstellerinformationen an die Betreiber standardisiert werden. Obwohl die Richtlinie aus einer Initiative der Prozessindustrie entstand, ist ihr Anwendungsbereich grundsätzlich branchenunabhängig. Besonders im Anlagenbau und in der Verfahrenstechnik mit ihren mitunter sehr komplexen Gesamtsystemen verspricht die Richtlinie eine deutliche Verbesserung bei der Organisation der Dokumente.
Ein weiterer Vorteil der VDI 2770: Das einheitliche Metadatenmodell bildet die Grundlage für eine automatisierte Übernahme der Dateien in die Betreibersysteme. Das spart nicht nur Zeit, sondern ist gerade bei sehr komplexen Anlagendokumentationen weniger fehleranfällig als ein manueller Zugriff auf die übermittelten Dateien.
Seit der Veröffentlichung im Jahr 2020 hat sich die Richtlinie schnell zu einem wichtigen Werkzeug für die Digitalisierung von Technischer Dokumentation in der Industrie entwickelt. Sie soll daher auch als Grundlage für eine künftige internationale ISO-/IEC-Normung dienen.

Professionalisieren Sie die Erstellung Ihrer Technischen Dokumentation  Wir zeigen Lösungswege auf, wie Sie durch gezielte Prozessoptimierung die  Erstellung Ihrer Technischen Dokumentation effizienter gestalten.    KOSTENLOSES WHITEPAPER ANFORDERN

 

Was genau regelt die VDI 2770?

Im Kern legt die Richtlinie folgende Aspekte für die digitale Bereitstellung von Technischer Dokumentation fest:

  • Klassifizierung der Dokumente
  • Satz von festen Metadaten für jedes Dokument
  • Struktur des digitalen Dokumentationspakets
  • Dateiformate

Klassifizierung
Eine eindeutige Klassifizierung der Dokumente erleichtert ihre Ablage und ihr späteres Auffinden erheblich. Zur Klassifizierung legt die VDI 2770 daher vier Dokumentgruppen fest, die sich wiederum in zwölf Kategorien untergliedern. Die Kategorien sind dabei an den Produktlebenszyklus technischer Güter angelehnt. Die typischerweise in einer Technischen Dokumentation enthaltenen Inhalte/Dokumente lassen sich damit problemlos klassifizieren.

Dokumenttypen_final

© VDI 2770

Metadaten
Zu jedem Einzeldokument sieht die VDI 2770 eine eigenständige Metadatendatei im XML-Format vor. Mithilfe eines vorgegebenen Satzes an Metadaten wird jedes Dokument eindeutig spezifiziert.
Im Wesentlichen handelt es sich dabei um die folgenden Typen von Metadaten:

  • Metadaten zur Identifikation des Dokuments
  • Metadaten zur Klassifikation des Dokuments
  • Metadaten zur Identifikation des beschriebenen Produkts
  • Metadaten mit sonstigen Versions- und Verwaltungsinformationen

Struktur

Dokumentationscontainer_weißer Hintergrund

© kothes GmbH

In welcher Struktur müssen die Dateien konkret abgelegt und übermittelt werden? Für jedes Dokument sind mindestens zwei physische Dateien vorgesehen:

  • Eine PDF/A-Datei mit dem eigentlichen Dokumentinhalt (z. B. Wartungsplan)
  • Die zugehörige XML-Datei mit den Metadaten

Optional kann das Dokument auch zusätzlich als Datei abgelegt sein, die das Quellformat des Dokuments repräsentiert, wie z. B. die Excel-Datei einer Stückliste.
Für jedes Dokument werden die einzelnen Dateien nun in einem ZIP-Container zum sogenannten Dokumentcontainer zusammengefasst.
Die Gesamtdokumentation besteht somit aus vielen einzelnen ZIP-Containern. Diese Einzelcontainer werden wiederum in einem eigenen ZIP-Hauptcontainer abgelegt. Dieser enthält auf erster Ebene zusätzlich ein Hauptdokument, das sich wie die anderen Dokumente aus einer PDF/A-Datei und der zugehörigen Metadatendatei zusammensetzt. In der PDF/A-Datei ist eine für den Menschen lesbare Auflistung der einzelnen Dokumente enthalten. Die XML-Datei wiederum referenziert alle Unterdokumente anhand ihrer Dokument-ID. Mit diesem Vorgehen lassen sich im Übrigen auch die Herstelleranleitungen der einzelnen Subsysteme einer Anlage schnell und einfach in die Gesamtdokumentation integrieren.

Dateiformat
Die Technische Dokumentation von Maschinen und Anlagen muss langfristig lesbar und durchsuchbar sein. Daher schreibt die VDI 2770 das speziell für die Langzeitarchivierung digitaler Dokumente entwickelte Format PDF/A vor. Eine Datenbereitstellung gemäß VDI 2770 erfüllt damit die einschlägigen regulatorischen und normativen Anforderungen, die an die langfristige Verfügbarkeit von Informationen gestellt werden.

 

Welche Aufwände ergeben sich für die Hersteller?

Das hängt natürlich von der Komplexität der Technischen Dokumentation sowie dem konkreten Dokumenten-Management im Herstellerunternehmen ab. Ein zentraler Punkt wird in jedem Fall die praktische Anwendung des vorgegebenen Metadatenmodells der VDI 2770 sein. Einige der Metadaten, wie etwa die Dokument-ID sowie Sprache und Titel des Dokuments, können in den allermeisten Fällen ohne größere Aufwände aus den Betreibersystemen extrahiert werden. Andere Metadaten, wie etwa die Klassifikation der Dokumente, müssen hingegen neu erfasst und künftig gepflegt werden.
Aus technischer Sicht lässt sich festhalten: Die Hürden zur Umsetzung der Richtlinie wurden vom VDI bewusst niedrig gehalten. So ist z. B. das XML-Format, in dem die Metadatendatei erstellt werden muss, sehr gebräuchlich. Dadurch besteht die Möglichkeit einer direkten Bearbeitung durch den Menschen, ohne dass hierfür eine spezielle Software eingesetzt werden müsste. Nichtsdestotrotz kann es gerade im Anlagenbau einen enormen Arbeitsaufwand bedeuten, Tausende von Dokumenten gemäß VDI 2770 zu klassifizieren und in der vorgegebenen Struktur abzulegen.

 

Wie unterstützt kothes?

Von der Vergabe der Metadaten bis hin zur kompletten technischen Realisierung Ihres digitalen Dokumentationscontainers gemäß VDI-Richtlinie: Unser Expertenteam unterstützt Sie in allen Phasen Ihres Dokumenten-Managements. Der besondere Vorteil: Wir nutzen das Potenzial, das in den Metadaten Ihrer Dokumente steckt, und ermöglichen eine weitgehend automatisierte Erstellung Ihres Dokumentationspakets. Dank KI-basiertem Prozess werden die von der VDI 2770 geforderten Metadaten teilautomatisch in Ihrem Datenbestand erkannt. Auch das finale Dateipaket Ihrer Dokumentation wird so schnell und einfach generiert.
Sie möchten mehr zu den Anforderungen der VDI-Richtlinie 2770 erfahren oder benötigen konkrete Unterstützung bei der Umsetzung der Vorgaben? Dann kontaktieren Sie uns gerne!

Zum Kontaktformular

Steffen Vorderstemann
Autor:
Blog post Steffen Vorderstemann