arc42 by Example

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

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.

About the Book

Free Chapter

Acknowledgements

I - Introduction

I.1 What is arc42?

I.2 Why This Book?

I.3 What This Book is Not

I.4 An Overview of Examples

I.5 A table of arc42 Topics

II - HTML Sanity Checking

II.1 Introduction and Goals

II.2 Constraints

II.3 Context

II.4 Solution Strategy

II.5 Building Block View

II.6 Runtime View

II.7 Deployment View

II.8 Crosscutting Concepts

II.9 Design Decisions

II.10 Quality Scenarios

II.11 Risks and Technical Debt

II.12 Glossary

III - Mass Market Customer Relationship Management

III.1 Introduction and Requirements

III.2 Constraints

III.3 Context

III.4 Solution Strategy

III.5 Building Blocks

III.6 Runtime View

III.7 Deployment View

III.8 Cross cutting Concepts

III.9 Architecture Decisions

III.10 Quality Scenarios

III.11 Risks

III.12 Glossary

IV - biking2

IV.1 Introduction and Requirements

IV.2 Architecture Constraints

IV.3 System Scope and Context

IV.4 Solution Strategy

IV.5 Building Blocks-Level 1

IV.6 Runtime View

IV.7 Deployment View

IV.8 Technical and Crosscutting Concepts

IV.9 Architecture Decisions

IV.10 Quality Scenarios

IV.11 Risks

IV.12 Glossary

V - DokChess

V.1 Introduction and Requirements

V.2 Constraints

V.3 Context

V.4 Solution Strategy

V.5 Building Block View

V.6 Runtime View

V.7 Deployment View

V.8 Technical and Cross cutting Concepts

V.9 Design Decisions

V.10 Quality Scenarios

V.11 Risks

V.12 Glossary

VI - docToolchain

VI.1 Introduction and Goals

VI.2 Architecture Constraints

VI.3 System Scope and Context

VI.4 Solution Strategy

VI.5 Building Block View

VI.6 Runtime View

VI.7 Deployment View

VI.8 Cross cutting Concepts

VI.9 Design Decisions

VI.10 Quality Requirements

VI.11 Risks and Technical Debts

VI.12 Glossary

VII - macOS Menu Bar Application

Customer Reviews

5 star

4 star

3 star

2 star

1 star

I - Introduction

This chapter explains the following topics:

What is arc42?
Why this book?
What this book is not!
An overview of examples
A table of arc42 sections

This book contains several examples of Software Architecture Documentation based upon the practical, economical, well-established, and systematic arc42 approach.

It shows how you can communicate about software architectures, but it does not show you how to develop or implement systems!

I.1 What is arc42?

arc42 is a template for architecture documentation.

It answers the following two questions in a pragmatic way, but can be tailored to your specific needs:

What should we document/communicate about our architecture?
How should we document/communicate it?

Figure 1.1 gives you the big picture: it shows a (slightly simplified) overview of the structure of arc42:

Figure 1.1: Structure of arc42

Compare arc42 to a cabinet...

arc42 by Example

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

arc42 by Example

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

Overview of this book

Related Content you might be interested in

Current Title:

arc42 by Example

I - Introduction

I.1 What is arc42?

Figure 1.1: Structure of arc42