사용 중단 안내에 이동 경로 포함하기, 대안을 선택하는 기준 정리

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

문제를 푸는 방법이 둘 이상이면 기능의 개수만 비교하기 쉽다. 하지만 운영 중 설명할 수 있는지, 실패했을 때 되돌릴 수 있는지, 다음 동료가 고칠 수 있는지도 선택의 일부다. 이번에는 현재 조건에서 필요한 성질과 감수할 비용을 나누어 적는다.

장점과 비용을 함께 보기

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

이번에 확인할 질문: 선택한 방법의 장점이 지금의 제약과 실제로 연결되어 있는가?

작게 확인하는 예제

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

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

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

놓치기 쉬운 조건

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

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

다음 변경에 적용할 순서

1. 필수 조건과 있으면 좋은 조건을 분리한다.
2. 선택하지 않은 대안이 유리해지는 상황도 한 가지 적는다.
3. 조건이 바뀌면 결정을 다시 검토할 시점을 남긴다.

다른 방법을 배제한 이유가 기록되어 있으면 같은 논의를 처음부터 반복하지 않아도 된다. 선택은 환경에 따라 달라질 수 있다. 무엇을 포기했는지 설명하는 문장이 구현을 이해하는 데 오히려 더 직접적인 도움이 될 때가 많다.