Visualising and documenting software architecture cheat sheets

My cheat sheet summarising the C4 model has now been updated, and I've created another to summarise my thoughts on how to document software architecture. Click the images for the full-size (A3) PDF file.

Visualising software architecture Documenting software architecture

I hope you find them useful!

About the author

Simon is an independent consultant specializing in software architecture, and the author of Software Architecture for Developers (a developer-friendly guide to software architecture, technical leadership and the balance with agility). He’s also the creator of the C4 software architecture model and the founder of Structurizr, which is a collection of open source and commercial tooling to help software teams visualise, document and explore their software architecture.

You can find Simon on Twitter at @simonbrown ... see simonbrown.je for information about his speaking schedule, videos from past conferences and software architecture training.



Re: Visualising and documenting software architecture cheat sheets

I have recently used C4 as a starting point when describing proposed architecture in a few project proposals, which seems to be a good starting point.

I often find that I also need to describe the domain model, however, and I have taken to use the unused C (classes) to describe [domain] classes. What do you think of this modification?

Re: Visualising and documenting software architecture cheat sheets

That last, typically unused, C level is really for showing the implementation details of components. But if it works for you then, sure. I also sometimes describe the domain classes, just not necessarily as a part of the static structure (C4). If you're doing DDD, then it's a different story ... and you might see some of those domain concepts at the component level.

Add a comment Send a TrackBack