LookAtThat VS c4-notation

https://github.com/tikimcfee/LookAtThat

View, search, and analyze arbitrary source code (best support of Swift right now) in 3D and AR space. You open your phone or tablet, yeet hundreds of files into 3D space, and can start highlighting, moving, and tracing execution by literally walking around your code. The desktop app has similar features, and the standard 3D viewer is just as fun.

I would love help - from anyone of any kind - to build this out towards greater usefulness. It’s a lot of fun, it’s super cool to look at, and it’s the thing I’ve wanted to use since I was a small child.

“Let me touch the words!!”

I feel like I’ve been spamming this everywhere and any time I get the chance, but I really want people to join in and help define this experience with me for developers.

https://github.com/tikimcfee/LookAtThat

AR VR for iOS and macOS. Millions of glyphs. Instant control. There’s magic here. If this excites you, work with me and help make this a reality! I don’t have all of it in me.

I wish I did. I don’t. I don’t have all the time and energy. But there are people here that if they spent just a little time to work on this, we would be in the future of a 3D code space in days, and not weeks or months.

I owe a new readme for the project. If any of this makes you feel any feelies, get in contact with me star it, make noise, whatever!

Lotta love to yall. Thanks for letting me vomit words.

I have this mostly working for Swift by thread and execution tracing matched to syntax analysis in https://github.com/tikimcfee/LookAtThat.

You can record app execution, and then play it back thread and line and by line to see each line executing in time. It’s kinda fun to see millions of lines flash and highlight and move at 60fps and seeing implicit relationships between executing files and high level functional flows

If I may be so bold as include something I’m working on myself, I’d love to chime in! I’m not functionally complete, but feel like I’m writing an amalgamation of all of the above tools.

https://github.com/tikimcfee/LookAtThat

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.

What you are describing sounds a lot like C4: https://c4model.com/

The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels.

For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1].

As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale.

[0]: https://c4model.com

[1]: https://sebokwiki.org

[2]: https://adr.github.io

There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:

I would suggest that if your architecture diagrams are a bunch of icons provided by AWS/Azure/GCP with lines pointing at each other... you are doing it wrong.

The 'what does this box do for my system' is vastly more important than the 'which in vogue offering from my cloud provider implements it'.

I highly suggest folks take a look at the C4 Model: https://c4model.com/

We often use abstractions in software engineering to communicate complex architectures and software systems. In this article, we’ll discuss how abstractions are inherently hierarchical and how the C4 model provides a nested structure for defining your software architecture. We’ll then cover how IcePanel allows you to create interactive and zoomable diagrams for your audience to zoom in and out of different levels of technical detail.

You probably want https://c4model.com/ which explains what a C4 architecture diagram is. (See the first footnote in the article.)