trubleshooting 가이드
- trubleshooting 가이드 : 발생할 수 있는 문제와 해결법을 정리한 가이드
- 반복적 문의 해결, 효율적 리소스 운영, 발생문제 해결책 접근용이, 빠르게 문제 해결 도움.
- 오류 코드 , 오류 메시지, 원인 및 증상, 해결책으로 구성
1) 오류 코드
- 오류 발생 상황을 3자리의 숫자코드로 정리
- 보통 HTTP 상태코드로 표시
- HTTP 의 첫번째 숫자는 응답 클래스를 의미.
HTTP 코드 분류 설명
2) 오류 메시지
- 문장 형식의 오류 설명
- 오류를 빠르게 이해. 쉽고 간결하게 기술(description)
- 읽는 이를 개발자를 비롯하여 사용자까지 서비스를 접할 수 있는 모든 사람 고려
- 오류 메시지를 그대로 인용하는 것 추천
3) 원인 및 증상
- 명확한 문제상황 안내.
- 개발 환경과 증상 정확히 문서화
4) 해결책
- 가장 중요한 항목
- 명확하게 제시하여 독자의 문제 해결을 도움
- 넘버링 및 실제 코드 제시, 관련 문서링크 제시 추천
참고
공부에는 끝이 없다