오류 메시지 지침

오류 메시지는 사용자 또는 시스템이 작업을 완료하지 못하게 하는 발생한 문제를 설명하기 위해 표시되는 텍스트입니다. 이 문제로 인해 데이터가 손상되거나 손실될 수 있습니다. 다른 메시지 유형에는 확인, 경고 및 알림이 포함됩니다. 이 항목의 지침은 지역화하기 쉽고 고객에게 유용한 명확한 오류 메시지를 작성하는 데 도움이 됩니다.

잘못 작성된 오류 메시지는 사용자에게 불만의 원인일 수 있으며 기술 지원 비용을 증가시킬 수 있습니다. 잘 작성된 오류 메시지는 사용자에게 다음 정보를 제공합니다.

• 무슨 일이 있었는지 왜?
• 사용자의 최종 결과는 무엇인가요?
• 사용자가 다시 발생하지 않도록 하려면 어떻게 해야 할까요?

개발자가 버퍼 크기를 올바르게 처리하는 한 텍스트 길이는 문제가 되지 않습니다. 사용자에게 문제를 해결하는 데 필요한 모든 정보가 있어야 합니다. 메시지에 여러 청중이 있는 경우 관리자, 최종 사용자 및 개발자에게 별도의 텍스트를 제공해야 할 수 있습니다.

모범 사례

다음은 오류 메시지를 개선하는 방법입니다.

• 오류 조건을 방지합니다. 사용자가 특정 작업을 수행할 때 오류가 발생할 것이라고 예측할 수 있는 경우 사용자가 오류를 발생시킬 수 없도록 코드를 다시 작성합니다.
• 오류의 알려진 각 원인에 대해 별도의 오류 메시지를 작성합니다. 오류가 발생할 때 오류의 원인을 확인할 수 없는 한 오류의 가능한 모든 이유를 설명하기 위해 하나의 일반 메시지를 사용하지 마세요.
• 문제를 명확하게 명시하고 사용자에게 도움이 되는 경우 문제의 원인을 설명합니다. 가능하면 시스템 메시지 테이블 리소스의 일반 메시지를 문제와 관련된 자세한 메시지로 바꿉니다.
• 사용자에게 문제에 대한 솔루션을 제공합니다. 솔루션에 둘 이상의 단계가 있는 경우 도움말 항목을 참조하여 작업을 자세히 설명합니다.
• 메시지의 제목 표시줄에 제품, 구성 요소 또는 마법사 이름만 표시합니다. 이렇게 하면 사용자가 문제가 있는 위치를 확인할 수 있습니다. 제목 표시줄에 문제를 요약하거나 "error"라는 단어를 포함하지 마세요.
• 기술 전문 용어를 사용하지 마세요. 청중이 이해하는 용어를 사용하세요. 속어 또는 약어를 사용하지 마세요.
• 확인, 취소, 예, 아니요 및 다시 시도와 같은 적절한 명령 단추를 사용합니다. 이러한 단추의 조합을 사용할 수 있습니다. 예 및 아니요 단추는 항상 함께 사용해야 하며 항상 질문 앞에 와야 합니다.
  • 작업을 중지하고 메시지 상자를 닫려면 취소 단추를 사용합니다.
  • 메시지 상자를 닫려면 닫기 단추를 사용합니다.
  • 오류의 원인에 대한 자세한 내용을 제공하려면 세부 정보 단추를 사용합니다.
  • 문제에 대한 해결 방법에 대한 자세한 내용을 제공하려면 도움말 단추를 사용합니다.
  • 사용자 작업이 메시지에 포함된 경우 확인 단추를 사용하여 메시지 상자를 닫습니다.
  • 예 및 없음 단추를 함께 사용해야 하며 항상 질문 앞에 와야 합니다.
• 오류가 심각한 오류인 경우 이벤트 로그씁니다.

스타일 고려 사항

• 완전하지만 간단한 문장을 사용합니다.
• 현재 시제를 사용하여 문제를 발생시킨 조건 또는 여전히 존재하는 상태를 설명합니다. 과거 시제를 사용하여 과거에 발생한 고유한 이벤트를 설명할 수 있습니다.
• 가능하면 언제든지 활성 음성을 사용합니다. 수동 음성을 사용하여 오류 조건을 설명할 수 있습니다.
• 대문자 텍스트와 느낌표를 사용하지 않습니다.
• 문제가 사용자 오류의 결과인 경우에도 사용자가 잘못을 느끼지 않도록 합니다.
• 인트로포모핑하지 마십시오. 프로그램이나 하드웨어가 생각하거나 느낄 수 있음을 의미하지 마세요.
• 구문이나 구를 사용하지 마세요. 특정 문화권에서 불쾌할 수 있는 용어를 사용하지 마세요.
• 의미를 명확히 하기 위해 전치사나 하위 클래스를 추가하지 않고 여러 명사들을 복합화하지 마십시오. 예를 들어 "Site Server LDAP 서비스 디렉터리 서버"를 "사이트 서버의 LDAP 서비스에 대한 디렉터리 서버"로 변경해야 합니다.
• 문장의 의미를 명확히 하기 위해 용어 앞에 설명자를 삽입합니다. 예를 들어 "검색 시 InfID를 아니요로 설정"으로 변경해야 합니다. "검색 옵션이 아니요로 설정된 경우 InfID 매개 변수 지정"으로 변경해야 합니다.
• "bad"라는 단어를 사용하지 마십시오. 더 설명적인 용어를 사용하여 사용자에게 무엇이 잘못되었는지 알립니다. 예를 들어 "크기가 잘못되었습니다"와 같은 메시지를 사용하지 마십시오. 대신 크기를 지정할 때 사용할 조건을 사용자에게 알립니다.
• "please"라는 단어를 사용하지 마십시오. 필수 작업이 선택 사항임을 의미하는 것으로 해석될 수 있습니다.
• 인덱스 안에 있고 메시지 문자열의 시작 부분에 중앙 의미와 관련된 단어를 배치합니다.