codebase-visualizer-action VS c4-notation

Nice post - treemaps are great!

My friend and I made a codebase visualisation tool (https://www.codeatlas.dev/gallery) that's based on Voronoi treemaps, maybe of interest as an illustration of the aesthetics with a non-rectangular layout!

We've opted for zooming through double-clicks as the main method of navigating the map, because in deep codebases, the individual cells quickly get too small to accurately target with the cursor as shown in the key-path label approach!

If anyone's interested, this is also available as a Github Action to generate the treemap during CI: https://github.com/codeatlasHQ/codebase-visualizer-action

If you find this type of codebase visualisation useful, you might want to checkout codeatlas.dev and its Github Action (https://github.com/codeatlasHQ/codebase-visualizer-action). It doesn't animate the repo over time like gource (yet), but instead aims to give a beautiful interactive visual snapshot of a repo at a particular point in time. It also lets you zoom in on specific aspects like recent commit activity, programming language and hopefully in the future test coverage.

E.g. see here for a visualisation of the pytorch codebase we did a while ago: https://codeatlas.dev/gallery/pytorch/pytorch

(disclaimer: I'm the author)

If you think this is useful, you might also like codeatlas.dev and its Github Action (https://github.com/codeatlasHQ/codebase-visualizer-action). It currently does not support per-contributor activity, but we put a lot of effort into making the diagrams beautiful to look at and the basic approach of using treemaps for visualisation seems very similar. In fact, could be cool to collaborate on this, DM me if interested!

https://codeatlas.dev

https://codeatlas.dev - codebase visualisation tool

Takes your git repo and generates a beautiful visual representation of the code. Sort of an alternative navigation tool (in addition to IDEs) for large codebases. Can also run it as part of CI with our Github Action (https://github.com/codeatlasHQ/codebase-visualizer-action).

We made this because grokking complex software projects is really difficult and we've found that a visual overview of what's in a codebase can be quite helpful to get started.

E.g. checkout https://codeatlas.dev/gallery/kubernetes/kubernetes for the generated visualisation of the Kubernetes Github repo!

Currently making -10$/year to pay for the domain :D We slowed down active development after our initial attempts at dissemination didn't really go anywhere (bragging about side projects on the internet, ugh), but I'm still really keen on getting some feedback on whether this is actually useful to anyone else!

Note: The site works somewhat on mobile, but is much better on desktop!

Also, funny there's a post like this again, just like https://news.ycombinator.com/item?id=34531989 yesterday.

https://codeatlas.dev - codebase visualisation tool

It takes your git repo and generates a beautiful visual representation of the actual code that's in it. Sort of an alternative navigation tool (in addition to IDEs) for large codebases. You can run codeatlas as part of your CI with our Github Action (https://github.com/codeatlasHQ/codebase-visualizer-action).

We made this because grokking complex software projects is really difficult and we've found that a visual overview of what's in a codebase can be quite helpful to get started.

E.g. checkout https://codeatlas.dev/gallery/kubernetes/kubernetes for the generated visualisation of the Kubernetes Github repo!

We slowed down active development after our initial attempts at dissemination didn't really go anywhere (bragging about side projects on the internet, ugh), but would still love feedback on whether this is possibly useful to anyone else!

Note: The site works somewhat on mobile, but is much better on desktop!

I've already mentioned this on the other thread (https://news.ycombinator.com/item?id=31569646), but my friend and I have been working on [https://www.codeatlas.dev](https://www.codeatlas.dev/) as a sideproject - it's a tool for creating pretty (2D!) visualisations of codebases, while providing additional insights via overlays (e.g. commit density, programming language or other results from static analysis like dead code/test coverage/etc.). For example here's the Kubernetes codebase visualised using codeatlas: [https://www.codeatlas.dev/repo/kubernetes/kubernetes](https:....

At the moment, codeatlas is just the static gallery, but we're only a few weekends away from releasing a Github action that deploys this diagram on github pages for your own repos - if you're interested, feel free to watch this repo: https://github.com/codeatlasHQ/codebase-visualizer-action

OP, how close is this to what you had in mind in your question?

My friend and I have been working on https://www.codeatlas.dev in our spare time, which is a tool that creates pretty (2D!) visualisations of codebases, while providing additional insights via overlays (e.g. commit density, programming language). For example here's the Kubernetes codebase visualised using codeatlas: https://www.codeatlas.dev/repo/kubernetes/kubernetes.

At the moment, codeatlas is only a static gallery, but we're currently about 1-2 weekends away from releasing a Github action that deploys this diagram on github pages for your own repos - if you're interested, feel free to watch this repo: https://github.com/codeatlasHQ/codebase-visualizer-action

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

I looked at the book OP is talking about and it seems to be advocating 'C4' (https://c4model.com/). IMO this is the same kind of block diagrams we end up creating organically. I dunno that I'd call this 'modern' or anything special, it's just what everyone already does. I've done hundreds of these and not once has anyone ever mentioned 'C4' or anything being 'modern'. Shrug