TIA Portal project documentation in minutes: what AI can do and what a human must check
Every customer wants software documentation and almost nobody wants to write it. Yet a large part of the content is already in the project: hardware, IP addresses, blocks, the call hierarchy, inputs and outputs, alarms. AI connected to TIA Portal can extract it, add descriptions and assemble it into PDF or Excel. We describe what can be done with a single request and what a human must check before handover.
What is usually missing in TIA project documentation
A typical state before handover: networks without titles, variables without comments, an I/O list in Excel that does not match the project and an operating manual taken over from an older machine. Documentation gets written at the end, when there is no time left for it, and it goes out of date after every change.
The good news is that most of the facts can be read from the project automatically. The manual work is mainly explaining why the program does something and writing instructions for the operators.
What the AI extracts from the TIA project on its own
- A project overview: PLCs and HMIs, block counts by type and language, F-CPUs, tag tables and UDTs.
- Hardware and network: modules, IP addresses and a network topology graph.
- The block call hierarchy as a diagram.
- LAD and FBD networks as SVG images and GRAPH sequences with steps and transitions.
- Physical inputs and outputs with comments and, from them, a FAT and SAT checklist in Excel with OK and NOK columns.
- A fault table: WinCC Unified alarms and PLC messages with empty columns for the possible cause and the remedy.
- Blocks and UDTs as readable SIMATIC SD text documents, from TIA Portal V20.
All of these are facts from the project. The AI does not invent them; it only reads and assembles them.
Comments and titles directly in the blocks
The most useful documentation is the one inside the project. For each block TIA MCP prepares the basis: the interface, the code, existing titles and comments, what is missing and who calls the block. From this the AI writes the block title and comment, network titles and variable comments and writes them into the block. The code does not change, and a backup is saved before writing.
This is where review is needed most. The AI describes what the code does. Why it does it, the AI can only tell from names and comments. The comment “5 s delay” is true, but only “5 s delay so that the valve has time to open before the pump starts” is useful.
Handover documentation and an operating manual in PDF
The software handover documentation contains a project overview, hardware and IP addresses, the call hierarchy, block descriptions, data blocks and UDTs, inputs and outputs, HMI alarms, the safety program fingerprint, a code review summary and a handover protocol for signature. For the next release TIA MCP compares it with the previous one and lists what has changed.
The operating manual is created in two steps. TIA MCP collects data from the project including the HMI screens, the AI writes the chapter texts and the template is typeset into PDF. Screenshots of WinCC Unified screens are taken automatically from the running simulation. When the project changes, the manual update first shows a plan: which chapters are unchanged, which are regenerated from data and which someone has to rewrite. The new version gets an entry in the revision history.
The PDF is typeset in LaTeX, so pdflatex (MiKTeX or TeX Live) must be installed on the computer. Without it you get the .tex source file.
The Project documentation page in the web interface
Since version 2.19.0 the TIA MCP web interface has a Project documentation page. After you select the PLC and HMI it offers tabs: operator manual, handover documentation, IO list and checklist, block documentation, change report, safety (only for projects with an F-CPU) and export of documents and texts. Files are saved to the exports folder and can be downloaded or previewed straight away.
The same page also covers project texts: export to Excel, translation with AI and import back after confirmation. After the import TIA MCP exports the texts again and shows what remained untranslated.
Example requests for the AI
Give me an overview of the project and generate the call hierarchy for PLC_1. Then list the blocks that have no network titles or variable comments.
Add network titles and variable comments to FB_Doser in English. Show me the texts first and write them only after approval. Where you cannot tell the purpose of the code, write a question instead of a guess.
Create the software handover documentation for PLC_1 and HMI_1 in English with a code review summary. Compare it with the baseline from the previous release.
Generate an I/O checklist for the FAT in Excel and a fault table from the alarms of HMI_1 and PLC_1.
What to watch out for: what a human must check
- Purpose and context. The AI describes the code but does not know the process or the agreements with the customer. Block descriptions and manual chapters must be read by someone who knows the machine.
- Operator safety. Warnings, procedures for faults and instructions for safe work must be written or approved by the person responsible for them. The machine manufacturer is responsible for the machine's instructions for use.
- The safety program. The fingerprint and signatures from the project are facts, but validating the safety program remains the job of a qualified person.
- Numbers and parameters. Compare setpoints, times and limits in the text with the project and with the specification. If they contradict each other, the error may be in the program or in the specification.
- Translations. Check technical terms and abbreviations against the customer's glossary or with a native speaker. Placeholders in alarm texts must stay unchanged; TIA MCP rejects a translation with broken placeholders.
- Currency. Documentation applies to a specific version of the project. State it in the document and update the documentation after changes.
Summary
With AI, collecting the facts from a TIA project and assembling documents from them takes a single request. Spend the time you save on review: the purpose of blocks, safety instructions, numbers and translations. The documentation then matches the project and can be updated after changes instead of being rewritten.
You will find an overview of all documentation tools on the page TIA project documentation with AI.
Frequently asked questions
Can AI write documentation for a PLC program in TIA Portal?
Yes, if it can see the project. Through TIA MCP the AI reads blocks, hardware, inputs and outputs and alarms, adds titles and comments and creates handover documentation in PDF. Descriptions of purpose and instructions for operators must be checked by a human.
Does the AI change the block code when adding comments?
No. Only the titles and comments of the block, networks and variables are written. A backup is saved before writing and can be restored with one command.
In which formats is the documentation created?
Handover documentation and the operating manual in PDF via LaTeX, the I/O checklist and fault table in Excel, diagrams as SVG or Mermaid and the change report in Markdown. Blocks can also be exported as SIMATIC SD text documents.
How do I keep the documentation up to date after project changes?
The handover documentation is compared with the previous release and lists the changes. The operating manual is updated according to a plan of changes by chapter. A change report between project versions is created from the text export of the project in Git.
Related articles and pages
- AI review of a PLC program before FAT: code review in TIA Portal
- AI and WinCC Unified: what can and cannot be automated on screens
- Testing PLC programs with AI: unit tests and simulation in PLCSIM
- TIA project documentation with AI
Document your project with AI
TIA MCP connects ChatGPT, Claude, Copilot or Gemini to TIA Portal V17–V21 on Windows. A PRO licence costs €295 per year per computer excluding VAT, and the first 7 days are free.
Siemens, SIMATIC, TIA Portal, WinCC and S7 are trademarks of Siemens AG. TIA MCP is an independent product of Benešl Automation, is not a Siemens product and works with TIA Portal through the official TIA Portal Openness interface.