아키텍처 결정에 당시의 맥락 남기기, 유지보수할 때 남겨 둘 예제

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

시간이 지나면 왜 이렇게 구현했는지보다 어떻게 실행하는지만 남기기 쉽다. 옵션과 제약을 잊은 채 코드를 정리하면 의도했던 동작까지 바뀔 수 있다. 이번에는 작은 예제를 실행 가능한 설명으로 남기고, 구현이 달라져도 유지할 부분을 분리한다.

다시 읽을 수 있는 최소 맥락

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

이번에 확인할 질문: 내부 구조를 바꾸더라도 이 예제가 설명하는 결과는 그대로 유지되어야 하는가?

작게 확인하는 예제

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

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. 설명이 실제 동작과 달라지면 코드와 예제를 같은 변경에서 고친다.

오래 남는 문서는 가장 긴 문서가 아니라 다시 확인할 수 있는 문서다. 선택의 이유와 작동하는 예제가 함께 있으면 새로운 구현으로 옮길 때도 기준을 잃지 않는다. 중복 설명을 늘리기보다 정본이 어디인지 분명히 하는 편이 유지 비용을 줄인다.