TIA-Projektdokumentation mit KI
Dokumentation ist am Projektende oft das, wofür keine Zeit mehr bleibt. Mit TIA MCP erstellt sie ein KI-Assistent direkt aus dem im TIA Portal geöffneten Projekt: Bedienanleitung, Software-Übergabedokumentation, E/A-Checkliste für FAT und SAT, Kommentare in Bausteinen und einen Änderungsbericht. Die Daten stammen aus dem Projekt, die Texte schreibt die KI und Sie prüfen sie.
Welche Dokumente die KI aus einem TIA-Projekt erstellt
Alles entsteht aus Projektdaten, die TIA MCP über die offizielle Schnittstelle TIA Portal Openness liest. Die rechte Spalte zeigt das Format, das das Werkzeug tatsächlich speichert, und seinen Namen für alle, die mehr wissen wollen.
| Dokument | Inhalt | Ausgabe und Werkzeug |
|---|---|---|
| Bedienanleitung | Stückliste mit Bestellnummern, Netzwerk und IP-Adressen, Bausteine und Aufrufhierarchie, Parameter aus DBs, physische E/A, HMI-Bilder, Alarme und F-Signatur. Die Kapiteltexte schreibt die KI. | PDF aus einer LaTeX-Vorlage, Daten in JSONtia_manual_collecttia_manual_schematia_manual_render |
| HMI-Screenshots für die Anleitung | WinCC-Unified-Bilder aus der laufenden Simulation über den Web-Client, entsprechend der Navigation im Projekt. Bei älteren Panels werden die von Ihnen gelieferten Bildschirmbilder verwendet. | PNGtia_manual_screenshots |
| Anleitung nach Änderungen aktualisieren | Sie vergleicht die neuen Projektdaten mit der vorherigen Version und ermittelt, welche Kapitel bleiben, welche neu erzeugt werden und welche jemand umschreiben muss. Dann übernimmt sie nur die freigegebenen Änderungen. | Änderungsplan in JSON und Markdown, neue Version mit Revisionseintragtia_manual_update |
| Software-Übergabedokumentation | Projektübersicht, Hardware und IP, Aufrufhierarchie, Bausteinbeschreibungen, DBs und UDTs, E/A, HMI-Alarme, F-Fingerabdruck, Code-Review, Änderungen seit der letzten Ausgabe und ein Übergabeprotokoll zur Unterschrift. | PDF (LaTeX) und Baseline-JSON für die nächste Ausgabetia_handover_doc |
| Kommentare und Titel in Bausteinen | Die KI findet Netzwerke ohne Titel und Variablen ohne Kommentar, ergänzt sie und schreibt sie in den Baustein. Der Code des Bausteins bleibt unverändert. | Direkt im Projekt, Sicherung vor dem Schreibentia_block_doc_contexttia_set_block_documentation |
| Hilfe zu eigenen Bausteinen | Eine Seite pro Baustein mit Schnittstelle, Netzwerken, aufgerufenen Bausteinen und Aufrufbeispiel. Im TIA Portal öffnet sie sich mit Umschalt+F1. | HTML im Projektordner UserFilestia_block_help |
| Netzwerkdiagramme | KOP- und FUP-Netzwerke wie im TIA Portal, S7-GRAPH-Bausteine als Schrittkette mit Schritten und Transitionen. | SVGtia_block_diagram |
| Aufrufhierarchie | Aufrufgraph OB → FB/FC der gesamten SPS. | Mermaid-Graphtia_generate_call_hierarchy |
| E/A-Liste und FAT/SAT-Checkliste | Adresse, Variable, Typ und Kommentar jedes physischen Ein- und Ausgangs, dazu die Spalten OK/NOK, Datum, wer und Bemerkung. | Excel (XLSX) oder CSVtia_generate_io_checklisttia_export_io_checklist |
| Safety-Bericht und Protokolle | F-Ablaufgruppen, F-Bausteine mit Signatur, F-Peripherie-DBs und der Programm-Fingerabdruck. Der Vergleich mit der Baseline nach der Validierung zeigt, welche F-Bausteine sich geändert haben. Im TIA Portal V21 zusätzlich die offiziellen Signaturen und das Protokoll des Aktivierungstests. | JSON, Protokoll des Aktivierungstests als PDF (V21)tia_safety_reporttia_safety_validationtia_safety_validation_printout |
| Servicebericht aus der Diagnose | Das Ergebnis einer Störungsdiagnose der Maschine für die Servicedokumentation. | HTML und PDF (mit Edge oder Chrome auf dem PC)tia_diag_report |
| Änderungsbericht | Was sich zwischen zwei Projektversionen in Bausteinen, Safety-Bausteinen, UDTs, Variablen und Hardware geändert hat. Lesbar, nicht als roher XML-Diff. | Markdowntia_change_report |
| Projekttexte und Übersetzungen | Kommentare, Alarme und HMI-Texte nach Excel mit Statistik der fehlenden Übersetzungen. Die KI übersetzt sie in Stapeln mit Glossar und lässt Platzhalter unverändert, danach Import zurück. | Excel (XLSX)tia_export_project_textstia_texts_statstia_texts_translation_batchtia_texts_apply_translationstia_import_project_texts |
| Bausteine als lesbare Dokumente | Bausteine und UDTs als SIMATIC-SD-Dokumente für Code-Review und Archiv. TIA Portal V20 und neuer. | .s7dcl und .s7restia_export_documents |
So entsteht eine Bedienanleitung
Die Übergabedokumentation folgt demselben Weg. Sie können der KI die Schritte in einem Satz vorgeben oder sie in der Weboberfläche von TIA MCP durchgehen.
Daten sammeln
Die KI liest Hardware, Bausteine, E/A, HMI-Bilder und Alarme aus dem Projekt. Das Projekt bleibt unverändert.
Texte von der KI
Aus Code, Kommentaren und Ihrer Vorgabe schreibt sie Einleitung und Beschreibungen von Bildern und Bausteinen in eine Textdatei.
Screenshots
Aus der laufenden WinCC-Unified-Simulation nimmt sie die Bilder entsprechend der Navigation im Projekt auf.
PDF
Daten und Texte werden in eine LaTeX-Vorlage eingesetzt und zu PDF übersetzt. Ohne LaTeX auf dem PC entsteht eine .tex-Quelle.
Prüfung
Sie gehen Texte und Tabellen durch und korrigieren sie. Für den Inhalt ist verantwortlich, wer die Dokumentation übergibt.
Aktualisierung
Nach einer Änderung im Projekt ermittelt die KI, welche Kapitel betroffen sind, und gibt eine neue Version mit Revisionseintrag heraus.
Die Seite Projektdokumentation in der Web-GUI
Seit Version 2.19 hat die Weboberfläche von TIA MCP eine eigene Seite Projektdokumentation. Dort erstellen Sie Dokumente aus dem geöffneten Projekt, ohne einen Auftrag zu schreiben. Oben wählen Sie SPS oder HMI, die Dokumente sind in Registerkarten.
Bedienanleitung
Status der Anleitung (Daten, Texte, Screenshots, PDF), PDF neu erzeugen, Screenshots aus der laufenden Simulation und Aktualisierung einer fertigen Anleitung in zwei Phasen.
Übergabedokumentation
Sprache, Code-Review, Vergleich mit der letzten Ausgabe, eigene Texte und das fertige PDF mit eventuellen LaTeX-Fehlern.
E/A-Liste und Checkliste
Tabelle der physischen E/A mit Filter und FAT/SAT-Checkliste nach Excel.
Bausteindokumentation
Aufrufhierarchie, was im Baustein fehlt, ein Formular für Titel und Kommentare mit Schreiben nach Bestätigung und ein Netzwerkdiagramm als SVG. Die Texte kann der Copilot vorschlagen.
Safety (nur mit F-CPU)
Safety-Bericht mit Vergleich zur Baseline, Protokoll des Aktivierungstests (V21) und Ursache-Wirkungs-Matrix → F-Baustein mit Vorschau und Schreiben nach Bestätigung.
Export von Dokumenten und Texten
SIMATIC-SD-Dokumente, Projekttexte nach Excel mit Statistik, Übersetzung durch den Copilot und Import zurück nach Bestätigung.
Dateien werden im Ordner exports gespeichert und lassen sich herunterladen oder in der Vorschau ansehen (PDF, HTML, Bilder, Markdown). Schreibvorgänge ins Projekt erfolgen erst nach Bestätigung und sind im Nur-Lese-Modus deaktiviert. Den Änderungsbericht finden Sie auf der Seite Versionen und Änderungen.
Beispielaufträge für die KI
Sie schreiben in normaler Sprache. Ersetzen Sie die Namen von SPS, Bausteinen und Ordnern durch Ihre eigenen.
Erstelle eine Software-Übergabedokumentation für PLC_1 im Ordner D:\Uebergabe: Projektübersicht, Hardware und IP-Adressen, Aufrufhierarchie, Bausteinbeschreibungen, E/A und das Ergebnis des Code-Reviews.
Geh FB_Foerderband durch, ergänze Titel für alle Netzwerke und Kommentare für Variablen, die keine haben. Zeig mir den Vorschlag, bevor du ihn schreibst.
Erstelle eine FAT-Checkliste der physischen E/A für PLC_1 in Excel.
Sammle die Daten für eine Bedienanleitung aus PLC_1 und HMI_1, schreibe die Kapiteltexte und erstelle ein PDF mit Screenshots aus der laufenden Simulation.
Seit der letzten Ausgabe haben wir die Füllsequenz geändert. Aktualisiere die Bedienanleitung und zeig mir, welche Kapitel umgeschrieben werden müssen.
Exportiere die Projekttexte nach Excel, übersetze die fehlenden Kommentare ins Englische und zeig mir vor dem Import die Statistik.
Was ein Mensch prüfen muss
Die KI spart Schreiben und Suchen im Projekt. Die Verantwortung für die Dokumentation, die Sie an Kunden oder Bedienpersonal übergeben, bleibt aber bei Ihnen.
- Funktionsbeschreibungen. Die KI schreibt aus Code, Kommentaren und Ihrer Vorgabe. Zweck der Maschine und Zusammenhänge außerhalb des Programms kennt nur der Projektierer, lesen Sie die Texte daher vollständig.
- Safety. Safety-Bericht und Protokolle sind Unterlagen. Ergebnisse des Aktivierungstests bestätigt das Werkzeug nie, und generierte Safety-Logik muss eine verantwortliche Person prüfen, testen und validieren.
- Aktualisierung der Anleitung. Eine Änderung nur im Bausteinrumpf ohne Änderung von Schnittstelle oder Kommentar ist aus den Daten nicht erkennbar. Gehen Sie die zur Prüfung markierten Kapitel immer durch.
- Textimport. Er überschreibt Texte im gesamten Projekt, und für Texte wird keine Sicherung angelegt. Archivieren Sie das Projekt vor dem Import.
- Screenshots. Sie werden aus der laufenden Simulation aufgenommen. Prüfen Sie, dass die Bilder sinnvolle Werte zeigen.
- E/A-Checkliste. Es ist ein vorbereitetes Formular. Die Ergebnisse OK/NOK trägt der Techniker bei FAT und SAT ein.
Artikel: TIA-Projektdokumentation mit KI Schritt für Schritt
Git und Versionen von TIA-Projekten
Häufige Fragen zur TIA-Projektdokumentation
Was ist TIA-Projektdokumentation mit KI?
Ein KI-Assistent (zum Beispiel Claude, ChatGPT, Copilot, Gemini oder ein lokales Modell) ist über TIA MCP mit dem im TIA Portal geöffneten Projekt verbunden. Die Daten für die Dokumentation liest er direkt aus dem Projekt, die Texte schreibt er anhand des Codes und Ihrer Vorgabe. Das Ergebnis sind PDF-, Excel-, SVG- oder HTML-Dateien und Kommentare direkt in den Bausteinen.
Verändert das Erstellen der Dokumentation mein Projekt?
Die meisten Werkzeuge lesen das Projekt nur. Ins Projekt geschrieben werden nur Bausteinkommentare und -titel sowie der Import übersetzter Texte. Kommentare werden mit Sicherung geschrieben, und im Nur-Lese-Modus wird nichts geschrieben.
Brauche ich LaTeX für das PDF?
Ja. Bedienanleitung und Übergabedokumentation werden mit pdflatex (MiKTeX oder TeX Live) übersetzt. Ohne entsteht eine .tex-Quelldatei, die Sie später übersetzen. Excel, SVG und HTML brauchen kein LaTeX.
Lässt sich die Dokumentation nach einer Programmänderung aktualisieren?
Ja. Die Bedienanleitung wird in zwei Phasen aktualisiert: zuerst ein Änderungsplan nach Kapiteln, dann nur die freigegebenen Änderungen und eine neue Version mit Revisionseintrag. Die Übergabedokumentation merkt sich die letzte Ausgabe und listet auf, was sich seitdem geändert hat.
Funktioniert das auch mit HMI-Bildern?
Ja. WinCC-Unified-Bilder werden aus der laufenden Simulation über den Web-Client aufgenommen. Bei älteren Panels werden die Bilddaten aus dem Projekt gelesen und die von Ihnen gelieferten Bildschirmbilder in die Anleitung eingefügt.
In welchen Sprachen entsteht die Dokumentation?
Die Sprache der Projekttexte wählen Sie, die KI schreibt in der Sprache, um die Sie sie bitten. Kommentare und Projekttexte kann sie über einen Excel-Export und Import zurück übersetzen.
Für welche TIA-Portal-Versionen?
TIA Portal V17 bis V21 unter Windows. Einige Funktionen hängen von der Version ab: SIMATIC-SD-Dokumente ab V20, offizielle Safety-Signaturen und das Protokoll des Aktivierungstests in V21.
Was kostet es?
Die Dokumentationswerkzeuge sind Teil von TIA MCP. Eine PRO-Lizenz kostet 295 € pro Jahr und Rechner zzgl. MwSt., und die ersten 7 Tage können Sie TIA MCP kostenlos testen.
Siemens, SIMATIC, TIA Portal, WinCC und S7 sind Marken der Siemens AG. TIA MCP ist ein eigenständiges Produkt von Benešl Automation und kein Produkt der Siemens AG; es arbeitet mit dem TIA Portal über die offizielle Openness-Schnittstelle.