ユーザーの助けではなく、混乱を与える 
 
 TL;DR:曖昧なエラーメッセージを、ユーザーが問題を解決するのに役立つ具体的で操作可能なフィードバックに置き換える。 TL;DR:曖昧なエラーメッセージを、ユーザーが問題を解決するのに役立つ具体的で操作可能なフィードバックに置き換える。 問題解決 ↓↓ 
 
 
 
 
 
 
 
 
 
 
 ユーザーの混乱と挫折 施行可能なガイドラインなし 技術ジャーゴン 未解決の過ち かわいそうに 悪質なエラー回復 情報不完全エラー ユーザー信頼の低下 ジェネリックメッセージ 沈黙の失敗 関連コード 臭い https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xx-we-have-reached-100 https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxiv https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xv https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-vi-cmj31om https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxvii ステップ↓ 
 
 
 
 
 
 コードベースのすべての一般的なエラー メッセージを識別し、「Oops」、「Something went wrong」、「Error occurred」などの用語を使用します。 起こったことの具体的な記述で一般的なメッセージを置き換える ユーザーに問題を解決するためにできることを正確に伝える行動可能なガイドラインを追加します。 開発者向けの技術的な詳細をキャプチャするための適切な内部ログの実装 モニタリング警告を追加し、エラーが頻繁に発生した場合に開発チームに通知します。 サンプルコード 前の↓↓ function processPayment(paymentData) {
  try {
    // Too broad try catch  
    validatePayment(paymentData);
    chargeCard(paymentData);
    sendConfirmation(paymentData.email);
  } catch (error) {
    // Generic error message shown to user
    return {
      success: false,
      userMessage: "Oops! Something went wrong. Please try again.",
      error: error.message
    };
  }
}

function handleError(res, error) {
  // Exposing HTTP 500 to users
  res.status(500).json({
    message: "Internal Server Error",
    error: error.message
  });
}
 その後↓ function processPayment(paymentData) {
  try {
    validatePayment(paymentData);
    // This catch is specific to payment validation
  } catch (error) {
    // 1. Identify all generic error messages in your codebase
    // that use terms like "Oops", "Something went wrong", 
    // or "An error occurred"    
    // 2. Replace generic messages 
    // with specific descriptions of what happened
    // 3. Add actionable guidance telling users 
    // exactly what they can do to resolve the issue
    // 4. Implement proper internal logging 
    // to capture technical details for developers
    logger.error('Payment validation failed', {
      userId: paymentData.userId,
      error: error.message,
      stack: error.stack,
      timestamp: new Date().toISOString()
    });
    // 5. Add monitoring alerts to notify 
    // the development team when errors occur frequently    
    alerting.notifyError('PAYMENT_VALIDATION_FAILED', error);
    if (error.code === 'INVALID_CARD') {
      return {
        success: false,
        userMessage: "Your card information" + 
        " appears to be incorrect." +
        "Please check your card number," + 
        " expiry date, and security code."
      };
    }
    return {
      success: false,
      userMessage: "There was a problem validating" +
      " your payment." +
      "Please try again or contact support."
    };
  }

  // You should break this long method
  // Using extract method
  try {
    chargeCard(paymentData);
  } catch (error) {
    logger.error('Card charging failed', {
      userId: paymentData.userId,
      error: error.message,
      stack: error.stack,
      timestamp: new Date().toISOString()
    });
    alerting.notifyError('CARD_CHARGING_FAILED', error);
    if (error.code === 'INSUFFICIENT_FUNDS') {
      return {
        success: false,
        userMessage: "Your payment couldn't be processed"+
        " due to insufficient funds. " +
        "Please use a different payment method" + 
        " or contact your bank."
      };
    }
    if (error.code === 'CARD_EXPIRED') {
      return {
        success: false,
        userMessage: "Your card has expired. " +
        "Please update your payment method with a current card."
      };
    }
    return {
      success: false,
      userMessage: "There was a problem processing your payment." +
      " Please try again or contact support."
    };
  }

  try {
    sendConfirmation(paymentData.email);
  } catch (error) {
    logger.error('Confirmation sending failed', {
      userId: paymentData.userId,
      error: error.message,
      stack: error.stack,
      timestamp: new Date().toISOString()
    });
    alerting.notifyError('CONFIRMATION_FAILED', error);
    return {
      success: true,
      userMessage: "Payment processed successfully,"+
      " but we couldn't send the confirmation email." +
      " Please check your email address or contact support."
    };
  }

  return { success: true,
          userMessage: "Payment processed successfully." };
}
 タイプ↓ 
 
 (x) マニュアル セキュリティ ️ このリファクタリングは、動作を変更し、ログを保持し、デバッグのためのアラートをアクティブに保持する場合に安全です。 サポートチームに必要な詳細を削除しないでください。 変更を破るリスクは低いため、コアビジネスロジックを変更するのではなく、既存のエラー処理を改善しています。 なぜコードが良いのか? あなたはユーザーに混乱の代わりに有用なガイドラインを提供します。 あなたは、技術的なジャーガンを混乱させる代わりに、明確で操作可能なフィードバックを提供することで、より良いユーザーエクスペリエンスを作成します。 ユーザーは何が間違ったかを理解し、次のステップを知っています。 あなたは、技術的な詳細をログに保存し、ビジネスフレンドリーなメッセージをユーザーに表示することによって懸念を分離します。 サポートチームは、構造化されたログリングを通じて情報のデバッグを改善します。 ユーザーが報告する前に警告をモニタリングすることで、システムの問題を積極的に解決できます。 テクニカルな情報を彼らから遠ざけますが、問題の解決をより速くするためにそれらを記録します。 では、どのようにしてバリエーションを改善するのか?️ あなたは現実世界とあなたのモデルとの間でより近い一致を保ちます 曖昧な「Oops」メッセージの代わりに、あなたのシステムは、実際の出来事を反映する明確な用語で話します。 エラーメッセージ in the 何が間違ったのか、そしてそれを修正する方法についての具体的な情報が含まれています。 現実世界 クレジットカードが拒否されたとき、キャッシュヤーは「何かが間違った」とは言わない - 彼らはあなたに特定の問題を告げ、解決策を提案します。 This refactoring aligns the software model with ソフトウェアモデル エラー通信パターン、システムをより直感的でユーザーに役立つ バージョン ️制限 攻撃者を助ける可能性のある機密情報を暴露しないように注意する必要があります。 セキュリティ上の理由から一部のエラーが一般的である必要がある場合があります(認証の失敗など)。 さらに、特定のエラー メッセージを作成するには、より多くの開発時間を必要とし、エラー シナリオを徹底的にテストする必要があります。 Refactor with AI 
 
 「Oops」、「Something went wrong」または「Error occurred」などの用語を使用するコードベースのすべての一般的なエラーメッセージを識別する 2. 一般的なメッセージを具体的な記述で置き換える 3. エラーが頻繁に発生した場合に開発チームに通知するためのモニタリング警告を追加するために、開発者のための技術的な詳細をキャプチャするための適切な内部ログ化を実装する。 「Oops」、「Something went wrong」または「Error occurred」などの用語を使用するコードベースのすべての一般的なエラーメッセージを識別する 2. 一般的なメッセージを具体的な記述で置き換える 3. エラーが頻繁に発生した場合に開発チームに通知するためのモニタリング警告を追加するために、開発者のための技術的な詳細をキャプチャするための適切な内部ログ化を実装する。 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Without Proper Instructions 
 With Specific Instructions 
 
 
 
 ChatGPT 
 ChatGPT 
 
 
 
 Claude 
 Claude 
 
 
 
 Perplexity 
 Perplexity 
 
 
 
 Copilot 
 Copilot 
 
 
 
 You 
 You 
 
 
 
 Gemini 
 Gemini 
 
 
 
 DeepSeek 
 DeepSeek 
 
 
 
 Meta AI 
 Meta AI 
 
 
 
 Grok 
 Grok 
 
 
 
 Qwen 
 Qwen チャット チャット クラウド クラウド 戸惑い 戸惑い パイロット パイロット あなた あなた 双子 双子 ディープ検索 ディープ検索 ターゲット AI ターゲット AI グロック グロック QWEN QWEN タグ ️ 
 
 例外 レベル 
 
 (x) 中間 関連記事↓↓ https://hackernoon.com/refactoring-014-how-to-remove-if?embedable=true こちら↓↓↓ https://hackernoon.com/fail-fast-philosophy-explained-si963vk9?embedable=true https://www.morling.dev/blog/whats-in-a-good-error-message/?embedable=true https://ulrikapark.wordpress.com/2021/05/03/are-you-sure-people-get-happy-about-your-oops-error-messages-or-does-it-lower-their-trust-in-your-software/?embedable=true https://www.sonarsource.com/learn/error-handling-guide/?embedable=true クレジット↓ 画像 by は ライアン・マクギア ピクセイ この記事は、Refactoringシリーズの一部です。 https://maximilianocontieri.com/how-to-improve-your-code-with-easy-refactorings?embedable=true

The code in this story is for educational purposes. The readers are solely responsible for whatever they build with it.

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

2020 - Hacker Noon Contributor of the Year in REFACTORING

2022 - HackerNoon Contributor of the Year - Clean Code

2022 - HackerNoon Contributor of the Year - Debugging

2022 - HackerNoon Contributor of the Year - Github

2022 - HackerNoon Contributor of the Year - Machine Learning

2022 - HackerNoon Contributor of the Year - Quality Assurance

2022 - HackerNoon Contributor of the Year - Refactoring

2022 - HackerNoon Contributor of the Year - Software Architecture

2022 - the Greatest Storyteller

Buy My Book

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Software Engineer and Book Author

このオーディオは、ストーリーの元の言語で制作されています。

長すぎる; 読むには

031 - OOPの除去

031 - OOPの除去

About Author

コメント

ラベル

この記事は

Related Stories

フロキのヴァルハラがインドのスリランカツアーのアソシエイトスポンサーに加わる

ユニークなエコシステムを支えるビットコインUTXOのモデル

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

タップして稼ぐ：テレグラムはソラナより先に次の100億人の暗号通貨ユーザーを獲得する可能性がある

フロキのヴァルハラがインドのスリランカツアーのアソシエイトスポンサーに加わる

ユニークなエコシステムを支えるビットコインUTXOのモデル

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

タップして稼ぐ：テレグラムはソラナより先に次の100億人の暗号通貨ユーザーを獲得する可能性がある

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps