Architecture Decision Record

Active theme: Light

← 문서

좋은 ADR 작성을 위한 제안

좋은 ADR의 특징:

  • 근거: 해당 AD를 수행하는 이유를 설명합니다. 여기에는 맥락(아래 참조), 다양한 잠재적 선택지의 장단점, 기능 비교, 비용/편익 논의 등이 포함될 수 있습니다.

  • 구체성: 각 ADR은 여러 AD가 아니라 하나의 AD에 관한 것이어야 합니다.

  • 타임스탬프: ADR의 각 항목이 언제 작성되었는지 표시합니다. 이는 비용, 일정, 확장 등 시간이 지나면서 바뀔 수 있는 측면에서 특히 중요합니다.

  • 불변성: ADR의 기존 정보를 변경하지 마십시오. 대신 새 정보를 추가하여 ADR을 수정하거나, 새 ADR을 만들어 ADR을 대체하십시오.

ADR의 좋은 “맥락” 섹션의 특징:

  • 조직의 상황과 비즈니스 우선순위를 설명합니다.

  • 팀의 사회적 구성과 기술 구성에 기반한 근거와 고려 사항을 포함합니다.

  • 관련 있는 장단점을 포함하고, 필요와 목표에 부합하는 용어로 설명합니다.

ADR의 좋은 “결과” 섹션의 특징:

  • 결정을 내린 결과로 무엇이 뒤따르는지 설명합니다. 여기에는 영향, 성과, 산출물, 후속 조치 등이 포함될 수 있습니다.

  • 후속 ADR에 대한 정보를 포함합니다. 하나의 ADR이 더 많은 ADR의 필요성을 촉발하는 경우는 비교적 흔합니다. 예를 들어 한 ADR이 큰 포괄적 선택을 하면, 그것이 다시 더 작은 결정들의 필요를 낳는 경우입니다.

  • 사후 검토 프로세스를 포함합니다. 팀이 각 ADR을 한 달 뒤에 검토하여 ADR 정보를 실제로 일어난 일과 비교하고, 이를 통해 배우고 성장하는 것이 일반적입니다.

새 ADR이 이전 ADR을 대체할 수 있습니다:

  • 이전 ADR을 대체하거나 무효화하는 AD가 내려지면 새 ADR을 작성해야 합니다