실행할 수 있는 문서 예제 유지하기, 변경 전후를 비교하는 방법

설명과 예제가 서로 어긋나면 처음 사용하는 사람이 어디를 믿어야 할지 알기 어렵다. 예제의 전제와 기대 결과를 함께 관리해야 한다.

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

같은 조건에서 얻은 증거

가장 작은 완결된 입력과 출력을 제공하고 준비 명령을 명시한다. 자동 검증이 가능한 예제는 검증 경로에 포함하고 버전 의존성이 있으면 표시한다.

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

작게 확인하는 예제

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

Example contract
Prerequisites: runtime and local test service
Input: one explicit request
Expected output: relevant fields and status
Cleanup: resources created by this example
Verification: command that checks the expectation

깨끗한 환경에서 예제를 그대로 실행해 설명한 출력과 일치하는지 확인한다.

놓치기 쉬운 조건

예제에 실제 비밀 값이나 개인 정보를 넣지 않는다. 중요한 줄을 생략했다면 생략 사실과 필요한 연결 부분을 분명히 적는다.

확인할 부분	살펴볼 내용
기준 동작	깨끗한 환경에서 예제를 그대로 실행해 설명한 출력과 일치하는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

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

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