TIA Portal project documentation with AI
Documentation is often what there is no time left for at the end of a project. With TIA MCP an AI assistant prepares it straight from the project open in TIA Portal: operating manual, software handover documentation, I/O checklist for FAT and SAT, block comments and a change report. The data comes from the project, the AI writes the texts and you review them.
Which documents the AI creates from a TIA project
Everything is built from project data that TIA MCP reads through the official TIA Portal Openness interface. The right-hand column shows the format the tool actually saves and its name for those who want to know more.
| Document | What it contains | Output and tool |
|---|---|---|
| Operating manual | Bill of materials with order numbers, network and IP addresses, blocks and call hierarchy, parameters from DBs, physical I/O, HMI screens, alarms and F-signature. The AI writes the chapter texts. | PDF from a LaTeX template, data in JSONtia_manual_collecttia_manual_schematia_manual_render |
| HMI screenshots for the manual | WinCC Unified screens from the running simulation through the web client, following the navigation in the project. For older panels the screen images you supply are used. | PNGtia_manual_screenshots |
| Updating the manual after changes | It compares new project data with the previous version and determines which chapters stay, which are regenerated and which someone has to rewrite. Then it applies only the approved edits. | Change plan in JSON and Markdown, new version with a revision entrytia_manual_update |
| Software handover documentation | Project overview, hardware and IP, call hierarchy, block descriptions, DBs and UDTs, I/O, HMI alarms, F-fingerprint, code review, changes since the previous release and a handover record for signature. | PDF (LaTeX) and a baseline JSON for the next releasetia_handover_doc |
| Comments and titles in blocks | The AI finds networks without a title and variables without a comment, fills them in and writes them to the block. The block code does not change. | Directly in the project, backed up before writingtia_block_doc_contexttia_set_block_documentation |
| Help for your own blocks | A page for each block with the interface, networks, called blocks and a call example. In TIA Portal it opens with Shift+F1. | HTML in the project's UserFiles foldertia_block_help |
| Network diagrams | LAD and FBD networks as in TIA Portal, S7-GRAPH blocks as a sequence of steps and transitions. | SVGtia_block_diagram |
| Call hierarchy | Call graph OB → FB/FC of the whole PLC. | Mermaid graphtia_generate_call_hierarchy |
| I/O list and FAT/SAT checklist | Address, tag, type and comment of every physical input and output, plus OK/NOK, date, who and note columns. | Excel (XLSX) or CSVtia_generate_io_checklisttia_export_io_checklist |
| Safety report and records | F-runtime groups, F-blocks with signatures, F-I/O DBs and the program fingerprint. A comparison with the baseline after validation shows which F-blocks changed. In TIA Portal V21 also the official signatures and the activation test record. | JSON, activation test record as PDF (V21)tia_safety_reporttia_safety_validationtia_safety_validation_printout |
| Service report from diagnostics | The result of a machine fault diagnosis for the service documentation. | HTML and PDF (with Edge or Chrome on the PC)tia_diag_report |
| Change report | What changed between two project versions in blocks, safety blocks, UDTs, tags and hardware. Readable, not as a raw XML diff. | Markdowntia_change_report |
| Project texts and translations | Comments, alarms and HMI texts to Excel with statistics of missing translations. The AI translates them in batches with a glossary and leaves placeholders untouched, then they are imported back. | Excel (XLSX)tia_export_project_textstia_texts_statstia_texts_translation_batchtia_texts_apply_translationstia_import_project_texts |
| Blocks as readable documents | Blocks and UDTs as SIMATIC SD documents for code review and the archive. TIA Portal V20 and later. | .s7dcl and .s7restia_export_documents |
How an operating manual is created
Handover documentation follows the same path. You can give the AI the steps in one sentence or go through them in the TIA MCP web interface.
Collecting data
The AI reads hardware, blocks, I/O, HMI screens and alarms from the project. The project does not change.
Texts from the AI
From the code, comments and your brief it writes the introduction and descriptions of screens and blocks into a text file.
Screenshots
It captures the screens from the running WinCC Unified simulation following the navigation in the project.
PDF
Data and texts are filled into a LaTeX template and compiled to PDF. Without LaTeX on the PC a .tex source is produced.
Review
You read and correct the texts and tables. Whoever hands over the documentation is responsible for its content.
Updates
After a change in the project the AI finds which chapters it affects and issues a new version with a revision entry.
The Project documentation page in the web GUI
Since version 2.19 the TIA MCP web interface has its own Project documentation page. You create documents from the open project there without writing a prompt. You choose the PLC or HMI at the top, the documents are in tabs.
Operating manual
Status of the manual (data, texts, screenshots, PDF), re-rendering the PDF, screenshots from the running simulation and updating a finished manual in two phases.
Handover documentation
Language, code review, comparison with the previous release, your own texts and the resulting PDF with any LaTeX errors.
I/O list and checklist
A table of physical I/O with a filter and a FAT/SAT checklist to Excel.
Block documentation
Call hierarchy, what is missing in a block, a form for titles and comments written after confirmation, and a network diagram in SVG. The Copilot can suggest the texts.
Safety (F-CPU only)
Safety report with a comparison against the baseline, activation test record (V21) and a cause-and-effect matrix → F-block with preview and writing after confirmation.
Exporting documents and texts
SIMATIC SD documents, project texts to Excel with statistics, translation by the Copilot and import back after confirmation.
Files are saved to the exports folder and can be downloaded or previewed (PDF, HTML, images, Markdown). Writes to the project happen only after confirmation and are disabled in read-only mode. The change report is on the Versions and changes page.
Example prompts for the AI
You write in plain language. Replace the names of PLCs, blocks and folders with your own.
Create software handover documentation for PLC_1 in D:\Handover: project overview, hardware and IP addresses, call hierarchy, block descriptions, I/O and the code review result.
Go through FB_Conveyor, add titles to all networks and comments to variables that lack them. Show me the proposal before you write it.
Make a FAT checklist of the physical I/O for PLC_1 in Excel.
Collect the data for an operating manual from PLC_1 and HMI_1, write the chapter texts and create a PDF with screenshots from the running simulation.
We changed the filling sequence since the last release. Update the operating manual and show me which chapters need rewriting.
Export the project texts to Excel, translate the missing comments into English and show me the statistics before importing.
What a person has to check
The AI saves writing and searching in the project. Responsibility for the documentation you hand over to the customer or the operators remains with you.
- Function descriptions. The AI writes from the code, comments and your brief. Only the engineer knows the purpose of the machine and the context outside the program, so read the texts in full.
- Safety. The safety report and records are supporting material. The tool never confirms activation test results, and generated safety logic must be checked, tested and validated by a responsible person.
- Manual updates. A change only in the body of a block without a change to its interface or comment cannot be detected from the data. Always go through the chapters marked for review.
- Text import. It overwrites texts in the whole project and no backup is made for texts. Archive the project before importing.
- Screenshots. They are taken from the running simulation. Check that the screens show meaningful values.
- I/O checklist. It is a prepared form. The technician fills in the OK/NOK results during FAT and SAT.
Article: TIA project documentation with AI step by step
Git and versions of TIA projects
FAQ about TIA project documentation
What is TIA project documentation with AI?
An AI assistant (for example Claude, ChatGPT, Copilot, Gemini or a local model) is connected through TIA MCP to the project open in TIA Portal. It reads the data for the documentation directly from the project and writes the texts based on the code and your brief. The result is PDF, Excel, SVG or HTML files and comments directly in the blocks.
Does creating documentation change my project?
Most tools only read the project. Only block comments and titles and the import of translated texts are written to the project. Comments are written with a backup, and in read-only mode nothing is written.
Do I need LaTeX for the PDF?
Yes. The operating manual and handover documentation are compiled with pdflatex (MiKTeX or TeX Live). Without it a .tex source file is produced that you can compile later. Excel, SVG and HTML do not need LaTeX.
Can the documentation be updated after a program change?
Yes. The operating manual is updated in two phases: first a change plan by chapter, then only the approved edits and a new version with a revision entry. The handover documentation remembers the previous release and lists what has changed since.
Does it handle HMI screens too?
Yes. WinCC Unified screens are captured from the running simulation through the web client. For older panels the screen data is read from the project and the screen images you supply are inserted into the manual.
In which languages is the documentation created?
You choose the language of the project texts, and the AI writes in the language you ask for. It can translate project comments and texts via an Excel export and import back.
Which TIA Portal versions?
TIA Portal V17 to V21 on Windows. Some functions depend on the version: SIMATIC SD documents from V20, official safety signatures and the activation test record in V21.
How much does it cost?
The documentation tools are part of TIA MCP. A PRO licence costs €295 per year per computer, excluding VAT, and you can try TIA MCP free for the first 7 days.
Siemens, SIMATIC, TIA Portal, WinCC and S7 are trademarks of Siemens AG. TIA MCP is an independent product of Benešl Automation and not a Siemens product; it works with TIA Portal through the official Openness interface.