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

II.1 Introduction and Goals

This section will explain the driving forces for architecturally relevant decisions and important use cases or features, all of which will be summarized in a few sentences. If possible, refer to the existing requirements documentation.

The main goal of this section is to ensure that your stakeholders understand the solution at hand.

HtmlSanityCheck (HtmlSC) supports authors creating digital formats by checking hyperlinks, images, and similar resources.

1.1 Requirements Overview

Note

If you would like to have a brief explanation of the important goals and requirements, use cases, and features of the system, please refer to the existing requirements documentation.

It's important that you understand the central tasks of the system before you take a look at the architecture of the system (starting with arc42-section 3).

The overall goal of HtmlSC is to create neat and clear reports that show errors within HTML files. The following is a sample report:

Figure...