Zapytaj o projekt
Benešl Automation / Artykuły / Dokumentacja projektu TIA
Artykuł techniczny · Dokumentacja PLC i HMI

Dokumentacja projektu TIA Portal w kilka minut: co potrafi AI, a co musi sprawdzić człowiek

Dokumentacji oprogramowania chce każdy klient, a prawie nikt nie chce jej pisać. Tymczasem duża część treści już jest w projekcie: sprzęt, adresy IP, bloki, hierarchia wywołań, wejścia i wyjścia, alarmy. AI podłączona do TIA Portal potrafi to wyciągnąć, uzupełnić opisy i złożyć w PDF lub Excel. Opisujemy, co da się zrobić jednym poleceniem, a co musi sprawdzić człowiek przed przekazaniem.

Ing. Tomáš Benešl · 21.10.2026 · 6 minut czytania

Czego zwykle brakuje w dokumentacji projektu TIA

Typowy stan przed przekazaniem: sieci bez tytułów, zmienne bez komentarzy, lista I/O w Excelu niezgodna z projektem i instrukcja obsługi przejęta ze starszej maszyny. Dokumentację pisze się na końcu, gdy brakuje na nią czasu, i dezaktualizuje się po każdej zmianie.

Dobra wiadomość jest taka, że większość faktów da się odczytać z projektu automatycznie. Ręczna praca zostaje głównie przy wyjaśnieniu, dlaczego program coś robi, i przy wskazówkach dla obsługi.

Co AI sama wyciągnie z projektu TIA

  • Przegląd projektu: sterowniki PLC i HMI, liczba bloków według typu i języka, F-CPU, tabele tagów i UDT.
  • Sprzęt i sieć: moduły, adresy IP i graf topologii sieci.
  • Hierarchię wywołań bloków jako diagram.
  • Sieci LAD i FBD jako obrazy SVG oraz sekwencje GRAPH z krokami i przejściami.
  • Fizyczne wejścia i wyjścia z komentarzami, a z nich lista kontrolna FAT i SAT w Excelu z kolumnami OK i NOK.
  • Tabelę usterek: alarmy WinCC Unified i komunikaty z PLC z pustymi kolumnami na możliwą przyczynę i sposób usunięcia.
  • Bloki i UDT jako czytelne dokumenty tekstowe SIMATIC SD, od TIA Portal V20.

Wszystko to są fakty z projektu. AI ich nie wymyśla, tylko je czyta i zestawia.

Komentarze i tytuły bezpośrednio w blokach

Najbardziej przydatna dokumentacja to ta w projekcie. TIA MCP przygotowuje dla każdego bloku materiały: interfejs, kod, istniejące tytuły i komentarze, czego brakuje i kto blok wywołuje. Na tej podstawie AI pisze tytuł i komentarz bloku, tytuły sieci i komentarze zmiennych i zapisuje je do bloku. Kod się przy tym nie zmienia, a przed zapisem zapisuje się kopia zapasowa.

Tutaj kontrola jest potrzebna najbardziej. AI opisuje, co kod robi. Dlaczego to robi, pozna tylko z nazw i komentarzy. Komentarz „Opóźnienie 5 s” jest prawdziwy, ale przydatny jest dopiero komentarz „Opóźnienie 5 s, aby zawór zdążył się otworzyć przed startem pompy”.

Dokumentacja odbiorcza i instrukcja obsługi w PDF

Dokumentacja odbiorcza oprogramowania zawiera przegląd projektu, sprzęt i adresy IP, hierarchię wywołań, opis bloków, bloki danych i UDT, wejścia i wyjścia, alarmy HMI, odcisk programu safety, podsumowanie code review i protokół odbioru do podpisu. Przy kolejnym wydaniu TIA MCP porównuje ją z poprzednim i wypisuje, co się zmieniło.

Instrukcja obsługi powstaje w dwóch krokach. TIA MCP zbiera dane z projektu łącznie z ekranami HMI, AI pisze teksty rozdziałów, a szablon jest składany do PDF. Zrzuty ekranów WinCC Unified wykonują się automatycznie z działającej symulacji. Gdy projekt się zmieni, aktualizacja instrukcji najpierw pokaże plan: które rozdziały są bez zmian, które zostaną wygenerowane z danych, a które ktoś musi przepisać. Nowa wersja dostaje wpis w historii rewizji.

PDF jest składany w LaTeX, dlatego na komputerze musi być pdflatex (MiKTeX lub TeX Live). Bez niego otrzymasz plik źródłowy .tex.

Strona Dokumentacja projektu w interfejsie webowym

Od wersji 2.19.0 interfejs webowy TIA MCP ma stronę Dokumentacja projektu. Po wybraniu PLC i HMI oferuje zakładki: podręcznik obsługi, dokumentacja odbiorcza, lista I/O i lista kontrolna, dokumentacja bloków, raport zmian, safety (tylko w projektach z F-CPU) oraz eksport dokumentów i tekstów. Pliki zapisują się w folderze exports i można je od razu pobrać lub wyświetlić w podglądzie.

Na tej samej stronie są też teksty projektu: eksport do Excela, tłumaczenie z pomocą AI i import z powrotem po potwierdzeniu. Po imporcie TIA MCP ponownie eksportuje teksty i pokazuje, co zostało nieprzetłumaczone.

Przykładowe polecenia dla AI

Zrób przegląd projektu i wygeneruj hierarchię wywołań dla PLC_1. Potem wypisz bloki, które nie mają tytułów sieci lub komentarzy zmiennych.
Uzupełnij tytuły sieci i komentarze zmiennych w FB_Doser po polsku. Najpierw pokaż mi teksty, zapisz je dopiero po akceptacji. Gdzie nie rozpoznasz celu kodu, napisz pytanie zamiast przypuszczenia.
Utwórz dokumentację odbiorczą oprogramowania dla PLC_1 i HMI_1 po polsku z podsumowaniem code review. Porównaj ją z baseline z poprzedniego wydania.
Wygeneruj listę kontrolną I/O na FAT w Excelu i tabelę usterek z alarmów HMI_1 i PLC_1.

Na co uważać: co musi sprawdzić człowiek

  • Cel i kontekst. AI opisze kod, ale nie zna technologii ani ustaleń z klientem. Opisy bloków i rozdziały instrukcji musi przeczytać ktoś, kto zna maszynę.
  • Bezpieczeństwo obsługi. Ostrzeżenia, postępowanie przy awarii i wskazówki bezpiecznej pracy musi napisać lub zatwierdzić osoba, która za nie odpowiada. Za instrukcję użytkowania maszyny odpowiada jej producent.
  • Program safety. Odcisk i sygnatury z projektu to fakty, ale walidacja programu safety pozostaje zadaniem wykwalifikowanej osoby.
  • Liczby i parametry. Porównaj wartości zadane, czasy i progi w tekście z projektem i ze specyfikacją. Jeśli są sprzeczne, błąd może być w programie albo w założeniach.
  • Tłumaczenia. Terminy fachowe i skróty sprawdź z glosariuszem klienta lub z native speakerem. Symbole zastępcze w tekstach alarmów muszą pozostać bez zmian, TIA MCP odrzuci tłumaczenie z uszkodzonymi symbolami zastępczymi.
  • Aktualność. Dokumentacja dotyczy konkretnej wersji projektu. Podaj ją w dokumencie i po zmianach aktualizuj dokumentację.

Podsumowanie

Z AI zebranie faktów z projektu TIA i złożenie z nich dokumentów to kwestia jednego polecenia. Zaoszczędzony czas przeznacz na kontrolę: celu bloków, wskazówek bezpieczeństwa, liczb i tłumaczeń. Dokumentacja odpowiada wtedy projektowi i po zmianach można ją aktualizować, zamiast pisać od nowa.

Przegląd wszystkich narzędzi do dokumentacji znajdziesz na stronie Dokumentacja projektu TIA z AI.

Częste pytania

Czy AI potrafi napisać dokumentację programu PLC w TIA Portal?

Tak, jeśli widzi projekt. Przez TIA MCP AI czyta bloki, sprzęt, wejścia i wyjścia oraz alarmy, uzupełnia tytuły i komentarze i tworzy dokumentację odbiorczą w PDF. Opisy celu i wskazówki dla obsługi musi sprawdzić człowiek.

Czy AI zmienia kod bloku przy uzupełnianiu komentarzy?

Nie. Zapisują się tylko tytuły i komentarze bloku, sieci i zmiennych. Przed zapisem zapisuje się kopia zapasowa, którą można przywrócić jednym poleceniem.

W jakich formatach powstaje dokumentacja?

Dokumentacja odbiorcza i instrukcja obsługi w PDF przez LaTeX, lista kontrolna I/O i tabela usterek w Excelu, diagramy jako SVG lub Mermaid, a raport zmian w Markdownie. Bloki można też eksportować jako dokumenty tekstowe SIMATIC SD.

Jak utrzymać aktualność dokumentacji po zmianach w projekcie?

Dokumentacja odbiorcza jest porównywana z poprzednim wydaniem i wypisuje zmiany. Instrukcja obsługi jest aktualizowana według planu zmian w podziale na rozdziały. Raport zmian między wersjami projektu powstaje z eksportu tekstowego projektu w Git.

Powiązane artykuły i strony

Udokumentuj swój projekt z AI

TIA MCP łączy ChatGPT, Claude, Copilota lub Gemini z TIA Portal V17–V21 w systemie Windows. Licencja PRO kosztuje 295 € rocznie za komputer bez VAT, pierwsze 7 dni jest za darmo.

Siemens, SIMATIC, TIA Portal, WinCC i S7 są znakami towarowymi Siemens AG. TIA MCP to samodzielny produkt Benešl Automation, nie jest produktem firmy Siemens i współpracuje z TIA Portal przez oficjalny interfejs TIA Portal Openness.