Aleksandra
Member
Hello dear colleagues,
I would like to initiate a discussion about how you people document your PLC software. By saying this, I don't mean on operation manuals, user guide manuals, etc. I mean on a document which explains PLC software design and structure, like descriptions of function blocks, description of sequence, interface between different functions and function blocks, etc.
Many people say and recommend to write (even as a sketch) software design idea before you start coding. I know that this is a practice in IT programming and that they have developed powerful tools and ways for software documentation. But unfortunately, in the world of industrial automation, it seems like there is no such thing.
I have searched all over the Internet to find any document template, read many forums and posts, and everyone is just saying that PLC software needs to be documented, but no one says how. No one provides an example or template. People mention diagrams, but what kind of diagrams? I would prefer if on a diagram I could see which FB communicates with which FB or DB.
I see a huge advantage in actually having proper software documentation, in a situation where you created a software, but someone else needs to maintain it, or even you have to change something after several years and you don't want to waste time on recalling the idea or approach that you had when you initially wrote it.
So, if someone is in a mood for sharing tips and tricks, I would be more than glad to hear it. Any opinions, screenshots, pieces of advice, absolutely everything is welcome and the best thing would be if more people join the discussion.
If something like this doesn't exist, I am even into inventing a new way for writing documentation for PLC software which would be used by PLC programmers.
Looking forward to hearing from you,
Aleksandra
I would like to initiate a discussion about how you people document your PLC software. By saying this, I don't mean on operation manuals, user guide manuals, etc. I mean on a document which explains PLC software design and structure, like descriptions of function blocks, description of sequence, interface between different functions and function blocks, etc.
Many people say and recommend to write (even as a sketch) software design idea before you start coding. I know that this is a practice in IT programming and that they have developed powerful tools and ways for software documentation. But unfortunately, in the world of industrial automation, it seems like there is no such thing.
I have searched all over the Internet to find any document template, read many forums and posts, and everyone is just saying that PLC software needs to be documented, but no one says how. No one provides an example or template. People mention diagrams, but what kind of diagrams? I would prefer if on a diagram I could see which FB communicates with which FB or DB.
I see a huge advantage in actually having proper software documentation, in a situation where you created a software, but someone else needs to maintain it, or even you have to change something after several years and you don't want to waste time on recalling the idea or approach that you had when you initially wrote it.
So, if someone is in a mood for sharing tips and tricks, I would be more than glad to hear it. Any opinions, screenshots, pieces of advice, absolutely everything is welcome and the best thing would be if more people join the discussion.
If something like this doesn't exist, I am even into inventing a new way for writing documentation for PLC software which would be used by PLC programmers.
Looking forward to hearing from you,
Aleksandra