첫 변경으로 검증하는 온보딩 문서, 먼저 지킬 계약을 적어 보기

설치 설명이 길어도 새 동료가 실제 변경을 실행하고 확인하지 못하면 개발 환경을 이해하기 어렵다. 작은 결과를 만드는 경로가 필요하다.

새로운 기능을 붙일 때 구현 방법부터 고르면 무엇을 확인해야 하는지 뒤늦게 고민하게 된다. 이번 기록에서는 입력과 결과 사이에 반드시 유지할 약속을 먼저 적고, 작은 예제로 그 약속을 확인한다. 복잡한 설계보다 같은 동작을 다시 설명할 수 있는 기준 하나가 출발점이다.

동작보다 먼저 정할 기준

저장소 준비부터 첫 테스트와 작은 수정까지 이어지는 안내를 만든다. 전제 조건, 정상 출력, 실패했을 때 확인할 위치를 함께 적는다.

이번에 확인할 질문: 입력과 실행 순서가 같을 때, 다른 동료도 같은 결과를 예상할 수 있는가?

작게 확인하는 예제

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

First change path
1. install the documented runtime
2. start isolated local dependencies
3. run one representative test
4. change a visible label or a small rule
5. verify and open a review

새 작업 환경에서 안내 순서를 그대로 따라가며 누락된 전제와 막힌 지점을 기록한다.

놓치기 쉬운 조건

관리자 권한이나 운영 자격 증명을 기본 전제로 삼지 않는다. 문서 작성자의 기존 캐시와 설정이 없어도 따라갈 수 있어야 한다.

확인할 부분	살펴볼 내용
기준 동작	새 작업 환경에서 안내 순서를 그대로 따라가며 누락된 전제와 막힌 지점을 기록한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 사용자에게 보이는 결과를 한 문장으로 적는다.
2. 정상 입력 하나와 경계 입력 하나를 같은 조건에서 비교한다.
3. 설명이 달라지는 부분을 코드나 문서의 명시적인 규칙으로 옮긴다.

처음 정한 계약은 영원한 정답이 아니다. 다만 바꾸려면 어떤 사용자가 영향을 받는지 함께 설명할 수 있어야 한다. 오늘의 기준을 짧게 남겨 두면 다음 변경에서 구현 취향과 제품의 약속을 구분하기 쉬워진다.