Comment by sbuccini

3 years ago

This is very interesting. I had never heard of the C4 model before and will be using it going forward.

I'm skeptical that the current solution will be completely immune from doc rot but it certainly seems like there should be some way to generate/validate these diagrams from code. For example, there are many natural parallels between the flows diagrammed in your tool and setting up user journeys for E2E integration testing.

We're big believers that the C4 model gives a good lightweight approach and guidance for those who struggle to articulate the complexities of software.

Currently the code checks work through manual set up and won't remove all doc rot for sure, but indicates when drift is happening. This helps both direct to what code/resources are of interest (onboarding new hires), and also checks it still exists in the source control. More smarter checks to continue removing doc rot are planned.