Visualise, document and explore your software architecture
Visualise, document and explore your software architecture
Software Architecture for Developers - Volume 2
About the Book
This book focusses on the visual communication and documentation of software architecture, based upon a collection of ideas and techniques that thousands of people across the world have found useful. The core of this is my C4 software architecture model and the software guidebook. You'll also find discussion about notation, the various uses for diagrams, the value of creating a model and tooling.
This book was formerly called "The Art of Visualising Software Architecture", and now additionally includes information about documentation.
About the Author
Bundles that include this book
Table of Contents
-
- About the book
- About the author
-
I Visualise
-
1. We have a failure to communicate
- 1.1 What happened to SSADM, RUP, UML, etc?
- 1.2 A lightweight approach
- 1.3 Moving fast requires good communication
- 1.4 Draw one or more diagrams
- 1.5 Where do we start?
- 1.6 Some examples
- 1.7 Common problems
- 1.8 The hidden assumptions of diagrams
-
2. A shared vocabulary
- 2.1 Common abstractions over a common notation
- 2.2 Static structure
- 2.3 Components vs code?
- 2.4 Modules and subsystems?
- 2.5 Microservices?
- 2.6 Serverless?
- 2.7 Platforms, frameworks and libraries?
- 2.8 Create your own shared vocabulary
-
3. The C4 model
- 3.1 Hierarchical maps of your code
-
4. Level 1: System Context diagram
- 4.1 Intent
- 4.2 Structure
- 4.3 Elements
- 4.4 Interactions
- 4.5 Motivation
- 4.6 Audience
- 4.7 Required or optional?
-
5. Level 2: Container diagram
- 5.1 Intent
- 5.2 Structure
- 5.3 Elements
- 5.4 Interactions
- 5.5 Motivation
- 5.6 Audience
- 5.7 Required or optional?
-
6. Level 3: Component diagram
- 6.1 Intent
- 6.2 Structure
- 6.3 Elements
- 6.4 Interactions
- 6.5 Motivation
- 6.6 Audience
- 6.7 Required or optional?
-
7. Level 4: Code-level diagrams
- 7.1 Intent
- 7.2 Structure
- 7.3 Motivation
- 7.4 Audience
- 7.5 Required or optional?
-
8. Notation
- 8.1 Titles
- 8.2 Keys and legends
- 8.3 Elements
- 8.4 Lines
- 8.5 Layout
- 8.6 Orientation
- 8.7 Acronyms
- 8.8 Quality attributes
- 8.9 Diagram scope
- 8.10 Listen for questions
-
9. Diagrams must reflect reality
- 9.1 The model-code gap
- 9.2 Technology details on diagrams
- 9.3 Would you code it that way?
-
10. Deployment diagrams
- 10.1 Network and infrastructure diagrams
- 10.2 Deployment diagrams
- 10.3 Cloud architecture diagrams
-
11. Other diagrams
- 11.1 Architectural view models
- 11.2 System Landscape
- 11.3 User interface mockups and wireframes
- 11.4 Business process and workflow
- 11.5 Domain model
- 11.6 Runtime and behaviour
- 11.7 And more
-
1. We have a failure to communicate
-
II Document
-
12. Software documentation as a guidebook
- 12.1 The code doesn’t tell the whole story
- 12.2 Our duty to deliver documentation
- 12.3 Lightweight, supplementary documentation
- 12.4 1. Maps
- 12.5 2. Sights
- 12.6 3. History and culture
- 12.7 4. Practical information
- 12.8 Describe what you can’t get from the code
- 12.9 Product vs project documentation
- 12.10 Keeping documentation up to date
- 12.11 Documentation length
-
13. Context
- 13.1 Intent
- 13.2 Structure
- 13.3 Motivation
- 13.4 Audience
- 13.5 Required
-
14. Functional Overview
- 14.1 Intent
- 14.2 Structure
- 14.3 Motivation
- 14.4 Audience
- 14.5 Required
-
15. Quality Attributes
- 15.1 Intent
- 15.2 Structure
- 15.3 Motivation
- 15.4 Audience
- 15.5 Required
-
16. Constraints
- 16.1 Intent
- 16.2 Structure
- 16.3 Motivation
- 16.4 Audience
- 16.5 Required
-
17. Principles
- 17.1 Intent
- 17.2 Structure
- 17.3 Motivation
- 17.4 Audience
- 17.5 Required
-
18. Software Architecture
- 18.1 Intent
- 18.2 Structure
- 18.3 Motivation
- 18.4 Audience
- 18.5 Required
-
19. Code
- 19.1 Intent
- 19.2 Structure
- 19.3 Motivation
- 19.4 Audience
- 19.5 Required
-
20. Data
- 20.1 Intent
- 20.2 Structure
- 20.3 Motivation
- 20.4 Audience
- 20.5 Required
-
21. Infrastructure Architecture
- 21.1 Intent
- 21.2 Structure
- 21.3 Motivation
- 21.4 Audience
- 21.5 Required
-
22. Deployment
- 22.1 Intent
- 22.2 Structure
- 22.3 Motivation
- 22.4 Audience
- 22.5 Required
-
23. Operation and Support
- 23.1 Intent
- 23.2 Structure
- 23.3 Motivation
- 23.4 Audience
- 23.5 Required
-
24. Development Environment
- 24.1 Intent
- 24.2 Structure
- 24.3 Motivation
- 24.4 Audience
- 24.5 Required
-
25. Decision Log
- 25.1 Intent
- 25.2 Structure
- 25.3 Motivation
- 25.4 Audience
- 25.5 Required
-
12. Software documentation as a guidebook
-
III Tooling
-
26. Sketches, diagrams, models and tooling
- 26.1 Sketches
- 26.2 Diagrams
- 26.3 Models
- 26.4 Reverse-engineering the software architecture model
- 26.5 Architecture description languages
- 26.6 Structurizr
- 26.7 Minimise the model-code gap
-
27. The C4 model with other notations and tools
- 27.1 Boxes and lines
- 27.2 UML (with a modeling tool)
- 27.3 UML (with PlantUML)
-
28. Exploring your software architecture model
- 28.1 Static structure
- 28.2 Dependency maps
- 28.3 Component size or complexity
- 28.4 Other ways to explore
-
29. Appendix A: Financial Risk System
- 29.1 Background
- 29.2 Functional Requirements
- 29.3 Non-functional Requirements
-
26. Sketches, diagrams, models and tooling
- Notes
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$11,049,989writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Software economics
Luis Artola¿Estás harto del "ellos" y "nosotros" cuando se habla de los técnicos y el resto de la empresa? ¿Sabes cuándo refactorizar "es bueno" pero no encuentras la manera de discutirlo con otros? ¿Te vendría bien un marco mental que te ayude a decidir cuando está justificado trabajar en pareja y cuando no?
- #2
Functional event-driven architecture: Powered by Scala 3
Gabriel VolpeExplore the event-driven architecture (EDA) in a purely functional way, mainly powered by Fs2 streams in Scala 3!
Leverage your functional programming skills by designing and writing stateless microservices that scale, powered by stateful message brokers.
- #3
Practical FP in Scala: A hands-on approach
Gabriel VolpeA practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
- #4
Hype Cycle Of The Top 50 Emerging Digital Health Trends
Dr. Bertalan MeskoDigital technologies have completely transformed our lives in the last couple of years and started to entirely reshape the landscape of healthcare. The future of healthcare is shaping up in front of our eyes with advances in digital healthcare technologies..
In this book, we analyze the Hype Cycle Of The Top 50 Emerging Digital Health Trends.
- #5
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #6
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #7
Deep Learning in Production
Sergios KaragiannakosBuild, train, deploy, scale and maintain deep learning models. Understand ML infrastructure and MLOps using hands-on examples.
- #8
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #9
node-opcua by example
Etienne RossignonGet the best out of node-opcua through a set of documented examples by the author himself that will allow you to create stunning OPCUA Servers or Clients.
- #10
Stratospheric
Tom Hombergs, Björn Wilmsmann, and Philip RiecksFrom Zero to Production with Spring Boot and AWS. All you need to know to get a Spring Boot application into production with AWS. No previous AWS knowledge required.
Go to stratospheric.dev for a tour of the contents.
Top Bundles
- #1
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #2
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #4
Practical FP in Scala + Functional event-driven architecture
2 Books
Practical FP in Scala (A hands-on approach) & Functional event-driven architecture, aka FEDA, (Powered by Scala 3), together as a bundle! The content of PFP in Scala is a requirement to understand FEDA so why not take advantage of this bundle!? - #5
Modern C++ Collection
3 Books
Get All about Modern C++C++ Standard Library, including C++20Concurrency with Modern C++, including C++20C++20Each book has about 200 complete code examples. Updates are included. When I update one of the books, you immediately get the updated bundle. You can expect significant updates to each new C++ standard (C++23, C++26, .. ) and also... - #7
Books on problem-solving using Agile, Lean, Complexity, and more
6 Books
Six great books on problem-solving. Learn how to deal with impediments using agile practices, do A3 problem-solving with lean thinking, apply complexity science, finding root causes, and do event storming. All in one buy for a largely reduced price! Books included Agile teams need to be able to handle impediments. The book Problem? What Problem?... - #8
10 Books Bundle - A New Career in Tech 🚀
10 Books
Do you want to create yourself a new and profitable skillset - in one year or less? Do you want to position yourself on the right side of change finally? Do you want to work from home and set your own work schedule while choosing fun and interesting coding projects? Software developers and freelance developersearn six figuresin the US, according... - #10
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible...
