Book Image

arc42 by Example

By : Dr. Gernot Starke, Michael Simons, Stefan Zörner, Ralf D. Müller
Book Image

arc42 by Example

By: Dr. Gernot Starke, Michael Simons, Stefan Zörner, Ralf D. Müller

Overview of this book

When developers document the architecture of their systems, they often invent their own specific ways of articulating structures, designs, concepts, and decisions. What they need is a template that enables simple and efficient software architecture documentation. arc42 by Example shows how it's done through several real-world examples. Each example in the book, whether it is a chess engine, a huge CRM system, or a cool web system, starts with a brief description of the problem domain and the quality requirements. Then, you'll discover the system context with all the external interfaces. You'll dive into an overview of the solution strategy to implement the building blocks and runtime scenarios. The later chapters also explain various cross-cutting concerns and how they affect other aspects of a program.
Table of Contents (9 chapters)
Free Chapter
1
Acknowledgements
8
VII - macOS Menu Bar Application

I.4 An Overview of Examples

We have encountered exciting software and system architectures during our professional lives. Several of those would have made instructive, interesting, and highly relevant examples – too bad they were declared confidential by their respective owners. Our nondisclosure agreements stated that we're not allowed to even mention clients' names without violating those contracts.

Therefore, it has been quite difficult to find practical examples that we can freely write and talk about.

Now, let's get an overview of the examples that are waiting in the rest of this book.

HTML Sanity Checking

The HTML Sanity Checker is a tiny open source system for checking HTML files for semantic errors such as broken cross-references, missing images, unused images, and similar stuff.

Dr. Gernot wrote the initial version of this system himself when working on a rather large (100+ pages) documentation based upon the AsciiDoctor (https://asciidoctor.org) markup language...