UML and software engineering examples

[pmudry]

• Using #import "@preview/pintorita:0.1.1" for instance ?
• UML class diagram and other schemas
• State machines and time charts
• ....
• Document and make an example

[pmudry]

pintorita is probably not best way to go... mermaid could be a nice alternative, at least my experience so far has been great.

[LordBaryhobal]

I have made a very basic UML class diagram package for our report which looks like this:

It is not meant for more complex diagrams with relationships between classes, but it works pretty well in simple cases where you want to describe the contents of a single class.

Regarding state machines, there is the fletcher package, but it is not very practical to use due to its grid-based design (at least in my experience). I have managed to make some state machines directly using CeTZ, although I haven't implemented any auto-layout feature

I will try and see if I can do something for sequence diagrams using CeTZ
Let me know if any of this can be of use for the template or if you'd prefer using other tools

[pmudry]

Hi ! All those examples are really nice... still... the use of a layout engine really helps and might render the overall process easier. I found that https://play.d2lang.com/ is a very nice alternative to older (but great) engines such as graphviz. I would definitely try to investigate into this direction especially since d2lang has a Mozilla license.

[LordBaryhobal]

Hello, just wanted to let you know I've published a package for sequence diagrams which could be useful for students, maybe less so for ISC than SYND students though (see on Typst Universe)
I'm not sure including packages to make graphs and diagrams directly in the template would be the way to go however. I think it should be up to the user to choose which package they want to import
There could still be examples of how to make common diagrams (like class diagrams) but I'd keep it separate from the template itself, like you did with source code blocks