팀의 용어를 같은 의미로 사용하기, 작은 재현 예제로 좁혀 가기

같은 단어를 화면, API, 데이터베이스에서 다르게 쓰면 조건을 잘못 이해하기 쉽다. 특히 상태 이름은 사용자 행동과 연결되어야 한다.

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

변수를 줄이는 순서

자주 혼동되는 용어부터 정의와 반례를 적는다. 비슷한 단어를 무조건 합치기보다 실제 개념이 같은지 먼저 확인한다.

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

작게 확인하는 예제

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

Term: published post
Meaning: visible to ordinary readers
Not the same as: saved draft
Transition: publish action or scheduled publication
Used in: UI label, API field, operational query

같은 사례를 기획, 개발, 운영 담당자가 같은 상태 이름으로 설명하는지 확인한다.

놓치기 쉬운 조건

용어집을 코드와 무관한 문서로 두면 금방 낡는다. 이름을 바꿀 때 외부 계약과 기존 데이터의 호환성도 함께 확인한다.

확인할 부분	살펴볼 내용
기준 동작	같은 사례를 기획, 개발, 운영 담당자가 같은 상태 이름으로 설명하는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

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

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