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 book
- About the author
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.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. Other diagrams
- 10.1 Architectural view models
- 10.2 System Landscape
- 10.3 User interface mockups and wireframes
- 10.4 Business process and workflow
- 10.5 Domain model
- 10.6 Runtime and behaviour
- 10.7 Infrastructure
- 10.8 Deployment
- 10.9 And more
- 1. We have a failure to communicate
11. Software documentation as a guidebook
- 11.1 The code doesn’t tell the whole story
- 11.2 Our duty to deliver documentation
- 11.3 Lightweight, supplementary documentation
- 11.4 1. Maps
- 11.5 2. Sights
- 11.6 3. History and culture
- 11.7 4. Practical information
- 11.8 Describe what you can’t get from the code
- 11.9 Product vs project documentation
- 11.10 Keeping documentation up to date
- 11.11 Documentation length
- 12.1 Intent
- 12.2 Structure
- 12.3 Motivation
- 12.4 Audience
- 12.5 Required
13. Functional Overview
- 13.1 Intent
- 13.2 Structure
- 13.3 Motivation
- 13.4 Audience
- 13.5 Required
14. Quality Attributes
- 14.1 Intent
- 14.2 Structure
- 14.3 Motivation
- 14.4 Audience
- 14.5 Required
- 15.1 Intent
- 15.2 Structure
- 15.3 Motivation
- 15.4 Audience
- 15.5 Required
- 16.1 Intent
- 16.2 Structure
- 16.3 Motivation
- 16.4 Audience
- 16.5 Required
17. Software Architecture
- 17.1 Intent
- 17.2 Structure
- 17.3 Motivation
- 17.4 Audience
- 17.5 Required
- 18.1 Intent
- 18.2 Structure
- 18.3 Motivation
- 18.4 Audience
- 18.5 Required
- 19.1 Intent
- 19.2 Structure
- 19.3 Motivation
- 19.4 Audience
- 19.5 Required
20. Infrastructure Architecture
- 20.1 Intent
- 20.2 Structure
- 20.3 Motivation
- 20.4 Audience
- 20.5 Required
- 21.1 Intent
- 21.2 Structure
- 21.3 Motivation
- 21.4 Audience
- 21.5 Required
22. Operation and Support
- 22.1 Intent
- 22.2 Structure
- 22.3 Motivation
- 22.4 Audience
- 22.5 Required
23. Development Environment
- 23.1 Intent
- 23.2 Structure
- 23.3 Motivation
- 23.4 Audience
- 23.5 Required
24. Decision Log
- 24.1 Intent
- 24.2 Structure
- 24.3 Motivation
- 24.4 Audience
- 24.5 Required
- 11. Software documentation as a guidebook
25. Sketches, diagrams, models and tooling
- 25.1 Sketches
- 25.2 Diagrams
- 25.3 Models
- 25.4 Reverse-engineering the software architecture model
- 25.5 Architecture description languages
- 25.6 Structurizr
- 25.7 Minimise the model-code gap
26. The C4 model with other notations and tools
- 26.1 Boxes and lines
- 26.2 UML (with a modeling tool)
- 26.3 UML (with PlantUML)
27. Exploring your software architecture model
- 27.1 Static structure
- 27.2 Dependency maps
- 27.3 Component size or complexity
- 27.4 Other ways to explore
28. Appendix A: Financial Risk System
- 28.1 Background
- 28.2 Functional Requirements
- 28.3 Non-functional Requirements
- 25. Sketches, diagrams, models and tooling
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
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.
C++ Best PracticesJason Turner
Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Functional Design and ArchitectureAlexander Granin
Software Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
OpenIntro StatisticsDavid Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntro
A 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.
R Programming for Data ScienceRoger D. Peng
This 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.
C++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
I am a Software Engineer and I am in ChargeAlexis Monville and Michael Doyle
I am a Software Engineer and I am in Charge is a real-world, practical book that helps you increase your impact and satisfaction at work no matter who you work with.
In the book, we will follow Sandrine, a fictional character who learns to think in a new way enabling her to take a different course of action.
Invest In Digital Health - The Medical Futurist's GuideDr. Bertalan Mesko
Artificial Intelligence and Digital Health are booming. In this book, we explain why now it's a good time to invest in Digital Health and give recommendations on where to invest by looking at the top 24 technological trends we find the most promising.
Atomic KotlinBruce Eckel and Svetlana Isakova
For both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
The Hundred-Page Machine Learning BookAndriy Burkov
Everything you really need to know in Machine Learning in a hundred pages.
Mastering STM32Carmine Noviello
With more than 600 microcontrollers, STM32 is probably the most complete ARM Cortex-M platform on the market. This book aims to be the first guide around that introduces the reader to this exciting MCU portfolio from ST Microelectronics and its official CubeHAL.
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...
The Future of Digital Health
6 BooksWe 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 and how technology giants such as Amazon or Google want to conquer...
Cisco CCNA 200-301 Complet
4 BooksCe lot comprend les quatre volumes du guide préparation à l'examen de certification Cisco CCNA 200-301.
CCDE Practical Studies (All labs)
3 BooksCCDE lab
"The C++ Standard Library" and "Concurrency with Modern C++"
2 BooksGet my books "The C++ Standard Library" and "Concurrency with Modern C++" in a bundle. The first book gives you the details you should know about the C++ standard library; the second one dives deeper into concurrency with modern C++. In sum, you get more than 600 pages full of modern C++ and about 250 source files presenting the standard library...
Modern Management Made Easy
3 BooksRead all three Modern Management Made Easy books. Learn to manage yourself, lead and serve others, and lead the organization.
Programming with Ease
3 BooksAlle drei Bände der Serie Programming with Ease in einem Paket. Darin findest du alles, was ich dir zu den wichtigsten Phasen der Softwareentwicklung im Hinblick auf Clean Code Development für langfristig hohe Produktivität sagen kann.Im Band Slicing findest du die Anforderungsanalyse im Rahmen eines iterativ-inkrementellen Vorgehensmodells aus...
2 BooksUnveil the power of Ansible and Vagrant with this bundle at a special price. You'll have everything you need to get started with Vagrant - learn the basics and how to create your virtual development environments, using Ansible as provisioner! About Vagrant Cookbook Vagrant Cookbook is a complete guide to get started with Vagrant and create your...
2 BooksDocker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!
Growing Agile: The Complete Coach's Guide
7 BooksGrowing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity...