아키텍처 결정에 당시의 맥락 남기기, 리뷰에서 함께 확인할 질문
결론만 남은 설계 문서는 시간이 지나면 왜 그런 선택을 했는지 설명하지 못한다. 제약이 달라졌을 때 바꿀 부분과 지킬 부분을 구분할 수 있어야 한다. 코드 밖의 맥락 전달하기를 중심으로 작은 예제와 확인 기준을 정리합니다.
결론만 남은 설계 문서는 시간이 지나면 왜 그런 선택을 했는지 설명하지 못한다. 제약이 달라졌을 때 바꿀 부분과 지킬 부분을 구분할 수 있어야 한다.
작성자에게 당연한 전제도 리뷰어에게는 보이지 않을 수 있다. 파일의 차이만 보여 주면 변경 이유와 확인 범위를 추측하게 된다. 이번 기록에서는 결과를 판단하는 데 필요한 맥락을 짧게 전달하고, 질문이 실제 개선으로 이어지도록 확인 순서를 정리한다.
코드 밖의 맥락 전달하기
짧은 결정 기록에 문제, 제약, 검토한 대안, 선택 이유와 감수한 비용을 적는다. 새 결정은 과거 기록을 지우기보다 어떤 조건이 달라졌는지 연결한다.
이번에 확인할 질문: 리뷰어가 변경 이유와 남아 있는 제약을 코드만 추측하지 않고 이해할 수 있는가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
Decision: how to store an uploaded file
Context: expected size, access pattern, retention
Options: application disk / shared storage / object storage
Choice: selected option and reason
Consequences: operating cost and recovery requirements
Revisit when: explicit change in assumptions
다른 동료가 기록만 읽고 선택 이유와 재검토 조건을 설명할 수 있는지 확인한다.
놓치기 쉬운 조건
대안을 형식적으로 나열하고 이미 정한 결론을 정당화하면 기록의 가치가 줄어든다. 모든 사소한 구현 선택을 긴 문서로 만들 필요도 없다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 다른 동료가 기록만 읽고 선택 이유와 재검토 조건을 설명할 수 있는지 확인한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 이번 변경이 해결하는 구체적인 상황을 먼저 설명한다.
- 재현 예제와 확인한 결과를 한곳에서 볼 수 있게 남긴다.
- 취향에 대한 제안과 지켜야 할 계약의 위반을 구분한다.
리뷰는 작성자의 지식을 시험하는 자리가 아니라 변경을 함께 책임지는 과정이다. 답변이 반복되는 질문은 설명이 부족한 신호일 수 있다. 대화가 끝난 뒤 가장 중요한 전제를 코드 가까이 남기면 다음 리뷰의 질문도 더 구체적이 된다.
이 이야기가 도움이 되었나요?