News for hackers. Stuff that matters.
Re:Ask HN: Guidelines for making clear architecture diagrams by glawre on Wednesday May 01, 2024 @03:34PM (#40228232)
I like the C4 Model as a guide on the different levels of abstraction that you might need for your system.
Re:Ask HN: Guidelines for making clear architecture diagrams by pinkmuffinere on Wednesday May 01, 2024 @04:30PM (#40228973)
Oh thanks, this looks like the kind of thing I was searching for — will read up on it
Re:Ask HN: Guidelines for making clear architecture diagrams by NomDePlum on Wednesday May 01, 2024 @06:02PM (#40230084)
Second this.

Reference for anyone looking I to it: https://c4model.com/

There is also quite a lot of options for helping create these diagrams. I've found https://structurizr.com/ to be the best of what I've tried so far.

Re:Ask HN: Guidelines for making clear architecture diagrams by Onawa on Wednesday May 01, 2024 @06:15PM (#40230248)
I like the idea behind structurizr, but I found the syntax to be too constraining and the tooling around it to be difficult to deal with. That was 2 years ago though,maybe I should revisit it.
Re:Ask HN: Guidelines for making clear architecture diagrams by NomDePlum on Wednesday May 01, 2024 @07:07PM (#40230710)
Not sure it will have changed that much.

There are definitely limitations, for me being able to encode and version control diagrams and system documentation alongside a codebase made the tradeoff worth it.

Re:Ask HN: Guidelines for making clear architecture diagrams by Terretta on Friday May 03, 2024 @06:45AM (#40246192)
icepanel implements tooling

https://icepanel.io/

Re:Ask HN: Guidelines for making clear architecture diagrams by NomDePlum on Saturday May 04, 2024 @03:59AM (#40255819)
Looks really good. Some nice articles in the blog section too.
Re:Ask HN: Guidelines for making clear architecture diagrams by jasonpeacock on Wednesday May 01, 2024 @07:46PM (#40231029)
Third this. Don't look any further, just do it!

Also, PlantUML + C4 is like peanut butter & jelly:

https://github.com/plantuml-stdlib/C4-PlantUML

I'll gladly give up control of layout, and accept some ugliness, to never again have to worry about dragging boxes and arrows to be pixel-aligned, and then do it all over again when I add another box...

It looks like Mermaid has C4 support too:

https://mermaid.js.org/syntax/c4.html