I thought that looked like Simon Brown’s stuff.

He’s largely influenced by the “enterprise-y” stuff (hence UML).

I have yet to encounter any documentation or literature connected to the BEAM that used UML (not that it means anything) - more often than not it resorts to “whiteboard art”, e.g.:

• Hitchhikers Guide to the Unexpected
• Designing for Scalability with Erlang/OTP
  
  

  dseo_0102560×518 53.2 KB

However if you insist on using UML I’d recommend that you focus on Sequence and Activity diagrams aspects which are typically neglected in other, more mainstream contexts.

System architecture

• UML component diagram.

Static view (UML class diagram):

• Elixir Module = Class
• Elixir Function = Method
• Relationships among modules = Dependencies (“use”, …).

Dynamic view:

• Sequence diagram (scenarios).
• Activity diagram (workflows).

Tests (Behavior Driven Development):

• UML State machine diagram.

If you find something interesting, I am also interested in this. As a solo and small team developer with a couple projects, I frequently need to orient myself back in the codebase. Having these maps available would definitely help with doing a little bit at a time.

For sequence diagrams, et is a great tool, already comes with Elixir + OTP

“C4-PlantUML & PlantUML” is a good choice for create C4/UML models:

• Snippets for VSCode.
• Layout options: Top-Down, Left-Right, … .

https://github.com/RicardoNiepel/C4-PlantUML
http://plantuml.com/en/

Alternatives to PlantUML: https://c4model.com/#tooling

Thank you!

Thank you! Do you go through a checklist when you are developing? I enjoyed the article from @peerreynders The Hitchhiker’s Guide to the Unexpected .

• Unit tests, Integration tests, Acceptance tests, … .
• Code coverage.
• BDD: Behavior driven development.

C4 Diagram: https://c4model.com/assets/software-architecture-diagram-review-checklist.pdf

… it all depends on the context.

Thanks for that, I’ll check that checklist and the C4 model… all in the name of lower mental overhead.

I want to share this work GitHub - joaohf/OTP-PlantUML: OTP diagrams using PlantUML · GitHub

My intention is to create a small set of plantuml shortcuts to help design and document Erlang and Elixir systems.

Thanks.