실행할 수 있는 문서 예제 유지하기, 대안을 선택하는 기준 정리

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

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

장점과 비용을 함께 보기

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

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

작게 확인하는 예제

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

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. 조건이 바뀌면 결정을 다시 검토할 시점을 남긴다.

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