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

VI.11 Risks and Technical Debts

This section describes the risks that might be posed by using docToolchain and how they are—from an architectural point of view—mitigated.

TR1: Outdated Technology

Description: A software system might live for several decades. During that time, some parts of the toolchain might get outdated. For instance, a UML modeler you didn't buy a new license for.

In such cases, you might not be able to regenerate parts of your documentation.

Mitigation: The biggest risk of this kind is related to the proprietary tools the diagrams and texts are exported from. docToolchain exports these artifacts, not to the /build folder, but to the /src/docs folder on purpose:

  • If one of the tools gets outdated, you still have the exported data, and therefore, you can still work with it.
  • In addition, exported .png images and plain text files are easier to compare than binary source formats, which come often. This enables you to better review the changes in your...