4 ms·
We’ve started to embrace PlantUML in our Systems and Software engineering teams at work. One nice feature of this markup language is creating diagrams programm
by kejaed 7y ago
We’ve started to embrace PlantUML in our Systems and Software engineering teams at work.
One nice feature of this markup language is creating diagrams programmatically. We wrote a small python tool that will take a State Transition Table (States cross Events) and create the diagram. I have found it helpful to start from the table to ensure States and Events are well defined and all options are considered, but once that is done the diagram is also quite useful for discussion.
Things that we have found helpful are the MediaWiki plugin and the Word plugin.
We’ve also started adding unique identifiers to all diagrams across our large development program, and keeping all diagrams in one central spot. That alone has been almost as useful as PlantUML.
- FPGAhacker 7y agoCan you expound upon how the unique identifiers are used and how the central repo works?
- kejaed 7y agoIt is REALLY nothing exciting or novel, sorry to disappoint. I got tired of finding documents with a figure we needed somewhere else and hunting for 15 minutes for the source material. We number the figures PRJ-FIG_0001 and have the source files in a top level shared folder (or svn/git). Note it’s important to have the figure id in the figure itself as well as the file name so when it’s imported into a doc the ID is embedded in the figure itself.