완료 조건을 구현 전에 맞추기, 유지보수할 때 남겨 둘 예제

작업이 끝났다는 말이 코드 작성, 테스트 통과, 배포 완료 중 무엇을 뜻하는지 다르면 일정과 기대가 어긋난다. 관찰 가능한 완료 조건을 합의해야 한다.

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

다시 읽을 수 있는 최소 맥락

사용자 행동과 결과를 기준으로 조건을 적고 실패 경로, 운영 확인, 문서 필요 여부를 포함한다. 작업 규모에 맞게 목록을 작게 유지한다.

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

작게 확인하는 예제

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

Done when:
- the accepted input produces the agreed result
- invalid input receives a clear response
- the relevant regression check passes
- the deployed behavior is verified
- follow-up limitations are recorded

서로 다른 두 사람이 같은 결과를 보고 완료 여부를 일관되게 판단하는지 확인한다.

놓치기 쉬운 조건

모든 작업에 같은 긴 체크리스트를 붙이면 중요한 항목이 묻힌다. 완료 조건을 뒤늦게 추가해야 한다면 범위 변화와 이유를 명시한다.

확인할 부분	살펴볼 내용
기준 동작	서로 다른 두 사람이 같은 결과를 보고 완료 여부를 일관되게 판단하는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

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

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