설계 논의 녹음에서 아키텍처 결정 기록(ADR) 작성하기
ADR은 중요한 아키텍처 결정 한 건의 맥락, 대안, 선택, 영향과 상태를 기록합니다. 전사본으로 논의를 되짚고 기술적 정확성은 참여자가 확인합니다.
녹음한 논의로 Architecture Decision Record를 작성하는 법
ADR은 중요한 아키텍처 결정 한 건의 맥락, 대안, 선택, 영향과 상태를 기록합니다. 전사본으로 논의를 되짚고 기술적 정확성은 참여자가 확인합니다.
전사본은 실제 표현을 확인할 수 있게 해 줍니다. 맥락, 단서, 논의 순서가 남기 때문입니다. 최종 문구는 작성자가 정하고 참여자에게 확인을 요청해야 합니다.
단계별로 ADR을 작성하세요
결정 하나를 선택하세요
서로 독립적인 아키텍처 결정은 각각 따로 기록합니다.
맥락을 설명하세요
결정이 필요해진 요인과 제약을 적습니다.
대안을 비교하세요
각 대안의 주요 장점과 단점, 채택하지 않은 이유를 남깁니다.
영향을 적으세요
이점, 비용, 새 제약, 위험, 재검토 조건을 정리합니다.
교육용 예시: 오디오 파일 저장 방식 선택
아래는 가상의 교육용 예시입니다. 명칭, 조건, 결과는 방법을 설명하기 위한 것입니다.
“아카이브에는 객체 스토리지가 더 저렴하지만 임시 링크를 만드는 별도 장치가 필요합니다.”
맥락은 녹음 파일이 크고 접근 기간을 제한해야 하며 링크 발급을 관리해야 한다는 것입니다. 객체 스토리지를 선택합니다. 비용뿐 아니라 확장성과 접근 방식도 중요합니다.
필요한 작업과 위험을 영향에 포함하세요. 임시 링크, 유효 기간 관리, 로그 기록, 장애 테스트가 이에 해당합니다. 비용에 관한 전제가 달라지면 이력을 보존하면서 새 ADR로 대체할 수 있습니다.
| 항목 | 쓸 수 있는 기록 | 피할 예 |
|---|---|---|
| 맥락 | 큰 파일과 제한된 접근 | 새 스토리지가 필요함 |
| 대안 | 객체 스토리지 / 파일 스토리지 | 가장 좋은 것을 골랐음 |
| 결정 | A와 B 때문에 객체 스토리지를 선택 | 아키텍트가 결정함 |
| 영향 | 임시 링크와 모니터링 | 단점 없음 |
ADR 양식
양식을 복사해 특정 녹음을 바탕으로 채우세요. 추측은 가설로 표시합니다.
제목과 상태: 날짜와 참여자: 맥락과 제약: 검토한 대안: 결정과 이유: 영향, 위험, 재검토 조건:
보내기 전 확인할 네 가지
- 기록에 결정이 하나만 있습니다.
- 맥락에 실제 제약이 들어 있습니다.
- 대안과 채택하지 않은 이유가 남아 있습니다.
- 단점과 재검토 조건이 있습니다.
자세히 살펴보기
승인된 ADR을 편집해도 되나요?
오타는 고칠 수 있습니다. 결정이 바뀌면 새 ADR을 만들고 이전 기록을 연결하세요.
전사본을 ADR과 함께 보관해야 하나요?
대개 내부 출처 링크와 타임코드가 있으면 이견이 있는 표현을 확인할 수 있습니다.