DEV Community

Discussion on: Any questions about software architecture? Let us know for the chance to be featured on a DEV podcast!

dbanisimov profile image
Denis Anisimov

My perpetual struggle is documenting the software architecture. Boxes and arrows diagrams in a Google Doc works fine, but I keep searching for the better approach. What are the tools, processes, and automations an architect can use to produce and keep in sync the documentation?

simonbrown profile image
Simon Brown

In case this doesn't get asked/answered on the podcast ... I created something called the C4 model that might help. It's a hierarchical set of diagrams that can be used to visualise software architecture. The website has lots of information, examples, and some links to tooling too. My recommendation would be to look at text-based tooling, which you'll find easier to keep in sync with changes in your codebase.