첫 변경으로 검증하는 온보딩 문서, 경계 조건에서 다시 살펴보기
설치 설명이 길어도 새 동료가 실제 변경을 실행하고 확인하지 못하면 개발 환경을 이해하기 어렵다. 작은 결과를 만드는 경로가 필요하다. 정상 경로 밖의 입력를 중심으로 작은 예제와 확인 기준을 정리합니다.
설치 설명이 길어도 새 동료가 실제 변경을 실행하고 확인하지 못하면 개발 환경을 이해하기 어렵다. 작은 결과를 만드는 경로가 필요하다.
대표 예제 하나가 통과해도 기능의 경계가 명확해진 것은 아니다. 값이 없거나 예상보다 많을 때, 실행이 늦어지거나 순서가 바뀔 때 다른 규칙이 숨어 있을 수 있다. 이번 기록에서는 정상 경로를 유지한 채 입력 범위를 넓혀 보고 무엇을 허용할지 구분한다.
정상 경로 밖의 입력
저장소 준비부터 첫 테스트와 작은 수정까지 이어지는 안내를 만든다. 전제 조건, 정상 출력, 실패했을 때 확인할 위치를 함께 적는다.
이번에 확인할 질문: 예상 범위를 벗어난 입력은 조용히 다른 결과를 만들지 않고 구분되는가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
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
새 작업 환경에서 안내 순서를 그대로 따라가며 누락된 전제와 막힌 지점을 기록한다.
놓치기 쉬운 조건
관리자 권한이나 운영 자격 증명을 기본 전제로 삼지 않는다. 문서 작성자의 기존 캐시와 설정이 없어도 따라갈 수 있어야 한다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 새 작업 환경에서 안내 순서를 그대로 따라가며 누락된 전제와 막힌 지점을 기록한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 빈 값과 최소 크기부터 확인 범위를 넓힌다.
- 한 번에 여러 경계를 섞지 않고 각각의 결과를 기록한다.
- 지원하지 않는 조건은 허용 범위와 함께 분명하게 설명한다.
모든 입력을 성공시켜야 좋은 인터페이스가 되는 것은 아니다. 지원 범위를 예측할 수 있고 실패 이유가 분명한 편이 더 다루기 쉽다. 경계 조건을 문서와 예제에 함께 남겨야 다음 구현에서도 같은 기준을 적용할 수 있다.
이 이야기가 도움이 되었나요?