Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

README.md

The Arc42 Template

arc42 is a template for architecture communication and documentation.
arc42 answers the following two questions in a pragmatic way, but can be tailored to your specific needs:
One. What should we document/communicate about our architecture?
Two. How should we document/communicate?

    1. Introduction and goals: Requirements, stakeholder, (top) quality goals
    1. Constraints: Technical and organizational constraints, conventions
    1. Context and scope: Business and technical context, external interfaces
    1. Solution strategy: Fundamental solution decisions and ideas
    1. Building block view: Abstractions of source code, black-/whiteboxes
    1. Runtime view: Runtime scenarios: How do building blocks interact
    1. Deployment view: Hardware and technical infrastructure, deployment
    1. Crosscutting concepts: Recurring solution approaches and patterns
    1. Architecture decisions: Important decisions
    1. Quality: Quality tree and quality scenarios
    1. Risks and technical debt: Known problems, risks and technical debt
    1. Glossary: Definitions of important business and technical terms

Takeaways

  • Use activity diagrams with swimlanes to describe or specify runtime scenarios Use activity diagrams with swimlanes to describe or specify runtime scenarios

  • [Describe the solution approaches as a table!] (https://docs.arc42.org/tips/4-2/)

    • quality goal: What’s the top-level goal?
    • scenario: What is a or the detailed scenario for this quality goal?
    • solution approach: How does the system approach this scenario? What tactics, approaches or decisions have been taken in this direction?
    • link to details: Where are the details of this solution described? This link will either point to a concrete building block, (implementing the approach) or a section of the crosscutting concepts.
  • Document the various environments Document the various environments

  • Use sequence diagrams to describe or specify runtime scenarios Use sequence diagrams to describe or specify runtime scenarios

  • collection from arc42 as checklist for concepts collection from arc42 as checklist for concepts

  • mind-map as quality tree mind-map as quality tree

  • Document and explain the specific quality tree Document and explain the specific quality tree

  • quality tree as checklist quality tree as checklist

  • Amend the glossary by a (graphical) model Amend the glossary by a (graphical) model

Resource