티스토리 뷰
GitHub - npryce/adr-tools: Command-line tools for working with Architecture Decision Records
Command-line tools for working with Architecture Decision Records - GitHub - npryce/adr-tools: Command-line tools for working with Architecture Decision Records
github.com
ADR (Architectural Decision Records)
아키텍처를 설계함에 있어서 이해관계자들끼리의 수많은 논의가 필요하다.
그리고, 이러한 논의를 통해 아키텍처가 결정되는데, 처음부터 전체가 결정되기는 어렵다.
따라서 부분부분 결정을 하게되는데, 이 결정들은 이후 다른 파트에 대한 설계를 진행하면서 이전 파트의 결정이 변경될 수 있다. 이러한 경우를 고려하면, 문서화 및 버전관리 등이 요구되는데 이러한 문서에 대한 표준 + 관리 측면을 도와주는 툴이 ADR Tool 이다.
필자도 회사에서 이러한 설계문서를 작성할 때 자체적인 템플릿을 만들어 작성했었는데, ADR이라는 툴을 이번에 처음 알게 되었다. 사용 방법은 CLI로 매우 간단하며, 이 툴을 사용하여 만든 문서들을 툴이 계속 트래킹하면서 관리가 되며, 여러가지 옵션을 통해서 설계 변경사항들에 대한 자동 코멘트(문서 라우팅 포함)까지 툴의 도움을 받아 쉽게 남길 수 있다. 추가로, 그래프화시켜 볼 수도 있어 전체적인 설계간 연관성과 흐름을 볼때도 도움이 된다.
글로벌하게 핫한 Spotify의 경우에도 기술블로그에 언제 ADR을 작성하는지에 대해 소개하고 있다.
When Should I Write an Architecture Decision Record
TL;DR Have you made a significant decision that impacts how engineers write software? Write an ADR! An Architecture Decision Record (ADR) is a document that captures a decision, including the context of how the decision was made and the consequences of ado
engineering.atspotify.com
사용법에 관련해서는 아래 링크가 잘 설명하고 있어, 링크로 대체하겠다.
Using Architectural Decision Records (ADR) with adr-tools
Introducing Architectural Decision Records Over the last week, I discovered a new tool for my arsenal called Architectural Decision Records (ADR). They were first written about in 2011, in a post c…
jon.sprig.gs
'CS > SW Architecture' 카테고리의 다른 글
| 마이크로커널 아키텍처 (microkernel / plug-in architecture) (1) | 2022.03.12 |
|---|---|
| 파이프라인 아키텍처 (Pipeline architecture) 스타일 (1) | 2022.03.08 |
| 레이어드 아키텍처 스타일 (Layered architecture, n-tiered architecture) (1) | 2022.03.07 |
| 분산 아키텍처 설계시 유의 사항: 전제 오류부터 잡자 (0) | 2022.03.04 |
| 아키텍처 특성? 나쁜 것 중에서 제일 나은 아키텍처를 선택하라 (1) | 2022.03.03 |