사용 중단 안내에 이동 경로 포함하기, 변경 전후를 비교하는 방법

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

개선한 코드가 더 좋아 보인다는 인상과 실제 동작의 개선은 구분해야 한다. 입력과 실행 조건이 다르면 차이의 원인을 알기 어렵다. 이번 기록에서는 비교 기준을 먼저 정하고, 바꾼 부분이 기대한 효과를 냈는지 확인하는 절차를 다룬다.

같은 조건에서 얻은 증거

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

이번에 확인할 질문: 관찰한 차이를 이번 변경 때문이라고 설명할 만큼 비교 조건이 같은가?

작게 확인하는 예제

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

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

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

놓치기 쉬운 조건

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

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

다음 변경에 적용할 순서

1. 바꾸기 전 결과를 보관하고 같은 입력을 다시 사용한다.
2. 좋아진 부분뿐 아니라 유지되어야 할 동작도 함께 비교한다.
3. 효과가 확인되지 않으면 추가 복잡도를 받아들일 이유를 다시 검토한다.

비교 결과는 특정 조건에서 얻은 증거다. 이를 모든 사용자와 모든 실행 환경으로 곧바로 확대하지 않는다. 입력의 크기와 조건을 함께 남겨야 다른 상황에서 다시 검증할 때도 출발점으로 사용할 수 있다.