환경 설정의 이름과 예외를 문서화하기
설정 값이 어디에서 오는지 모르면 같은 코드를 실행해도 결과를 비교하기 어렵습니다. 이름과 목적, 필수 여부를 중심으로 정리합니다.
1
조건 살펴보기
설정 이름마다 사용 목적과 입력 형식을 적습니다.
2
직접 확인하기
값이 없을 때의 동작과 기본값을 확인합니다.
3
결과 정리하기
개발용 설정과 운영용 설정이 전달되는 경로를 구분합니다.
점검할 순서
- 설정 이름마다 사용 목적과 입력 형식을 적습니다.
- 값이 없을 때의 동작과 기본값을 확인합니다.
- 개발용 설정과 운영용 설정이 전달되는 경로를 구분합니다.
기록에 남길 내용
실제 암호나 접근 토큰 대신 안전한 설명용 값을 사용하고 저장소에 비밀 값이 들어가지 않게 합니다.