Work efficiently with Architecture Decision Records (ADRs)

Johannes Dienst - 5 years ago

Documentation is not one of the favorite tasks in the everyday software development. Either there is hardly any documentation or too much. This makes it difficult to find information. A lightweight approach is the arc42 template. It also documents design decisions that shape the software architecture. Undocumented design decisions can lead to incorrect follow-up decisions that can cause the project to fail. But how can many decisions be documented efficiently and comprehensibly? This presentation will introduce a compact format called Architecture Decision Records (ADR) and show how they can be used efficiently. In addition to small details such as title assignment, a proposed solution is shown for dealing with a large collection of design decisions (>50). The Docs As Code approach is used. Through tagging and an efficient search, the documentation becomes a daily work tool.

Newest jobs