도우미 클래스를 빌드할 때 사용자가 인시던트 원인과 수행할 수 있는 가능한 복구 단계를 이해하는 데 도움이 되는 텍스트를 만들어야 합니다.
근본 원인 및 복구
인시던트가 발생하면 사용자에게 발생한 일을 알리는 대화 상자가 나타납니다. 만드는 텍스트는 두 개의 별도 영역에 표시됩니다.
- 근본 원인: 문제의 원인에 대한 간략한 설명입니다. 관리자 또는 고급 사용자가 문제를 해결하는 데 도움이 되는 정보를 포함합니다.
- 복구: 너무 길지 않고 사용자가 수행할 수 있는 단계에 대한 자세한 정보를 제공하기 위해 근본 원인을 확장합니다.
각 근본 원인 또는 복구에는 제목과 설명이 있어야 합니다. 첫 번째 "\n" 문자 앞의 모든 텍스트가 제목에 사용됩니다. 첫 번째 "\n" 문자 다음에 오는 모든 텍스트(후속 줄 바꿈 포함)가 설명에 사용됩니다.
제목 지침
근본 원인 또는 복구의 제목은 다음 지침을 따라야 합니다.
- 128자 이하여야 합니다. (40자 이하를 사용하는 것이 좋습니다.)
- 마침표로 끝나서는 안 됩니다.
설명 지침
근본 원인 또는 복구에 대한 설명은 다음 지침을 따라야 합니다.
- 512자 이하여야 합니다.
- 각 문장은 마침표로 끝나야 합니다.
- "\n" 문자는 설명에서 줄 바꿈을 만드는 데 사용할 수 있습니다.