Zapytaj o projekt
Benešl Automation / AI dla TIA Portal / Dokumentacja projektu
Instrukcja obsługi · Dokumentacja odbiorcza · Checklista I/O · Komentarze bloków · Safety

Dokumentacja projektu TIA z AI

Dokumentacja to często to, na co pod koniec projektu brakuje czasu. Z TIA MCP asystent AI przygotowuje ją prosto z projektu otwartego w TIA Portal: instrukcję obsługi, dokumentację odbiorczą oprogramowania, checklistę I/O na FAT i SAT, komentarze w blokach i raport zmian. Dane pochodzą z projektu, teksty pisze AI, a Ty je sprawdzasz.

Jakie dokumenty AI tworzy z projektu TIA

Wszystko powstaje z danych projektu, które TIA MCP odczytuje przez oficjalny interfejs TIA Portal Openness. W prawej kolumnie jest format, który narzędzie faktycznie zapisuje, i jego nazwa dla tych, którzy chcą wiedzieć więcej.

DokumentCo zawieraWynik i narzędzie
Instrukcja obsługiZestawienie z numerami zamówieniowymi, sieć i adresy IP, bloki i hierarchia wywołań, parametry z DB, fizyczne I/O, ekrany HMI, alarmy i sygnatura F. Teksty rozdziałów pisze AI.PDF z szablonu LaTeX, dane w JSON
tia_manual_collect
tia_manual_schema
tia_manual_render
Zrzuty ekranów HMI do instrukcjiEkrany WinCC Unified z działającej symulacji przez klienta webowego, zgodnie z nawigacją w projekcie. Przy starszych panelach używane są dostarczone przez Ciebie obrazy ekranów.PNG
tia_manual_screenshots
Aktualizacja instrukcji po zmianachPorównuje nowe dane projektu z poprzednią wersją i określa, które rozdziały zostają, które zostaną wygenerowane ponownie, a które ktoś musi przepisać. Potem wprowadza tylko zatwierdzone poprawki.Plan zmian w JSON i Markdown, nowa wersja z wpisem rewizji
tia_manual_update
Dokumentacja odbiorcza oprogramowaniaPrzegląd projektu, sprzęt i IP, hierarchia wywołań, opis bloków, DB i UDT, I/O, alarmy HMI, odcisk F, code review, zmiany względem poprzedniego wydania i protokół odbioru do podpisu.PDF (LaTeX) i bazowy JSON dla kolejnego wydania
tia_handover_doc
Komentarze i tytuły w blokachAI znajduje sieci bez tytułu i zmienne bez komentarza, uzupełnia je i zapisuje w bloku. Kod bloku się nie zmienia.Bezpośrednio w projekcie, kopia zapasowa przed zapisem
tia_block_doc_context
tia_set_block_documentation
Pomoc do własnych blokówStrona dla każdego bloku z interfejsem, sieciami, wywoływanymi blokami i przykładem wywołania. W TIA Portal otwiera się przez Shift+F1.HTML w folderze projektu UserFiles
tia_block_help
Diagramy sieciSieci LAD i FBD jak w TIA Portal, bloki S7-GRAPH jako sekwencja kroków i przejść.SVG
tia_block_diagram
Hierarchia wywołańGraf wywołań OB → FB/FC całego PLC.Graf Mermaid
tia_generate_call_hierarchy
Lista I/O i checklista FAT/SATAdres, tag, typ i komentarz każdego fizycznego wejścia i wyjścia oraz kolumny OK/NOK, data, kto i uwagi.Excel (XLSX) lub CSV
tia_generate_io_checklist
tia_export_io_checklist
Raport safety i protokołyGrupy F-runtime, bloki F z sygnaturą, DB F-I/O i odcisk programu. Porównanie z bazą po walidacji pokazuje, które bloki F się zmieniły. W TIA Portal V21 także oficjalne sygnatury i protokół testu aktywacyjnego.JSON, protokół testu aktywacyjnego PDF (V21)
tia_safety_report
tia_safety_validation
tia_safety_validation_printout
Raport serwisowy z diagnostykiWynik diagnostyki awarii maszyny do dokumentacji serwisowej.HTML i PDF (z Edge lub Chrome na komputerze)
tia_diag_report
Raport zmianCo zmieniło się między dwiema wersjami projektu w blokach, blokach safety, UDT, tagach i sprzęcie. Czytelnie, a nie jako surowy diff XML.Markdown
tia_change_report
Teksty projektu i tłumaczeniaKomentarze, alarmy i teksty HMI do Excela ze statystyką brakujących tłumaczeń. AI tłumaczy je partiami z glosariuszem i nie zmienia symboli zastępczych, potem import z powrotem.Excel (XLSX)
tia_export_project_texts
tia_texts_stats
tia_texts_translation_batch
tia_texts_apply_translations
tia_import_project_texts
Bloki jako czytelne dokumentyBloki i UDT jako dokumenty SIMATIC SD do code review i archiwum. TIA Portal V20 i nowsze..s7dcl i .s7res
tia_export_documents

Jak powstaje instrukcja obsługi

Dokumentacja odbiorcza powstaje tak samo. Kroki możesz zlecić AI jednym zdaniem albo przejść je w interfejsie webowym TIA MCP.

  1. Zbieranie danych

    AI odczytuje z projektu sprzęt, bloki, I/O, ekrany HMI i alarmy. Projekt się nie zmienia.

  2. Teksty od AI

    Z kodu, komentarzy i Twojego polecenia pisze wstęp oraz opisy ekranów i bloków do pliku z tekstami.

  3. Zrzuty ekranu

    Z działającej symulacji WinCC Unified robi zrzuty ekranów zgodnie z nawigacją w projekcie.

  4. PDF

    Dane i teksty trafiają do szablonu LaTeX i są kompilowane do PDF. Bez LaTeX na komputerze powstaje źródło .tex.

  5. Kontrola

    Przeglądasz i poprawiasz teksty oraz tabele. Za treść odpowiada ten, kto przekazuje dokumentację.

  6. Aktualizacja

    Po zmianie w projekcie AI ustala, których rozdziałów dotyczy, i wydaje nową wersję z wpisem rewizji.

Strona Dokumentacja projektu w web GUI

Od wersji 2.19 interfejs webowy TIA MCP ma własną stronę Dokumentacja projektu. Tworzysz na niej dokumenty z otwartego projektu bez pisania polecenia. Na górze wybierasz PLC lub HMI, dokumenty są w zakładkach.

Instrukcja obsługi

Stan instrukcji (dane, teksty, zrzuty ekranu, PDF), ponowne generowanie PDF, zrzuty z działającej symulacji i aktualizacja gotowej instrukcji w dwóch fazach.

Dokumentacja odbiorcza

Język, code review, porównanie z poprzednim wydaniem, własne teksty i wynikowy PDF z ewentualnymi błędami LaTeX.

Lista I/O i checklista

Tabela fizycznych I/O z filtrem i checklista FAT/SAT do Excela.

Dokumentacja bloków

Hierarchia wywołań, czego brakuje w bloku, formularz tytułów i komentarzy z zapisem po potwierdzeniu oraz diagram sieci w SVG. Teksty może zaproponować Copilot.

Safety (tylko z F-CPU)

Raport safety z porównaniem z bazą, protokół testu aktywacyjnego (V21) i macierz przyczyn i skutków → blok F z podglądem i zapisem po potwierdzeniu.

Eksport dokumentów i tekstów

Dokumenty SIMATIC SD, teksty projektu do Excela ze statystyką, tłumaczenie przez Copilota i import z powrotem po potwierdzeniu.

Pliki zapisują się w folderze exports i można je pobrać lub obejrzeć w podglądzie (PDF, HTML, obrazy, Markdown). Zapisy do projektu następują dopiero po potwierdzeniu i w trybie tylko do odczytu są wyłączone. Raport zmian jest na stronie Wersje i zmiany.

Przykładowe polecenia dla AI

Piszesz zwykłym językiem. Nazwy PLC, bloków i folderów zastąp własnymi.

Utwórz dokumentację odbiorczą oprogramowania dla PLC_1 w folderze D:\Odbior: przegląd projektu, sprzęt i adresy IP, hierarchię wywołań, opis bloków, I/O i wynik code review.

Przejrzyj FB_Przenosnik, uzupełnij tytuły wszystkich sieci i komentarze zmiennych, które ich nie mają. Zanim to zapiszesz, pokaż mi propozycję.

Zrób checklistę FAT fizycznych I/O dla PLC_1 w Excelu.

Zbierz dane do instrukcji obsługi z PLC_1 i HMI_1, napisz teksty rozdziałów i utwórz PDF ze zrzutami ekranu z działającej symulacji.

Od poprzedniego wydania zmieniliśmy sekwencję napełniania. Zaktualizuj instrukcję obsługi i pokaż mi, które rozdziały trzeba przepisać.

Wyeksportuj teksty projektu do Excela, przetłumacz brakujące komentarze na angielski i przed importem pokaż mi statystykę.

Co musi sprawdzić człowiek

AI oszczędza pisanie i szukanie w projekcie. Odpowiedzialność za dokumentację, którą przekazujesz klientowi lub obsłudze, pozostaje jednak po Twojej stronie.

  • Opisy funkcji. AI pisze na podstawie kodu, komentarzy i Twojego polecenia. Cel maszyny i kontekst poza programem zna tylko projektant, dlatego przeczytaj teksty w całości.
  • Safety. Raport safety i protokoły są materiałem pomocniczym. Narzędzie nigdy nie potwierdza wyników testu aktywacyjnego, a wygenerowaną logikę safety musi sprawdzić, przetestować i zwalidować osoba odpowiedzialna.
  • Aktualizacja instrukcji. Zmiany tylko w treści bloku bez zmiany interfejsu lub komentarza nie da się wykryć z danych. Rozdziały oznaczone do sprawdzenia przeglądaj zawsze.
  • Import tekstów. Nadpisuje teksty w całym projekcie, a dla tekstów nie powstaje kopia zapasowa. Przed importem zarchiwizuj projekt.
  • Zrzuty ekranu. Są robione z działającej symulacji. Sprawdź, czy ekrany pokazują sensowne wartości.
  • Checklista I/O. To przygotowany formularz. Wyniki OK/NOK wpisuje technik podczas FAT i SAT.

Artykuł: dokumentacja projektu TIA z AI krok po kroku

Git i wersje projektów TIA

Testowanie programu PLC w PLCSIM z AI

Wszystkie narzędzia TIA MCP według obszarów

Częste pytania o dokumentację projektu TIA

Czym jest dokumentacja projektu TIA z AI?

Asystent AI (na przykład Claude, ChatGPT, Copilot, Gemini lub model lokalny) jest połączony przez TIA MCP z projektem otwartym w TIA Portal. Dane do dokumentacji odczytuje bezpośrednio z projektu, a teksty pisze na podstawie kodu i Twojego polecenia. Wynikiem są pliki PDF, Excel, SVG lub HTML oraz komentarze bezpośrednio w blokach.

Czy tworzenie dokumentacji zmienia mój projekt?

Większość narzędzi tylko odczytuje projekt. Do projektu zapisywane są tylko komentarze i tytuły bloków oraz import przetłumaczonych tekstów. Komentarze zapisują się z kopią zapasową, a w trybie tylko do odczytu nic się nie zapisuje.

Czy do PDF potrzebuję LaTeX?

Tak. Instrukcja obsługi i dokumentacja odbiorcza są kompilowane przez pdflatex (MiKTeX lub TeX Live). Bez niego powstaje plik źródłowy .tex, który skompilujesz później. Excel, SVG i HTML nie wymagają LaTeX.

Czy dokumentację można zaktualizować po zmianie programu?

Tak. Instrukcja obsługi jest aktualizowana w dwóch fazach: najpierw plan zmian według rozdziałów, potem tylko zatwierdzone poprawki i nowa wersja z wpisem rewizji. Dokumentacja odbiorcza pamięta poprzednie wydanie i wypisuje, co się od niego zmieniło.

Czy obsługuje też ekrany HMI?

Tak. Ekrany WinCC Unified są przechwytywane z działającej symulacji przez klienta webowego. Przy starszych panelach dane ekranów są odczytywane z projektu, a do instrukcji wstawiane są dostarczone przez Ciebie obrazy ekranów.

W jakich językach powstaje dokumentacja?

Język tekstów z projektu wybierasz Ty, a AI pisze w języku, o który poprosisz. Komentarze i teksty projektu potrafi przetłumaczyć przez eksport do Excela i import z powrotem.

Dla jakich wersji TIA Portal?

TIA Portal od V17 do V21 w systemie Windows. Niektóre funkcje zależą od wersji: dokumenty SIMATIC SD od V20, oficjalne sygnatury safety i protokół testu aktywacyjnego w V21.

Ile to kosztuje?

Narzędzia do dokumentacji są częścią TIA MCP. Licencja PRO kosztuje 295 € rocznie za komputer bez VAT, a przez pierwsze 7 dni możesz wypróbować TIA MCP za darmo.

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