리뷰 의견의 강도를 분명히 표현하기, 대안을 선택하는 기준 정리
수정이 필수인 결함과 개인적인 취향이 같은 어조로 전달되면 작성자가 우선순위를 판단하기 어렵다. 의견의 이유와 강도를 함께 적어야 한다. 장점과 비용을 함께 보기를 중심으로 작은 예제와 확인 기준을 정리합니다.
수정이 필수인 결함과 개인적인 취향이 같은 어조로 전달되면 작성자가 우선순위를 판단하기 어렵다. 의견의 이유와 강도를 함께 적어야 한다.
문제를 푸는 방법이 둘 이상이면 기능의 개수만 비교하기 쉽다. 하지만 운영 중 설명할 수 있는지, 실패했을 때 되돌릴 수 있는지, 다음 동료가 고칠 수 있는지도 선택의 일부다. 이번에는 현재 조건에서 필요한 성질과 감수할 비용을 나누어 적는다.
장점과 비용을 함께 보기
정확성 문제, 유지보수 제안, 확인 질문, 선택적 취향을 구분한다. 필수 변경에는 실패 조건이나 계약을 근거로 제시하고 대안을 열어 둔다.
이번에 확인할 질문: 선택한 방법의 장점이 지금의 제약과 실제로 연결되어 있는가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
Required: this path can commit only half of the operation.
Question: should an empty value be accepted here?
Suggestion: naming the intermediate result may clarify the rule.
Optional: the current ordering is also acceptable.
작성자가 어떤 의견을 반드시 해결해야 하는지와 그 이유를 리뷰 기록에서 바로 찾을 수 있는지 확인한다.
놓치기 쉬운 조건
라벨을 붙였다고 공격적인 표현이나 근거 없는 단정이 해결되지는 않는다. 코드의 효과를 논의하고 작성자의 능력이나 의도를 추측하지 않는다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 작성자가 어떤 의견을 반드시 해결해야 하는지와 그 이유를 리뷰 기록에서 바로 찾을 수 있는지 확인한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 필수 조건과 있으면 좋은 조건을 분리한다.
- 선택하지 않은 대안이 유리해지는 상황도 한 가지 적는다.
- 조건이 바뀌면 결정을 다시 검토할 시점을 남긴다.
다른 방법을 배제한 이유가 기록되어 있으면 같은 논의를 처음부터 반복하지 않아도 된다. 선택은 환경에 따라 달라질 수 있다. 무엇을 포기했는지 설명하는 문장이 구현을 이해하는 데 오히려 더 직접적인 도움이 될 때가 많다.
이 이야기가 도움이 되었나요?