Leanpub Header

Skip to main content
Go to Leanpub.comLeanpub

arc42 by Example

Software Architecture Documentation in Practice

Gernot Starke, Michael Simons, Stefan Zörner, Ralf D. Müller, and Hendrik Lösch

Real software architectures, documented with the arc42 template. Helps you jumpstart your own documentation.

The authors are letting you choose the price you pay for this book!

Pick Your Price...
PDF
EPUB
WEB
3,708
Readers
344
Pages
About

About

About the Book

This book contains several real-world software architectures, documented with the practical arc42 template.

You will learn about the inner workings of a chess engine, a huge CRM system, a cool web system to track biking activities and an extremely small menu-bar application.

Each of the examples starts with a brief description of the problem domain, including the quality requirements, before we explain the system context with all the external interfaces. Then we dive into an overview of the solution strategy to prepare you for the implementation building blocks and runtime scenarios (as major architectural views).

Later on we explain the crosscutting concepts of every architecture and its implementation.

You will learn that documentation can be compact, helpful and easy-to-read.

Status Decemter 2022: We just started editing a new and enhanced edition of the book. Ever reader will get this new version (our third edition) as a free update, of course!

Share this book

Categories

Software ArchitectureSoftware Engineering

Feedback

Email the authors

Price

Pick Your Price...

Minimum price

$16.99

$21.42

You pay

$21.42

Authors earn

$17.13
$

All prices are in US $. You can pay in US $ or in your local currency when you check out.

EU customers: prices exclude VAT, which is added during checkout.

...Or Buy With Credits!

Number of credits (Minimum 2)

2
The author will earn $24.00 from your purchase!
You can get credits monthly with a Reader Membership

Author

About the Authors

Gernot Starke

Dr. Gernot Starke (INNOQ Fellow) is co-founder and longstanding user of the (open source) arc42 documentation template. For more than 20 years, he has been working as software-architect, coach and consultant, conquering the challenges of creating effective software architectures for clients from various industries.

Gernot co-founded the International Software Architecture Qualification Board (iSAQB e.V.) and the (open source) Architecture Improvement Method (https://aim42.org).

Gernot has authored several (German) books on software architecture and related topics.

Michael Simons

Michael Simons is a father of two, husband, geek, programmer and passionate cyclist. He works as a Senior Software engineer for Neo4j. In a previous life he worked at ENERKO INFORMATIK, an Aachen based company dealing with GIS system and has a background focussed on geographic information systems for utilities and price calculation at the energy market. In his brief time at INNOQ he helped customers modernize their application systems. Michael is known for having a certain passion for SQL and Spring.

Michael took his apprenticeship at the FZ Jülich and studies at FH Aachen: Campus Jülich. He is a PRINCE2 ® Registered Practitioner and sometimes torn between the roles of an architect and project manager.

Michael is a dedicated blogger and engaged in various open source projects, you'll find his stuff at michael-simons.eu.

Stefan Zörner

From the Bayer AG via IBM and oose to embarc. Stefan Zörner has twenty years of experience in IT and still looks forward to the future with excitement. He supports clients in solving architecture and implementation problems. In interesting workshops he demonstrates how to use practical design tools as well as spreading enthusiasm for real life architectural work.

Ralf D. Müller

Ralf D. Müller is an international conference speaker, solutions architect, a ambitious Groovy developer and father. He is continually trying to simplify his work. Currently, his main concern is improving the holistic documentation of projects. He achieves this especially with the help of the arc42 template and docs-as-code approach.

He is the founder of the docToolchain open source project.

More infos about his work can be found at docs-as-co.de and on speakerdeck.

Hendrik Lösch

Hendrik Lösch is a consultant and architect at ZEISS Digital Innovation. The focus of his work is on the development and evaluation of software, based on Microsoft technologies. He also enjoys writing and talking about his work as well as his enthusiasm for clean code, software evolution and test automation in its various forms.

Contents

Table of Contents

Preface

  1. Acknowledgements
  2. Conventions
  3. Disclaimer

I - Introduction

  1. I.1 What is arc42?
  2. I.2 Why this Book?
  3. I.3 What this Book is Not
  4. I.4 Overview of the Examples
  5. I.5 Table of arc42 Topics

II. HTML Sanity Checking

  1. II.1. Introduction and Goals
  2. II.2 Constraints
  3. II.3 System Scope and Context
  4. II.4 Solution Strategy
  5. II.5 Building Block View
  6. II.6 Runtime View
  7. II.7 Deployment view
  8. II.8 Cross-cutting Concepts
  9. II.9 Architecture Decisions
  10. II.10 Quality Requirements
  11. II.11 Risks and Technical Debt
  12. II.12 Glossary

III - Mass Market Customer Relationship Management

  1. III.1 Introduction and Goals
  2. III.2 Constraints
  3. III.3 System Scope and Context
  4. III.4 Solution Strategy
  5. III.5 Building Block View
  6. III.6 Runtime View
  7. III.7 Deployment View
  8. III.8 Cross-Cutting Concepts
  9. III.9 Architecture Decisions
  10. III.10 Quality Requirements
  11. III.11 Risks
  12. III.12 Glossary

IV - biking2

  1. IV.1 Introduction and Goals
  2. IV.2 Constraints
  3. IV.3 System Scope and Context
  4. IV.4 Solution Strategy
  5. IV.5 Building Block View
  6. IV.6 Runtime View
  7. IV.7 Deployment View
  8. IV.8 Cross-cutting Concepts
  9. IV.9 Architecture Decisions
  10. IV.10 Quality Requirements
  11. IV.11 Risks and Technical Debt
  12. IV.12 Glossary

V - DokChess

  1. V.1 Introduction and Goals
  2. V.2 Constraints
  3. V.3 System Scope and Context
  4. V.4 Solution Strategy
  5. V.5 Building Block View
  6. V.6 Runtime View
  7. V.7 Deployment View
  8. V.8 Cross-cutting Concepts
  9. V.9 Architecture Decisions
  10. V.10 Quality Requirements
  11. V.11 Risks and Technical Debts
  12. V.12 Glossary

VI - docToolchain

  1. VI.1 Introduction and Goals
  2. VI.2 Constraints
  3. VI.3 System Scope and Context
  4. VI.4 Solution Strategy
  5. VI.5 Building Block View
  6. VI.6 Runtime View
  7. VI.7 Deployment View
  8. VI.8 Cross-cutting Concepts
  9. VI.9 Architecture Decisions
  10. VI.10 Quality Requirements
  11. VI.11 Risks and Technical Debt
  12. VI.12 Glossary

VII - Foto Max

  1. VII.1 About this document
  2. VII.2 Introduction and Goals
  3. VII.3 Quality Requirements
  4. VII.4 Constraints
  5. VII.5 System Scope and Context
  6. VII.6 Solution Strategy
  7. VII.7 Building Block View
  8. VII.8 Runtime View
  9. VII.9 Deployment View
  10. VII.10 Cross-cutting Concepts
  11. VII.11 Architecture Decisions
  12. VII.12 Risks & Technical Debt
  13. VII.13 Glossary
  14. VII.14 Organizational Topics

VIII - Mac-OS Menubar Application

The Authors

  1. Gernot Starke
  2. Hendrik Lösch
  3. Michael Simons
  4. Stefan Zörner
  5. Ralf D. Müller
  6. Contacting the Authors

Further Reading

Contributor

About the Contributors

Peter Hruschka

Get the free sample chapters

Click the buttons to get the free sample in PDF or EPUB, or read the sample online here

Download Sample PDFDownload Sample EPUBRead Sample OnlineRead online

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.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

Earn $8 on a $10 Purchase, and $16 on a $20 Purchase

We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earned over $14 million writing, publishing and selling on Leanpub.

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) and EPUB (for phones, tablets and 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

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub