arc42 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?
1. Introduction and Goals
Short description of the requirements, driving forces, extract (or abstract) of requirements. Top three (max five) quality goals for the architecture which have highest priority for the major stakeholders. A table of important stakeholders with their expectation regarding architecture.
Anything that constrains teams in design and implementation decisions or decision about related processes. Can sometimes go beyond individual systems and are valid for whole organizations and companies.
3. Context and Scope
Delimits your system from its (external) communication partners (neighboring systems and users). Specifies the external interfaces. Shown from a business/domain perspective (always) or a technical perspective (optional)
4. Solution Strategy
Summary of the fundamental decisions and solution strategies that shape the architecture. Can include technology, top-level decomposition, approaches to achieve top quality goals and relevant organizational decisions.
6. Runtime View
Behavior of building blocks as scenarios, covering important use cases or features, interactions at critical external interfaces, operation and administration plus error and exception behavior.
8. Crosscutting Concepts
Overall, principal regulations and solution approaches relevant in multiple parts (→ cross-cutting) of the system. Concepts are often related to multiple building blocks. Include different topics like domain models, architectur patterns and -styles, rules for using specific technology and inmplementation rules.
10. Quality Requirements
Quality requirements as scenarios, with quality tree to provide high-level overview. The most important quality goals should have been described in section 1.2. (quality goals).
Now that you know about the template sections, you can dive deeper. Have a look at our extensive documentation:
- Real-world examples
- FAQ - Frequently asked questions
- Our extensive template documentation, organized by template section.
- Our (sketchy) collection of software patterns.
arc42 offers architecture training and coaching.Two expert trainers at all times, highly practical and pragmatic, ideal preparation for iSAQB CPSA-Foundation certification.
Next available dates (in German):
IMPROVE Advanced ArchitectureiSAQB CPSA-Advanced Training, IMPROVE module: Learn to effectively evolve and maintain systems.
- July 10.-12. 2018, Vienna (Gernot Starke with Peter Hruschka)
- October 9.-11. 2018, Stuttgart (Gernot Starke with Peter Hruschka)
- November 27.-29. 2018, Hamburg (Gernot Starke with Carola Lilienthal)