FAQs zur VDI-2770-Richtlinie

Eva-Maria Meier von

Abschlussarbeiten bei plusmeta

Seit der Richtlinienveröffentlichung im April 2020 haben wir mit unseren Kunden schon einige Projekte zu dem Thema bearbeitet. „Für wen lohnt sich das eigentlich?“, „Was muss unbedingt drin sein im Paket?“, „Wie geht man mit Dokumenten um, die in mehrere Dokumentkategorien passen?“ waren Fragen, die uns dabei immer wieder begegnet sind. Vielleicht haben Sie sich die ein oder andere Frage auch schon gestellt?

Diese und viele weitere Fragen zur VDI-2770-Richtlinie beantworten wir Ihnen in unserer neuen Blogserie. In diesem ersten Teil geht es um die Basics der Richtlinie. Im zweiten Teil beantworten wir komplexere im Projektverlauf aufkommende Fragen und im dritten Teil erfahren Sie, wie Sie VDI-2770-Pakete in plusmeta mit KI-Unterstützung im Handumdrehen erzeugen.

Was ist die VDI-2770-Richtlinie?

Die VDI-Richtlinie 2770 beschreibt ein Austauschformat, das effizientes Zusammenführen umfangreicher Dokumentation aus unterschiedlichen Quellen ermöglicht. Das zugrundeliegende Konzept aus einem Containerformat und einem Metadatenmodell bildet die Basis für einen funktionierenden digitalen Informationsaustausch.

Der vollständige Name der Richtlinie lautet VDI 2770 - Blatt 1: „Betrieb verfahrenstechnischer Anlagen - Mindestanforderungen an digitale Herstellerinformationen für die Prozessindustrie – Grundlagen“.

Für wen lohnt sich die VDI-2770?

Prozessindustrie

Die Richtlinie adressiert zunächst – wie in ihrem Namen ablesbar – die Prozessindustrie. Wenn komplexe Anlagen erneuert, erweitert oder verändert werden, müssen die Produktinformationen von teilweise hunderten unterschiedlichen Apparaten bzw. Equipments zusammengeführt werden.

Entlang des gesamten Produktlebenszyklus müssen die richtigen Informationen abrufbar sein. Werden z. B. Teile in der Anlage ausgetauscht, muss auch die zugehörige Dokumentation aktualisiert werden. Gesetzliche Vorgaben und daraus resultierende Audits zur Prüfung der Sicherheit können es erforderlichen machen, dass sogar das Materialzeugnis einer einzelnen Schraube nachzuweisen ist. Das entsprechend notwendige Dokumentenmanagement kann ganze Projektteams über Tage beschäftigen.

Das Konzept der VDI-2770-Richtlinie verspricht, durch die eindeutige, maschinenlesbare Zuordnung und Klassifizierung der Dokumente diese Herausforderungen anzugehen.

Zulieferer der Prozessindustrie

Zulieferer der Prozessindustrie müssen damit rechnen, dass die Dokumentation zu den gelieferten Produkten als VDI-2770-Paktekete gefordert sein wird. Dieser Umstand ist jedoch nicht nur Herausforderung, sondern auch eine Chance: Wenn Sie unterschiedliche Unternehmen beliefern, ist es einfacher, sich an einen Standard zu halten als zahlreiche individuelle Anforderungskataloge durchzuarbeiten.

Die Inhalte und PI-Klassifikationen aus einem CMS werden in vier Schritten zu iiRDS-Paketen.

Was ist drin im VDI-2770-Paket?

Schauen wir uns so ein VDI-2770-Paket doch einmal genauer an. Die Grafik zeigt alle wichtigen Aspekte von VDI-2770-Paketen. In den folgenden Abschnitten stellen wird Ihnen diese genauer vor.

Die Grafik zeigt ein VDI-2770-Paket mit der Dokumentation für eine Pumpe. Darin sind weitere VDI-2770-Pakete enthalten für die Obejkte enthalten, aus denen die Pumpe besteht. Auf der untersten Ebene sind die Dokument-Container zu sehen. Sie enthalten jweils das Dokument selbst als PDF/A-Datei und eine XML-Metadaten-Datei. Im Beispiel ist auch die Originaldatei mitgeliefert.

(1) Dokumentcontainer: Eine Klammer für jedes Dokument

Wir beginnen bei einem einzelnen Dokument, einer Betriebsanleitung (BA). Sie steckt als PDF/A-Dokument zusammen mit der Originaldatei („Free“) und einer XML-Metadatendatei in einem Dokumentcontainer. Dieser ZIP-Container bündelt alle Informationen zu einem Dokument, in diesem Fall zur Bedienungsanleitung.

(2) Dateiformat PDF/A für dauerhaften, digitalen Zugriff

Alle Dokumente müssen als PDF/A vorliegen. Dieses Dateiformat stellt sicher, dass die Dokumente langfristig zugreifbar und korrekt darstellbar sind. Die Richtlinie erlaubt nur PDF/A-Formate, bei denen der textuelle Inhalt elektronisch zugreifbar, sprich durchsuchbar ist (z.B. PDF/A-2a und PDF/A-3a). Eine Ausnahme gibt es für Zeugnissen, Zertifikaten und Bescheinigungen (Dokumentenkategorie 02-04). Da diese Dokumente häufig lediglich eingescannte Bildinformationen enthalten, sind weitere PDF/A-Varianten erlaubt. Die Originaldateien (vgl. „Free“ in der Grafik) mitzuliefern, steht den Paket-Erstellenden frei. [Quelle: VDI-2770, S.29 f.]

(3) Alle Metadaten pro Dokument in einer XML-Datei

Pro Dokument sind die Metadaten in einer XML-Datei zu liefern. Ein wichtiges Metadatum ist dabei die Dokumentkategorie. Die enthaltenen Dokumente müssen anhand ihrer Dokumentart und ihres Verwendungszwecks einer der 12 vorgegebenen Dokumentkategorien zugeordnet werden. Zusätzlich ist eine Einordnung nach DIN EN 63551 möglich (DCC – Document Kind Category Code) DIN EN 61355.

Durch Einordnung der Dokumente nach Verwendungszweck sollen die Inhalte leicht zu finden sein. Nach einem Blick auf die Dokumentkategorie ist klar, welche Informationen, in welchem Dokument stecken. Die Kategorien sind nach den typischen Informationsbedürfnissen bei entsprechenden Arbeitstätigkeiten im Produktlebenszyklus abgeleitet. [Quelle: VDI 2770, S. 27 f.]

Codes Dokumentkategorie Beispieldokumente
01-01 Identifikation Elektronischen Typenschild, Foto des Objekts, Hauptdokument
02-01 Technische Spezifikation Datenblatt, Lastenheft, Risikobeurteilung, mitgeltende Regelwerke
02-02 Zeichnungen, Pläne Schnittzeichnung, Explosionszeichnung, 3D-Modell, Wirkschaltplan
02-03 Bauteile Stückliste
02-04 Zeugnisse, Zertifikate, Bescheinigungen ATEX-Zertifikat, EU-Konformitätserklärung, Werkstoffzeugnis
03-01 Montage, Demontage Montage-Anleitung, Demontage-Anleitung, Aufstellungsplan, Fundamentplan
03-02 Bedienung Nutzungshinweise, Gebrauchsanleitung, Inbetriebnahme-Anleitung
03-03 Allgemeine Sicherheit Allgemeine Sicherheitshinweise
03-04 Inspektion, Wartung, Prüfung Inspektionsanleitung, Wartungsanleitung, Prüfplan, Kalibrieranleitung
03-05 Instandsetzung Reparaturanleitung
03-06 Ersatzteile Ersatzteilliste, Verbrauchsmaterialien
04-01 Vertragsunterlagen Lieferschein, Rechnung, Garantiebestimmung

[Quelle: VDI 2770, S.12]

Verwaltungsbezogene Metadaten werden pro Dokumentversion angegeben, z.B. Versionskennung, Freigabestatus und Sprache. [Quelle: VDI 2770, S. 25f]

Neben der Angabe der Dokumentkategorie ist die Zuordnung der Dokumente zu Objekten ein zentrales Metadatum. Für jedes Objekt muss mindestens ein Objektbezug hergestellt werden. Details dazu verraten wir unter Punkt (5) „Produktbezug“ und weiter unten in einer anderen Frage bzw. Antwort.

(4) Dokumentationscontainer zum Bündeln

Es wird also für jedes Dokument ein Dokumentcontainer erstellt. Anschließend werden alle Dokumentcontainer zu einem Objekt zusammen mit einem Hauptdokument in einem Dokumentationscontainer zusammengefasst. Dieses Hauptdokument wird als eine Art Inhaltsverzeichnis in Form einer XML-Datei und eines PDF/A-Dokuments ausgegeben. Warum das so ist, erfahren Sie weiter unten.

Besteht ein Produkt aus mehreren Teilen, wird die Produktstruktur in verschachtelten Dokumentationscontainern abgebildet. Das Zippen der Dateien erleichtert die Übergabe der gesammelten Dokumente und Metadaten-Dateien. Außerdem können Sie optional die Integrität der Dokumentation prüfen, indem Sie Prüfsummen pro Paket berechnen. So ist jederzeit nachvollziehbar, ob sich ein Paket verändert hat. Gleiche Prüfsumme bedeutet „keine Änderung“ bzw. „gleicher Inhalt“. [Quelle: VDI 2770, S. 31ff]

Die Grafik zeigt ein VDI-2770-Paket bzw. einen Dokumentationscontainer. Dieser enthält weitere Dokumentationscontainer. Auf der untersten Ebene sind Dokumentcontainer zu finden.

(5) Worum geht’s? - Produktbezug

Damit Informationen gezielt abrufbar sind, braucht jedes Dokument einen Bezug zum Produkt. Alle Dokumente zu einem Produkt bzw. zu einem Produktbestandteil (beides „Objekt“ laut Richtline) werden ebenfalls in einem Dokumentationscontainer geklammert und dem Produkt zugeordnet.

Besteht ein Produkt aus mehreren Bestandteilen, enthält auch der entsprechende Dokumentationscontainer dieselbe Struktur und entsprechende Unterpakete (untergeordnete Dokumentationscontainer). Durch die Analogie im Aufbau ist es möglich, Veränderungen am Produkt direkt in die Dokumentation zu übertragen. Werden einzelne Teile des Produkts ausgetauscht oder verändert, können die dazugehörigen Dokumentationscontainer ebenfalls ausgetauscht oder aktualisiert werden. [Quelle: VDI 2770, S. 26f]

(6) Hauptdokumente sorgen für den Überblick

Jedes Paket muss ein Hauptdokument als Inhaltsverzeichnis in Form eines PDF/A-Dokuments und einer XML-Datei mitbringen. In diesen Hauptdokumenten sind die jeweiligen Unterpakete aufgeführt. Eine Besonderheit von Hauptdokumenten ist, dass sie nur genau einem Objekt zugeordnet sein dürfen. [Quelle: VDI 2770, S. 20]

Das Hauptdokument liegt zum einen als für Menschen gut lesbares PDF/A vor (vgl. Beispiel in der Grafik unten), zum anderen sind die gleichen Informationen in der maschinenlesbaren XML-Datei auf derselben Ebene zu hinterlegen.

Das Beispiel zeigt ein Hauptdokument mit 5 Einträgen.

Nicht alles ist geregelt

Die Inhalte, das Änderungsmanagement sowie die Vollständigkeit und die Richtigkeit der Dokumente selbst werden nicht von der Richtlinie behandelt. [Quelle: VDI 2770, S.5]

Was macht man mit Dokumenten, die nicht eindeutig zu EINER Dokumentkategorie passen?

Die Richtlinie sieht vor, dass jedes Dokument entsprechend seinem Inhalt, seiner Art und seiner Bedeutung einer Dokumentkategorie zugeordnet wird [Quelle: VDI 2770, S.11].

In der Praxis enthalten Dokumente oft Informationen aus mehreren Dokumentkategorien, z.B. enthalten Betriebsanleitungen Technische Daten (02-01 Technische Spezifikation), Informationen zur Montage oder Inbetriebnahme (03-01 Montage, Demontage) sowie zur Störungsbehebung (03-05 Instandsetzung).

Zwei Lösungsansätze sind möglich: Entweder man zerlegt das Ausgangsdokument und erstellt daraus Dokumente für jeweils eine Dokumentkategorie. Oder man nutzt die in der Richtlinie beschriebene Möglichkeit, in Ausnahmefällen mehrere Dokumentkategorien zu einem Dokument zuzuweisen.

Wir sind gespannt, welches Vorgehen sich in der Praxis etablieren wird. Aktuell scheint der Trend eindeutig zum Zuweisen mehrerer Dokumentkategorien zu gehen.

Wie stellt VDI-2770 die Verbindung zwischen den Dokumenten und den Produkten sicher?

Das Datenmodell enthält für die Objektbeziehung mehrere Wege. Grundsätzlich werden Objekttyp-Bezüge und Bezüge auf individuelle Objekte unterschieden. Ein Objekttyp-Bezug kann z. B. über eine Bestellnummer, eine Produktnummer oder eine EAN (European Article Number), angegeben werden. Der Wert bezieht sich dabei immer auf eine Reihe von Objekten.

Beim Bezug zu individuellen Objekten werden die Dokumente exakt einem realen Objekt zugeordnet: Seriennummern oder IDs bzw. URI entsprechender der DIN SPEC 91406 geben solche instanziellen Produktbezüge an. Ein Objekt kann auch durch mehrere IDs identifiziert werden, z. B. über die Seriennummer des Herstellers und die Equipment-ID des Anlagenbetreibers. Mindestens eine der IDs muss auf dem Produkt direkt zu finden sein. Idealerweise auf dem Typenschild oder in dessen unmittelbarer Umgebung [Quelle: VDI 2770, S. 26].

Die Grafik zeigt ein VDI-2770-Paket, das einen instanziellen Bezug zu einem einzelnen Pumpenkörper hat. Ein Dokumentcontainer in dem Paket bezieht sich dagegen auf mehrere Produkte einer Serie.

Für die Hauptdokumente und damit auch für alle Objekt-Pakete (bzw. Dokumentations-Container) gilt eine Einschränkung: Sie dürfen jeweils nur für ein individuelles Objekt gelten. Das hat in voller Konsequenz ganz schön viele Container zur Folge. Liefert man 500 Produkte aus einer Serie an ein Unternehmen, müssen auch 500 VDI-2770-Pakete mit identischen Dokumenten geliefert werden.

Was aus Redakteur:innen-Sicht nach jeder Menge Overhead und redundanten Daten klingt, ist der Kern des Konzepts und Schlüssel für die eindeutige Zuordnung. Die meisten Unternehmen werden die Mehrfachdatenhaltung durch intelligente Verwaltung in Produkt- oder Enterprise Management Systemen ausgleichen. Der Standard soll aber auch ohne eine solche Unterstützung funktionieren.

Wie Sie die für die Prozessindustrie typischen Angaben zu Technischen Plätzen und Equipments in VDI-2770-Paketen angeben können, erfahren Sie im zweiten Teil unserer Blogserie.

Wie tief soll man die VDI-2770-Pakete schachteln?

VDI-2770-Pakete folgen in ihrem Aufbau der Produktstruktur. Ein „Objekt“ definiert die Richtlinie als eine „Betrachtungseinheit, die in einem Prozess der Entwicklung, Realisierung, des Betriebs und Entsorgung behandelt wird“ [Quelle: VDI 2770, S.9].

Ein Objekt kann aus anderen Objekten zusammengesetzt sein. Objekte im Sinne der Richtlinie sind z. B. Bauteile, Baugruppen, Apparate, Kraft- und Arbeitsmaschinen oder ganze technische Anlagen [Quelle: VDI 2770, S. 4].

Was Unternehmen als Bauteil betrachten, kann unserer Erfahrung nach unterschiedlich ausfallen. Dementsprechend sind wir gespannt, wie sich die Umsetzung in der Praxis entwickelt. In unseren Projekten war meist pragmatisches Vorgehen mit eher flachen Strukturen gefragt.

Wie erstellt man ein VDI 2770 Paket?

Natürlich mit plusmeta! 😊 Unsere eigenentwickelte KI unterstützt Sie dabei, die passenden Dokumentenkategorien zu finden und den eindeutigen Produktbezug der Dokumente herzustellen. Die eingebaute Validierung stellt sicher, dass alle geforderten Daten vorhanden sind. Ein standardkonformes Paket mit der entsprechenden Struktur und den geforderten Metadaten sowie Übersichtsdokumenten generiert plusmeta innerhalb von Sekunden.

Wie das aussieht, zeigen wir Ihnen gerne in einer Demo. Weitere Informationen zu VDI 2770 finden Sie außerdem auf unserer Webseite.

Auch andere Standardformate zum digitalen Datenaustausch erstellen Sie mit plusmeta im Handumdrehen, z. B. iiRDS Pakete. Wie das geht, lesen Sie hier. Wenn Sie mehr über das Zusammenspiel von iiRDS und VDI 2770 erfahren wollen, empfehlen wird Ihnen diesen Blogbeitrag.

Wir haben Ihre Frage zu VDI-2770 nicht beantwortet? Schreiben Sie uns eine E-Mail an hallo@plusmeta.de!