錯誤訊息指導方針

錯誤訊息是顯示來描述發生導致使用者或系統無法完成工作的問題的文字。 問題可能會導致數據損毀或遺失。 其他訊息類型包括確認、警告和通知。 本主題中的指導方針旨在協助您撰寫容易當地語系化且適用於客戶的清楚錯誤訊息。

撰寫不佳的錯誤訊息可能是用戶沮喪的來源，而且可能會增加技術支援成本。 撰寫良好的錯誤訊息會向使用者提供下列資訊：

• 發生了什麼事，為什麼？
• 用戶的最終結果為何？
• 用戶可以做些什麼來防止它再次發生？

只要開發人員正確處理緩衝區大小，文字長度就不是問題。 用戶必須具備解決問題所需的所有資訊。 如果訊息有多個物件，您可能需要為系統管理員、使用者和開發人員提供個別的文字。

最佳做法

以下是改善錯誤訊息的方法：

• 避免錯誤狀況。 如果您可以預測使用者執行特定動作時會發生錯誤，請重寫您的程式代碼，讓使用者無法造成錯誤。
• 為每個已知錯誤原因撰寫個別的錯誤訊息。 請勿使用單一泛型訊息來說明錯誤的每個可能原因，除非您無法判斷錯誤發生的原因。
• 清楚說明問題，如果對用戶有説明，請解釋造成問題的原因。 盡可能將來自系統訊息數據表資源的泛型訊息取代為問題專屬的詳細訊息。
• 為使用者提供問題的解決方案。 如果解決方案有多個步驟，請參閱說明工作的詳細說明主題。
• 在訊息的標題欄中，只顯示產品、元件或精靈名稱。 這有助於用戶判斷問題所在位置。 請勿摘要標題欄中的問題，或包含「錯誤」這個字。
• 請勿使用技術術語，請使用您的物件所瞭解的術語。 請勿使用俚語或縮寫。
• 使用適當的命令按鈕，例如 [確定]、[取消]、[是]、[否] 和 [重試]。 您可以使用這些按鈕的組合。 [是] 和 [否] 按鈕必須一律搭配使用，而且必須一律在問題之前。
  • 若要停止作業並關閉消息框，請使用 [ 取消] 按鈕。
  • 若要關閉消息框，請使用 [ 關閉 ] 按鈕。
  • 若要提供錯誤原因的詳細資訊，請使用 [ 詳細 數據] 按鈕。
  • 若要提供問題解決方案的詳細資訊，請使用 [ 說明] 按鈕。
  • 如果訊息中包含使用者動作，請使用 [ 確定 ] 按鈕關閉消息框。
  • [是 ] 和 [否 ] 按鈕必須搭配使用，且必須一律在問題之前。
• 如果錯誤是重大錯誤，請將它 寫入事件記錄檔。

樣式考慮

• 使用完整但簡單的句子。
• 使用目前的時態來描述造成問題的情況或仍然存在的狀態。 您可以使用過去時態來描述過去發生的不同事件。
• 盡可能使用作用中的語音。 您可以使用被動語音來描述錯誤狀況。
• 避免大寫文字和驚嘆號。
• 即使問題是使用者錯誤的結果，請勿讓使用者感到有錯誤。
• 不要改變人種。 不要暗示程式或硬體可以思考或感覺。
• 請勿使用口語文字或片語。 請勿使用在特定文化特性中可能具有冒犯性的詞彙。
• 請勿在不加入前置詞或子詞的情況下復合數個名詞，以釐清意義。 例如，「站台伺服器LDAP服務目錄伺服器」應該變更為「站臺伺服器的LDAP服務目錄伺服器」。
• 在字詞前面插入描述元，以釐清句子的意義。 例如，「當 Detect 設定為 No 時指定 InfID」應該變更為 「當 Detect 選項設定為 No 時指定 InfID 參數」。
• 請避免「壞」這個字。 使用更具描述性的字詞來告知用戶發生錯誤。 例如，請避免訊息，例如「大小錯誤」。 相反地，告訴使用者指定大小時要使用的準則。
• 請避免 「please」 一詞。 可以解譯為表示必要動作是選擇性的。
• 將兩者都放在索引中且與訊息字串開頭的中央意義相關的單字。