사용 중단 안내에 이동 경로 포함하기, 작은 재현 예제로 좁혀 가기

오래된 기능을 곧 없앤다는 공지만으로는 사용자가 어떤 코드를 바꿔야 하는지 알기 어렵다. 사용 중단은 호환성 전환 과정으로 다뤄야 한다.

화면이나 실행 결과가 예상과 다를 때 전체 시스템을 한꺼번에 설명하려 하면 단서가 흐려진다. 관련 없는 의존성을 덜어 내고 조건을 하나씩 바꾸면 어느 가정이 깨졌는지 볼 수 있다. 이번에는 원인을 단정하기 전에 비교 가능한 최소 예제를 만드는 과정을 정리한다.

변수를 줄이는 순서

대체 경로, 행동 차이, 전환 예제, 지원 종료 조건을 명시한다. 실제 사용 여부를 확인하면서 전환 기간과 제거 시점을 결정한다.

이번에 확인할 질문: 한 가지 조건만 바꾸었을 때 관찰 결과도 함께 바뀌는가?

작게 확인하는 예제

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

Deprecation note
Old behavior:
Replacement:
Observable differences:
Migration example:
Compatibility period:
Removal condition:

대표 호출자를 새 경로로 옮겨 같은 기대 결과를 얻는지, 차이가 문서화됐는지 확인한다.

놓치기 쉬운 조건

대체 기능이 이름만 비슷하고 중요한 동작이 다르면 단순 치환 안내로 충분하지 않다. 사용량이 보이지 않는다고 사용자가 없다고 단정하지 않는다.

확인할 부분	살펴볼 내용
기준 동작	대표 호출자를 새 경로로 옮겨 같은 기대 결과를 얻는지, 차이가 문서화됐는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 문제가 드러나는 입력과 순서를 먼저 고정한다.
2. 의존성이나 옵션을 하나씩 제거하고 같은 결과가 남는지 확인한다.
3. 원인을 설명하는 가장 작은 차이를 회귀 확인 항목으로 남긴다.

재현 예제의 목적은 짧은 코드를 자랑하는 데 있지 않다. 설명에 필요한 조건을 남기는 것이 목적이다. 실제 경로로 돌아왔을 때도 같은 원인과 해결책이 성립하는지 마지막으로 확인해야 재현 과정이 유용한 기록이 된다.