Documenting an Ignition Program I Didn't Make

I started a job that uses Ignition. They already have a mostly complete in house program they use to organize business operations. I am mostly here to fix bugs, and eventually start adding features.

We have zero documentation on this program, its databases or anything of that nature. I’ve started making ERM diagrams and keeping detailed notes on the windows/components/scripts in a heirarchal manner. But I feel like I’m not necessarily doing it right. Does anyone know of sample ignition documentation I can look at or have any pointers for how I should go about doing this? Thanks

I don’t know if you are already aware of this but you can View>Spotlights>Scrpiting. In this way, all the components that have scripts inside will be highlighted.

1 Like

I was not, that is helpful thank you!

1 Like

You can shortcut reviewing scripts by accessing a window’s entire configuration as XML. The menu item is normally hidden – use shift-right-click on the window in the designer’s navigation tree to expose both export and import of XML. The window does not have to be open.

The format is hard to read, but multiline scripts jump out as they are practically the only content that isn’t wildly indented. /-:


Also consider doing inline documentation in scripts as well.
I love to go into a script that I didn’t author and see comments in the code telling me what the code is doing.
Inline comments are for developers, outside written documentation is for the IT nerds :stuck_out_tongue: