fun2src

fun2src

Hi all,

I’m trying to choose a modeling tool (free/opensource) for describing a system written in Elixir. I’ll use UML/C4-Model. I need a good tool compatible with Linux/MacOS.

C4 model

C4-PlantUML??

Showing Posts 1 to 10

peerreynders

peerreynders

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.:

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.

fun2src

fun2src OP

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.
mintymac

mintymac

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.

rodrigues

rodrigues

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

fun2src

fun2src OP

“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

mintymac

mintymac

Thank you!

mintymac

mintymac

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 .

fun2src

fun2src OP

  • 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.

mintymac

mintymac

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

joaohf

joaohf

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.

— All posts loaded —

Where Next? Top

Trending in Questions Top

Blokh
Hey guys, I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly Do you guys have any suggestions what is the best prac...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
Onor.io
I have what I’ve heard referred to as a “lookup table” in my database. This is a way of assigning codes to common values. One common lo...
New
Trolleger
What approach to take when sending live updates to “random” users Hi! I have a question, I have a little chat app, and when I create a DM...
New
matt-savvy
Anyone here using Honeybadger? My Honeybadger account is being overwhelmed with noise from some bots. Seeing a lot of Bandit.HTTPError...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New

Other Trending Topics Top

mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews