Hardware / Software / Wissen

Technische Dokumentation

Das Gedächtnis
der Anlage.

Eine Anlage muss auch für den nächsten Ingenieur verständlich sein.

Ich erstelle und aktualisiere Schaltpläne, Steuerungsbeschreibungen und Projektunterlagen für SPS, HMI und Antriebe – für den Betrieb, die Diagnose und spätere Änderungen.

PA / ENGINEERINGBlatt 01 / 08

Steuerungssystem

Technische Prinzipskizze

PLCHMII/ODRIVE
ProjektPA-260XX
RevisionV1.3
Blatt01
RevisionV1.3

Illustration einer Struktur, keine Unterlage eines realen Kunden.

PLC / HMI / I/O

Verbindungen. Funktionen. Versionen.

PA—DOC / 01
01

Aus Komponenten wird ein verständliches Projekt.

Jeder Teil der Anlage gehört auch in die Dokumentation. Zusammen verbinden die Unterlagen Elektrik, Programme und technische Funktion.

AnlageErfassen und zuordnenDokumentation
Motor
Schaltplan
SPS
Projekt und Backup
HMI
HMI-Projekt
Umrichter
Parameter
Sensorik
I/O-Liste
Schaltschrank
Klemmen und Komponenten
Netzwerk
Kommunikationsstruktur
FunktionsbeschreibungVersion und Änderungen

Umfang und Bearbeitungstiefe richten sich nach Aufgabe und Vereinbarung.

Unterlagen müssen zur Realität passen.

Ein Plan, der nicht mehr zur Anlage gehört, hilft im Alltag wenig. Eine geänderte Verdrahtung, ein neues Bauteil oder eine Softwareanpassung sollten nachvollziehbar bleiben.

  1. 01Schrank umgebaut
  2. 02Komponenten ersetzt
  3. 03Software geändert
  4. 04Unterlagen aktualisiert?

Es reicht nicht, einen Ordner zu besitzen. Sein Inhalt muss einem bekannten Anlagenstand zugeordnet sein.

02

Welcher Stand ist tatsächlich aktuell?

Wählen Sie eine Revision von Schaltplan, SPS oder HMI. Der aktuelle Satz ist in diesem Beispiel festgelegt; die Versionsnummern der einzelnen Teile dürfen voneinander abweichen.

DemonstrationsbeispielPA-260XX / REV

Schaltplan

Im Beispiel aktuellV1.3

Diese Revision gehört zum aktuellen Satz dieses Beispiels. Im echten Projekt werden Status und Übereinstimmung mit der Anlage geprüft.

SPS-Projekt

Im Beispiel aktuellV2.3

Diese Revision gehört zum aktuellen Satz dieses Beispiels. Im echten Projekt werden Status und Übereinstimmung mit der Anlage geprüft.

HMI-Projekt

Im Beispiel aktuellV1.8

Diese Revision gehört zum aktuellen Satz dieses Beispiels. Im echten Projekt werden Status und Übereinstimmung mit der Anlage geprüft.

Die höchste Nummer beweist allein keine Aktualität. Entscheidend sind ein definierter Umfang, ein nachvollziehbarer Status und der Abgleich mit der realen Anlage.

03

Ein Projekt. Ein geordneter Unterlagensatz.

Öffnen Sie einen Bereich und wählen Sie eine Datei. So kann die Übergabe technischer Materialien strukturiert sein.

PA-260XXBeispiel einer Projektstruktur · ohne Kundendaten
Elektrik03
SPS01
HMI01
Antriebe01
Netzwerk01
Beschreibung01
Inhalt des Beispiels
PDF / Demonstrationsbeispiel

Leistungsstromkreise

Main_Circuit_V1.3.pdf

Zuordnung der Verbraucher zur Elektrik und zu den Gerätekennzeichen.

PDF / Demonstrationsbeispiel

Steuerstromkreise

Control_Circuit_V1.3.pdf

Steuerkreise, Klemmen und Verbindungen der Geräte.

XLSX / Demonstrationsbeispiel

I/O-Liste

IO_List.xlsx

Signale, Kanalverwendung und Zuordnung zur Anlage.

ZIP / Demonstrationsbeispiel

SPS-Projekt

PLC_V2.3.zip

Quellprojekt, Version und Hinweise zur benötigten Engineering-Umgebung.

ZIP / Demonstrationsbeispiel

HMI-Projekt

HMI_V1.8.zip

Visualisierungsprojekt, Variablen und Funktionen der Bedienoberfläche.

PDF / Demonstrationsbeispiel

Antriebsparameter

Drive_Parameters.pdf

Vereinbarter Parametersatz mit Zuordnung zu Umrichter und Motor.

PDF / Demonstrationsbeispiel

Netzwerkstruktur

Network_Overview.pdf

Teilnehmer, Schnittstellen und Struktur des Datenaustauschs.

PDF / Demonstrationsbeispiel

Funktionsbeschreibung

Functional_Description.pdf

Betriebsarten, Abläufe, betriebliche Verriegelungen und Funktionsbeschreibung.

Illustrative Vorschau. Kein echtes PDF, Backup oder herunterladbares Projekt.

Gezeigt wird eine mögliche Ablagestruktur. Es gibt hier kein Portal, keinen Dateiupload und keine Speicherung von Kundendaten.

04

Was kann zur Dokumentation gehören?

Klappen Sie ein technisches Blatt auf. Der konkrete Satz ergibt sich aus den Ausgangsdaten und dem vereinbarten Projektumfang.

01

Elektroschaltpläne

Leistungs- und Steuerstromkreise

Blatt 01 / 06
  • I/O und Kanalbelegung
  • Klemmen und Anschlüsse
  • Schrankkomponenten und Feldgeräte
02

SPS / Software

Ein nachvollziehbarer Softwarestand

Blatt 02 / 06
  • Aktuelles Projekt und Backup
  • Version und Kommentare
  • Struktur und benötigte Schnittstellen
03

HMI / SCADA

Bedienung und Visualisierung

Blatt 03 / 06
  • Projekt, Variablen und Bilder
  • Meldungen und Alarme
  • Benutzer- und Zugriffskonzept nach Aufgabe
04

Antriebe

Parameter im Kontext der Maschine

Blatt 04 / 06
  • Umrichtertyp und Motordaten
  • Relevante Einstellungen und Ansteuerung
  • Kommunikation und Parameterbackup, soweit vorgesehen
05

Netzwerk / Kommunikation

Nachvollziehbarer Datenaustausch

Blatt 05 / 06
  • Teilnehmer und Schnittstellen
  • Bus- und Verbindungsstruktur
  • Erforderliche Adressen und Kanalzuordnung
06

Funktionsbeschreibung

Was die Anlage tut und warum

Blatt 06 / 06
  • Betriebsarten
  • Abläufe und betriebliche Verriegelungen
  • Grundfunktionen und Übergangsbedingungen

Nicht jedes Projekt enthält alle genannten Unterlagen. Umfang, Formate, Quelldateien und Übergabe werden im Voraus abgestimmt.

05

Der Schaltplan ist die Landkarte der Anlage.

Vom Signal zum Gerät und zurück. Wählen Sie einen Weg oder bewegen Sie den Mauszeiger darüber.

Anlagentechnik
Zuordnung im PlanREF / 01–03

Motor

  1. 01Q1.1
  2. 02Zwischensteuerung
  3. 03Schütz K1
  4. 04Motor M1

Der Plan ordnet den SPS-Befehl der Schützansteuerung und dem zugehörigen Motor zu. Der Leistungsstromkreis wird gesondert betrachtet.

Analogsignal

  1. 01Sensor B1
  2. 02Klemmen X1
  3. 03Eingang AI1
  4. 04Wert in der SPS

Die Kanalbeschreibung verbindet Sensor, Anschluss, Eingang und die physikalische Bedeutung des Programmwerts.

Ventil

  1. 01SPS-Ausgang
  2. 02Klemmen X2
  3. 03Spule Y1
  4. 04Ventil

Kennzeichen machen die Verbindung zwischen Programmbefehl, Verdrahtung und Stellglied nachvollziehbar.

Technische Prinzipskizze / PA-260XX

Vereinfachtes Funktionsschema mit fiktiven Kennzeichen. Kein Verdrahtungsplan und keine Darstellung von Sicherheitskreisen.

06

Die Unterlagen hinken der Anlage hinterher?

Nach mehreren Reparaturen und Umbauten stimmt das Projekt möglicherweise nicht mehr mit der Wirklichkeit überein. Am Anfang stehen die vorhandenen Unterlagen und der zugängliche Anlagenzustand.

So entsteht die Lücke
  1. 01Schaltplan V1
  2. 02Mehrere Umbauten
  3. 03Veränderter Istzustand
So wird sie aufgearbeitet
  1. 01Aufnahme und Analyse
  2. 02Abgleich an der Anlage
  3. 03Vereinbarten Satz aktualisieren

Machbarkeit und Umfang einer Rekonstruktion werden vorher geprüft. Eine vollständige Wiederherstellung jeder unbekannten Altanlage lässt sich nicht pauschal zusagen.

07

Auch der nächste Ingenieur muss das Programm verstehen.

Jahre später zählt nicht nur, dass eine Funktion läuft, sondern auch, warum. Eine verständliche Struktur bewahrt das Wissen über die Anlage.

  • Symbolische Namen
  • Aussagekräftige Kommentare
  • Verständliche Funktionsgruppen
  • Nachvollziehbare Daten und Schnittstellen
  • Ein definierter aktueller Stand
PLC / DemonstrationsbeispielREV 2.3
01Betriebsarten
02Ablauf
03Diagnose

Gezeigt werden allgemeine Prinzipien. Interner Programmierstandard und Kundenquellcode werden nicht veröffentlicht.

08

Eine Änderung hinterlässt eine nachvollziehbare Spur.

Mehr als eine Dateinummer: Was wurde geändert, warum und zu welchem Anlagenstand gehört es?

Beispiel einer VersionsstrukturREV / LOG
  1. V1.0Erster Anlagenstart
  2. V1.1Sensor ergänzt
  3. V1.2Antriebslogik geändert
  4. V1.3HMI-Bild ergänzt
  5. V1.4Aktuellen Satz abgeglichen

Fiktiver Verlauf eines eigenständigen Beispiels. Kein Kundenprojekt und kein Bezug zu den Versionsnummern oben.

09

Wissen, das weiterarbeitet.

01

Für die Diagnose

Ein aktueller Plan hilft, die Herkunft eines Signals zu verfolgen. Ohne ihn müssen Verbindungen, Verdrahtung und Zuordnung zur Software erneut ermittelt werden.

  1. Signal
  2. Klemme
  3. SPS-Eingang
  4. Logik
Fehlerdiagnose

Dokumentation kann die Suche verkürzen. Eine bestimmte Zeitersparnis wird nicht zugesagt.

02

Für die Modernisierung

Die Umstellung beginnt mit dem Verständnis des Bestands. Bekannte I/O, Verbraucher, Hardware, Kommunikation und Funktionen machen die Vorbereitung nachvollziehbarer.

  1. I/O
  2. Hardware
  3. Kommunikation
  4. Funktion
Modernisierung
AS-BUILT

Festhalten, was tatsächlich realisiert wurde.

Nach der Inbetriebnahme müssen die umgesetzten Änderungen berücksichtigt werden. As-built bedeutet hier: Unterlagen bilden den tatsächlich ausgeführten Stand im vereinbarten Umfang ab.

Inbetriebnahme
PA / Blatt 08Demonstrationsbeispiel
  1. 01Entwurf
  2. 02Geprüft
  3. 03Aktueller Stand

Beispiel eines Prüfablaufs, keine Abnahme eines realen Projekts. Umfang und Übergabe der Bestandsunterlagen richten sich nach der Aufgabe.

10

Dokumentation in der praktischen Arbeit.

Reale Transport- und Verpackungslinie für Spanplattenpakete aus Case 003
Anlagenfoto aus dem veröffentlichten Case 003.
Case 003 · Verpackungslinie · 2026

Von SPS/HMI bis zur Bedienungsanleitung.

Für eine Transport- und Verpackungslinie für Spanplattenpakete wurden SPS-Programm und HMI entwickelt. Nach der Inbetriebnahme wurden Dokumentation und Bedienungsanleitung übergeben.

  • Siemens S7-1215 / HMI 7″
  • TIA Portal / WinCC
  • Anleitung und Dokumentation übergeben
Zum Projekt
Schaltschrank aus dem veröffentlichten Projekt 006
Anlagenfoto aus Case 006; vertrauliche Projektunterlagen werden nicht gezeigt.
Case 006 · Kommunikation · 2026

Klare Umbauanleitung für die Umsetzung aus der Ferne.

Beim Ersatz von Weidmüller durch ОВЕН ПЛК210 wurden Elektropläne, Anschlusspläne und eine Demontage- und Umbauanleitung erstellt. Sie begleiteten die remote betreute Arbeit der Kundentechniker.

  • CODESYS V3.5 / Siemens S7-1500
  • Modbus RTU / TCP
  • Schalt-, Anschluss- und Umbauunterlagen
Zum Projekt
Demonstrationsbeispiel

Welche Datei lässt sich eindeutig zuordnen?

Ein kleines Beispiel aus dem Projektordner. Wählen Sie einen Dateinamen.

Wählen Sie einen Namen zum Vergleichen.

Auch ein guter Name beweist keine Aktualität. Die Datei muss zum geprüften Anlagenstand gehören. Alle Namen hier sind fiktiv.

11

Vor dem Projektstart

Lässt sich die Dokumentation einer vorhandenen Anlage aktualisieren?

Ja, die Aufgabe wird nach Prüfung der Ausgangsunterlagen und des Anlagenzustands bewertet. Zugänglichkeit von Hardware und Software, Aufnahmeaufwand und Projektgrenzen bestimmen die Möglichkeiten.

Kann alles rekonstruiert werden, wenn Unterlagen fehlen?

Das lässt sich vorab nicht zusagen. Verfügbare Pläne, Geräte, Kennzeichnungen, Programme und Möglichkeiten zur Aufnahme werden zuerst geprüft. Daraus ergibt sich der mögliche Umfang.

Enthält jedes Projekt den gesamten gezeigten Satz?

Nein. Pläne, SPS-/HMI-Projekte, Parameter, I/O-Listen, Beschreibungen und weitere Unterlagen gehören im vereinbarten Umfang dazu. Formate und Quelldateiübergabe werden gesondert abgestimmt.

Ist die höchste Versionsnummer automatisch aktuell?

Nicht unbedingt. Der aktuelle Satz muss der realen Anlage zugeordnet sein und einen nachvollziehbaren Status besitzen. Nummer und Datum helfen bei der Identifikation, ersetzen aber keinen Abgleich.

Ist das bereits ein Kundenportal?

Nein. Ordner und Dateivorschau demonstrieren nur eine mögliche Struktur. Es gibt keine Anmeldung, Uploads, Speicherung von Kundenmaterial oder Downloads realer Projekte.

Verbindungen. Funktionen. Versionen.

Unterlagen für ein neues Projekt – oder Ordnung im Bestand?

Senden Sie die vorhandenen Materialien. Nach deren Sichtung lässt sich klären, welche Dokumentation erstellt oder überarbeitet werden sollte.

  • Vorhandene Schaltpläne
  • SPS-/HMI-Projekt
  • Fotos vom Schaltschrank
  • Geräteliste
  • Beschreibung der Änderungen

Zuerst Ausgangsdaten und Umfang prüfen. Danach den Dokumentationssatz festlegen.