추정에 범위와 불확실성 함께 남기기, 유지보수할 때 남겨 둘 예제

단일 날짜만 제시하면 조사 결과나 외부 의존성에 따른 변동이 보이지 않는다. 추정은 약속의 숫자보다 현재 알고 있는 조건을 설명해야 한다.

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

다시 읽을 수 있는 최소 맥락

작업을 관찰 가능한 단계로 나누고 낙관적인 경우와 불확실성이 드러나는 경우를 구분한다. 먼저 확인하면 범위를 줄일 수 있는 질문을 찾는다.

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

작게 확인하는 예제

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

Estimate notes
Known work: implementation and regression checks
Unknown: external API behavior for partial failures
Dependency: test account access
First checkpoint: reproduce the uncertain response
Update trigger: checkpoint result changes the scope

첫 확인 단계가 끝난 뒤 추정 범위가 좁아졌는지, 새 정보가 반영됐는지 확인한다.

놓치기 쉬운 조건

불확실성 범위를 무한히 넓혀 책임을 피하는 도구로 만들지 않는다. 가정이 바뀌었을 때 추정도 갱신하고 달라진 이유를 공유한다.

확인할 부분	살펴볼 내용
기준 동작	첫 확인 단계가 끝난 뒤 추정 범위가 좁아졌는지, 새 정보가 반영됐는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 구현 세부 사항보다 외부에서 관찰하는 결과를 적는다.
2. 예제가 의존하는 입력과 환경을 가까이에 둔다.
3. 설명이 실제 동작과 달라지면 코드와 예제를 같은 변경에서 고친다.

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