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
-
- 1. About the book
- 2. About the author
-
I Visualise
-
3. We have a failure to communicate
- 3.1 What happened to SSADM, RUP, UML, etc?
- 3.2 A lightweight approach
- 3.3 Draw one or more diagrams
- 3.4 Where do we start?
- 3.5 Some examples
- 3.6 Common problems
- 3.7 The hidden assumptions of diagrams
-
4. A shared vocabulary
- 4.1 Common abstractions over a common notation
- 4.2 Static structure
- 4.3 Components vs code?
- 4.4 Modules and subsystems?
- 4.5 Microservices?
- 4.6 Serverless?
- 4.7 Platforms, frameworks and libraries?
- 4.8 Create your own shared vocabulary
-
5. The C4 model
- 5.1 Hierarchical maps of your code
-
6. Level 1: System Context 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 2: Container diagram
- 7.1 Intent
- 7.2 Structure
- 7.3 Elements
- 7.4 Interactions
- 7.5 Motivation
- 7.6 Audience
- 7.7 Required or optional?
-
8. Level 3: Component diagram
- 8.1 Intent
- 8.2 Structure
- 8.3 Elements
- 8.4 Interactions
- 8.5 Motivation
- 8.6 Audience
- 8.7 Required or optional?
-
9. Level 4: Code-level diagrams
- 9.1 Intent
- 9.2 Structure
- 9.3 Motivation
- 9.4 Audience
- 9.5 Required or optional?
-
10. Notation
- 10.1 Titles
- 10.2 Keys and legends
- 10.3 Elements
- 10.4 Lines
- 10.5 Layout
- 10.6 Orientation
- 10.7 Acronyms
- 10.8 Quality attributes
- 10.9 Diagram scope
- 10.10 Listen for questions
-
11. Diagrams must reflect reality
- 11.1 The model-code gap
- 11.2 Technology details on diagrams
- 11.3 Would you code it that way?
-
12. Deployment diagrams
- 12.1 Network and infrastructure diagrams
- 12.2 Deployment diagrams
- 12.3 Cloud architecture diagrams
-
13. Other diagrams
- 13.1 Architectural view models
- 13.2 System Landscape
- 13.3 User interface mockups and wireframes
- 13.4 Business process and workflow
- 13.5 Domain model
- 13.6 Runtime and behaviour
- 13.7 And more
-
3. We have a failure to communicate
-
II Document
-
14. Software documentation as a guidebook
- 14.1 The code doesn’t tell the whole story
- 14.2 Our duty to deliver documentation
- 14.3 Lightweight, supplementary documentation
- 14.4 1. Maps
- 14.5 2. Sights
- 14.6 3. History and culture
- 14.7 4. Practical information
- 14.8 Describe what you can’t get from the code
- 14.9 Product vs project documentation
- 14.10 Keeping documentation up to date
- 14.11 Documentation length
-
15. Context
- 15.1 Intent
- 15.2 Structure
- 15.3 Motivation
- 15.4 Audience
- 15.5 Required
-
16. Functional Overview
- 16.1 Intent
- 16.2 Structure
- 16.3 Motivation
- 16.4 Audience
- 16.5 Required
-
17. Quality Attributes
- 17.1 Intent
- 17.2 Structure
- 17.3 Motivation
- 17.4 Audience
- 17.5 Required
-
18. Constraints
- 18.1 Intent
- 18.2 Structure
- 18.3 Motivation
- 18.4 Audience
- 18.5 Required
-
19. Principles
- 19.1 Intent
- 19.2 Structure
- 19.3 Motivation
- 19.4 Audience
- 19.5 Required
-
20. Software Architecture
- 20.1 Intent
- 20.2 Structure
- 20.3 Motivation
- 20.4 Audience
- 20.5 Required
-
21. Code
- 21.1 Intent
- 21.2 Structure
- 21.3 Motivation
- 21.4 Audience
- 21.5 Required
-
22. Data
- 22.1 Intent
- 22.2 Structure
- 22.3 Motivation
- 22.4 Audience
- 22.5 Required
-
23. Infrastructure Architecture
- 23.1 Intent
- 23.2 Structure
- 23.3 Motivation
- 23.4 Audience
- 23.5 Required
-
24. Deployment
- 24.1 Intent
- 24.2 Structure
- 24.3 Motivation
- 24.4 Audience
- 24.5 Required
-
25. Operation and Support
- 25.1 Intent
- 25.2 Structure
- 25.3 Motivation
- 25.4 Audience
- 25.5 Required
-
26. Development Environment
- 26.1 Intent
- 26.2 Structure
- 26.3 Motivation
- 26.4 Audience
- 26.5 Required
-
27. Decision Log
- 27.1 Intent
- 27.2 Structure
- 27.3 Motivation
- 27.4 Audience
- 27.5 Required
-
14. Software documentation as a guidebook
-
III Tooling
-
28. Sketches, diagrams, models and tooling
- 28.1 Sketches
- 28.2 Diagrams
- 28.3 Models
- 28.4 Reverse-engineering the software architecture model
- 28.5 Architecture description languages
- 28.6 Structurizr
- 28.7 Minimise the model-code gap
-
29. The C4 model with other notations and tools
- 29.1 Boxes and lines
- 29.2 UML (with a modeling tool)
- 29.3 UML (with PlantUML)
-
30. Exploring your software architecture model
- 30.1 Static structure
- 30.2 Dependency maps
- 30.3 Component size or complexity
- 30.4 Other ways to explore
-
31. Appendix A: Financial Risk System
- 31.1 Background
- 31.2 Functional Requirements
- 31.3 Non-functional Requirements
-
28. Sketches, diagrams, models and tooling
- Notes
The Leanpub 60-day 100% Happiness Guarantee
Within 60 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,595,069writing, 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
C++20 - The Complete Guide
Nicolai M. JosuttisAll the new language and library features of C++20 (for those who know previous versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #2
Jetpack Compose internals
Jorge CastilloJetpack Compose is the future of Android UI. Master how it works internally and become a more efficient developer with it. You'll also find it valuable if you are not an Android dev. This book provides all the details to understand how the Compose compiler & runtime work, and how to create a client library using them.
- #3
SignalR on .NET 6 - the Complete Guide
Fiodar SazanavetsLearn everything there is to learn about SignalR and how to integrate it with the latest .NET 6 and C# 10 features. Learn how to connect any type of client to SignalR, including plain WebSocket client. Learn how to build interactive applications that can communicate with each other in real time without making excessive calls.
- #4
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
- #5
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #6
The easiest way to learn design patterns
Fiodar SazanavetsLearn design patterns in the easiest way possible. You will no longer have to brute-force your way through each one of them while trying to figure out how it works. The book provides a unique methodology that will make your understanding of design patterns stick. It can also be used as a reference book where you can find design patterns in seconds.
- #7
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.
- #8
CCIE Service Provider Version 4 Written and Lab Exam Comprehensive Guide
Nicholas RussoThe service provider landscape has changed rapidly over the past several years. Networking vendors are continuing to propose new standards, techniques, and procedures for overcoming new challenges while concurrently reducing costs and delivering new services. Cisco has recently updated the CCIE Service Provider track to reflect these changes; this book represents the author's personal journey in achieving that certification.
- #9
Cronache di Domain-Driven Design
Francesco Strazzullo, Matteo Baglini, Gianluca Padovani, Emanuele DelBono, Marco Consolaro, Alessandro Colla, Uberto Barbini, Alberto Acerbis, Julie Camosseto, DDD Open, and Alberto BrandoliniCronache di Domain-Driven Design: un libro corale in italiano fatto di storie indipendenti tra loro, che sono il risultato dell’applicazione di Domain-Driven Design su progetti reali.
- #10
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.
Top Bundles
- #1
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!? - #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... - #3
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #4
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... - #6
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
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...
