아키텍처 결정에 당시의 맥락 남기기, 변경 전후를 비교하는 방법
결론만 남은 설계 문서는 시간이 지나면 왜 그런 선택을 했는지 설명하지 못한다. 제약이 달라졌을 때 바꿀 부분과 지킬 부분을 구분할 수 있어야 한다. 같은 조건에서 얻은 증거를 중심으로 작은 예제와 확인 기준을 정리합니다.
결론만 남은 설계 문서는 시간이 지나면 왜 그런 선택을 했는지 설명하지 못한다. 제약이 달라졌을 때 바꿀 부분과 지킬 부분을 구분할 수 있어야 한다.
개선한 코드가 더 좋아 보인다는 인상과 실제 동작의 개선은 구분해야 한다. 입력과 실행 조건이 다르면 차이의 원인을 알기 어렵다. 이번 기록에서는 비교 기준을 먼저 정하고, 바꾼 부분이 기대한 효과를 냈는지 확인하는 절차를 다룬다.
같은 조건에서 얻은 증거
짧은 결정 기록에 문제, 제약, 검토한 대안, 선택 이유와 감수한 비용을 적는다. 새 결정은 과거 기록을 지우기보다 어떤 조건이 달라졌는지 연결한다.
이번에 확인할 질문: 관찰한 차이를 이번 변경 때문이라고 설명할 만큼 비교 조건이 같은가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
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
다른 동료가 기록만 읽고 선택 이유와 재검토 조건을 설명할 수 있는지 확인한다.
놓치기 쉬운 조건
대안을 형식적으로 나열하고 이미 정한 결론을 정당화하면 기록의 가치가 줄어든다. 모든 사소한 구현 선택을 긴 문서로 만들 필요도 없다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 다른 동료가 기록만 읽고 선택 이유와 재검토 조건을 설명할 수 있는지 확인한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 바꾸기 전 결과를 보관하고 같은 입력을 다시 사용한다.
- 좋아진 부분뿐 아니라 유지되어야 할 동작도 함께 비교한다.
- 효과가 확인되지 않으면 추가 복잡도를 받아들일 이유를 다시 검토한다.
비교 결과는 특정 조건에서 얻은 증거다. 이를 모든 사용자와 모든 실행 환경으로 곧바로 확대하지 않는다. 입력의 크기와 조건을 함께 남겨야 다른 상황에서 다시 검증할 때도 출발점으로 사용할 수 있다.
이 이야기가 도움이 되었나요?