마이크로소프트
https://learn.microsoft.com/ko-kr/windows/win32/debug/error-message-guidelines
잘 작성된 오류메시지
- 발생한 문제와 이유
- 사용자가 얻은 최종 결과
- 문제가 다시 발생하지 않도록 사용자가 해야 할일
모범 사례
- 오류의 알려진 원인마다 별도의 오류 메시지를 작성
- 문제를 명확하게 명시하고 사용자에게 도움이 되는 경우 문제의 원인을 설명
- 사용자에게 문제에 대한 솔루션을 제공
- 메시지 제목 표시줄에 제품, 구성 요소 또는 마법사 이름만 표시합니다. 이렇게 하면 사용자가 문제가 있는 위치를 확인할 수 있습니다. 제목 표시줄에 문제를 요약하지 말고 "오류"라는 단어를 넣지 마세요.
- 기술 전문 용어를 사용하지 말고, 청중이 이해할 수 있는 용어를 사용합니다. 속어 또는 약어를 사용하지 마세요.
- 확인, 취소, 예, 아니요 및 다시 시도와 같은 적절한 명령 버튼을 사용합니다. 이러한 버튼을 조합하여 사용할 수 있습니다. 예 및 아니요 버튼은 항상 조합하여 사용해야 하며 질문 앞에 와야 합니다.
- 작업을 중지하고 메시지 상자를 닫으려면 취소 버튼을 사용합니다.
- 메시지 상자를 닫으려면 닫기 버튼을 사용합니다.
- 오류 원인에 대한 자세한 내용을 안내하려면 세부 정보 버튼을 사용합니다.
- 문제의 솔루션에 대한 자세한 내용을 안내하려면 도움말 버튼을 사용합니다.
- 메시지에 사용자 작업이 포함된 경우 확인 버튼을 사용하여 메시지 상자를 닫습니다.
- 예 및 아니요 버튼은 조합하여 사용해야 하며 항상 질문 앞에 와야 합니다.
스타일 고려 사항
- 완전하면서도 간단한 문장을 사용합니다.
- 현재 시제를 사용하여 문제를 일으킨 조건 또는 여전히 존재하는 상태를 설명합니다. 이전에 발생한 고유 이벤트를 설명할 때는 과거 시제를 사용할 수 있습니다.
- 가능하면 능동태를 사용합니다. 오류 조건을 설명할 때는 수동태를 사용할 수 있습니다.
- 대문자 텍스트 및 느낌표를 사용하지 않습니다.
- 사용자의 실수로 문제가 발생했더라도 사용자가 잘못했다고 느끼지 않도록 합니다.