아키텍처 결정에 당시의 맥락 남기기, 먼저 지킬 계약을 적어 보기

결론만 남은 설계 문서는 시간이 지나면 왜 그런 선택을 했는지 설명하지 못한다. 제약이 달라졌을 때 바꿀 부분과 지킬 부분을 구분할 수 있어야 한다.

새로운 기능을 붙일 때 구현 방법부터 고르면 무엇을 확인해야 하는지 뒤늦게 고민하게 된다. 이번 기록에서는 입력과 결과 사이에 반드시 유지할 약속을 먼저 적고, 작은 예제로 그 약속을 확인한다. 복잡한 설계보다 같은 동작을 다시 설명할 수 있는 기준 하나가 출발점이다.

동작보다 먼저 정할 기준

짧은 결정 기록에 문제, 제약, 검토한 대안, 선택 이유와 감수한 비용을 적는다. 새 결정은 과거 기록을 지우기보다 어떤 조건이 달라졌는지 연결한다.

이번에 확인할 질문: 입력과 실행 순서가 같을 때, 다른 동료도 같은 결과를 예상할 수 있는가?

작게 확인하는 예제

다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.

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

다른 동료가 기록만 읽고 선택 이유와 재검토 조건을 설명할 수 있는지 확인한다.

놓치기 쉬운 조건

대안을 형식적으로 나열하고 이미 정한 결론을 정당화하면 기록의 가치가 줄어든다. 모든 사소한 구현 선택을 긴 문서로 만들 필요도 없다.

확인할 부분	살펴볼 내용
기준 동작	다른 동료가 기록만 읽고 선택 이유와 재검토 조건을 설명할 수 있는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 사용자에게 보이는 결과를 한 문장으로 적는다.
2. 정상 입력 하나와 경계 입력 하나를 같은 조건에서 비교한다.
3. 설명이 달라지는 부분을 코드나 문서의 명시적인 규칙으로 옮긴다.

처음 정한 계약은 영원한 정답이 아니다. 다만 바꾸려면 어떤 사용자가 영향을 받는지 함께 설명할 수 있어야 한다. 오늘의 기준을 짧게 남겨 두면 다음 변경에서 구현 취향과 제품의 약속을 구분하기 쉬워진다.