오류 메시지 텍스트 - 모범 사례

StackOverflow https://stackoverflow.com/questions/117083

문제

오래되고 잘못 작성된 오류 메시지의 일부 텍스트를 변경하고 있습니다.좋은 오류 메시지 작성에 대한 모범 사례에 대한 리소스는 무엇입니까(특히 Windows XP/Vista의 경우).

도움이 되었습니까?

해결책

오류 메시지 표현과 관련하여 다음 Windows 애플리케이션 스타일 가이드를 참조하는 것이 좋습니다.

다른 팁

궁극적인 모범 사례는 애초에 사용자가 오류를 일으키지 않도록 방지하는 것입니다.

사용자에게 관심 없는 내용은 알려주지 마세요.오류 코드 5064는 누구에게도 의미가 없습니다.그들이 뭔가 잘못했다고 말하지 마십시오.애초에 그것을 허용하지 마십시오.특히 소프트웨어가 저지른 실수에 대해 그들을 비난하지 마십시오.무엇보다 문제가 생겼을 때, 어떻게 고치는지 말해줘 그래서 그들은 계속해서 일을 끝낼 수 있습니다.

좋은 오류 메시지는 다음과 같아야 합니다.

  • 눈에 띄지 않게 하세요(블루 스크린이나 옐로우 스크린이 표시되지 않음)
  • 사용자에게 문제를 해결하도록 지시합니다(가능한 경우 직접 해결하거나 도움을 요청할 사람에게 문의).
  • 쓸데없고 난해한 프로그래머의 넌센스를 숨깁니다("라인 45에서 null 참조 예외가 발생했습니다"라고 말하지 마세요).
  • 장황하지 않고 설명적이어야 합니다.사용자에게 알아야 할 사항을 알려주는 데 필요한 정보만 있으면 됩니다.

제가 시작한 일 중 하나는 오류 메시지에 표시할 고유 번호를 생성하고 로그 파일에 기록하는 것입니다. 그러면 사용자가 나에게 스크린샷을 보내거나 전화를 걸어 "나는"이라고 말할 때 로그에서 오류를 찾을 수 있습니다. 오류가 발생했습니다.내 참조 번호는 0988-7634라고 나와 있어요."

보안상의 이유로 사용자에게 필요하지 않은 내부 시스템 정보는 제공하지 마세요.
간단한 예:로그인에 실패했을 때 사용자 이름이나 비밀번호가 틀렸다고 사용자에게 알리지 마십시오.이는 공격자가 시스템을 무차별 대입하는 데 도움이 될 뿐입니다.대신, "사용자 이름/비밀번호 조합이 잘못되었습니다"라고 말하세요.

항상 오류 해결을 위한 제안을 포함하십시오.

소프트웨어를 작성하여 문제를 해결하는 방법을 찾아보십시오.

사용자 입력(문자열, 파일 이름, 값 등)의 경우 항상 구분 기호(따옴표, 대괄호 등)와 함께 잘못된 값을 표시합니다.예를 들어

입력한 파일 이름을 찾을 수 없습니다:"어떤파일.txt"

이는 몰래 들어왔을 수 있는 공백/캐리지 리턴을 표시하는 데 도움이 되며 문제 해결 및 불만을 크게 줄여줍니다.

  1. 서로 다른 위치에서 동일한 오류 메시지가 발생하지 않도록 하세요.가능하다면 file:line으로 매개변수화하거나 개발자가 오류가 발생한 위치를 고유하게 식별할 수 있는 다른 컨텍스트를 사용하십시오.
  2. 특히 상용 제품인 경우 쉽게 현지화할 수 있도록 메커니즘을 설계하십시오.
  3. 오류 메시지가 사용자에게 표시되는 경우 코드에 대한 깊은 지식을 가정하지 않고 완전하고 의미 있는 문장으로 만드세요.당신은 항상 문제에 너무 가까이 있다는 것을 기억하세요. 사용자는 그렇지 않습니다.가능하다면 진행 방법, 연락 대상 등을 사용자에게 안내하세요.
  4. 가능하다면 모든 오류에는 메시지가 있어야 합니다.그렇지 않다면 모든 오류 해제 경로가 결국 무슨 일이 일어났는지 알려주는 오류 메시지에 도달하는지 확인하세요.

    여기에 다른 좋은 답변이 있을 것이라고 확신합니다...

실제로는 더 짧은 메시지를 읽을 수도 있습니다.

오류 메시지가 길어질수록 사용자는 읽게 되는 내용이 줄어듭니다.즉, 명확한 응답이 있는 경우 예외를 제거할 수 있도록 코드를 리팩터링해 보세요.사용자나 코드가 제어할 수 없는 상황에 따라 발생하는 예외만 발생시키도록 노력하세요.

가장 좋은 예외 메시지는 표시할 필요가 없는 메시지입니다.

오류 손질 항상 오류보다 낫습니다 보고, 그러나 오류 메시지를 개조하고 코드가 반드시 필요한 것은 아니므로 여기에 몇 가지 제안 사항이 있습니다.

사용자는 문제가 아닌 해결책을 원합니다."현재 창을 닫고 작업을 다시 시도하십시오."와 같은 간단한 메시지라도 오류 발생 후 무엇을 해야 하는지 알려주세요.

나는 또한 중앙 집중식 오류 기록을 좋아합니다.로그가 사람과 컴퓨터 모두에서 검색 가능한지 확인하세요.사용자는 자신이 겪고 있는 문제가 무엇인지 항상 알려주지는 않습니다. 특히 문제를 '해결'할 수 있는 경우에는 더욱 그렇습니다. 따라서 로그는 어떤 문제를 해결해야 하는지 파악하는 데 도움이 될 수 있습니다.

오류 대화 상자를 쉽게 제어할 수 있다면 오류 번호, 추적 등을 표시하는 '세부 정보' 버튼이 포함된 보기 좋고 읽기 쉬운 메시지를 표시하는 대화 상자가 있습니다.실시간 문제 해결에도 큰 도움이 될 수 있습니다.

다국어 지원은 모든 종류의 메시지에 적용되지만 오류 메시지의 경우 잊어버리는 경향이 있습니다.

나는 숫자 오류 코드와 같은 쓸모없고 난해한 정보를 사용자에게 말하지 않을 것입니다.그러나 기술적으로 더 정통한 사람들이 문제를 해결할 수 있도록 해당 정보를 확실히 기록하라고 말함으로써 이에 대한 후속 조치를 취하고 싶습니다.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top