Ge användarna hjälp, inte förvirring 
 
 TL;DR: Ersätt vaga felmeddelanden med specifik, handlingsbar feedback som hjälper användare att lösa problem. TL;DR: Ersätt vaga felmeddelanden med specifik, handlingsbar feedback som hjälper användare att lösa problem. Problem som åtgärdats 
 
 
 
 
 
 
 
 
 
 
 Användarförvirring och frustration Ingen handlingsbar vägledning tillhandahålls Teknisk jargong Obehandlade dåliga misstag Dålig UX Dålig felåterhämtning Ofullständig felinformation Lägre användarförtroende Generiska meddelanden Tyst misslyckande Relaterad kod Luktar 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 Steg 
 
 
 
 
 
 Identifiera alla generiska felmeddelanden i din kodbas som använder termer som "Oops", "Något gick fel" eller "Ett fel inträffade" Ersätt generiska meddelanden med specifika beskrivningar av vad som hände Lägg till handlingsbar vägledning som berättar för användarna exakt vad de kan göra för att lösa problemet Implementera korrekt intern loggning för att fånga tekniska detaljer för utvecklare Lägg till övervakningsvarningar för att meddela utvecklingsteamet när fel uppstår ofta Sample kod Före 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
  });
}
 Efter 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." };
}
 Typ 
 
 [x] Handbok Säkerhet ️ Denna refactoring ändrar beteendet och är säker om du håller loggning och varningar aktiva för debugging. Undvik att ta bort detaljer som behövs av supportteam. Risken för att bryta förändringar är låg eftersom du förbättrar befintlig felhantering snarare än att ändra kärnverksamhetslogik. Varför är koden bättre? Du ger användarna användbar vägledning istället för förvirring. Du skapar en bättre användarupplevelse genom att ge tydlig, handlingsbar feedback istället för förvirrande teknisk jargon. Användarna förstår vad som gick fel och vet sina nästa steg. Du separerar bekymmer genom att hålla tekniska detaljer i loggar samtidigt som du visar affärsvänliga meddelanden till användare. Ditt supportteam får bättre debugging information genom strukturerad loggning. Du kan proaktivt ta itu med systemproblem genom att övervaka varningar innan användarna rapporterar dem. Du håller teknisk information borta från dem, men registrerar fortfarande den för snabbare problemlösning. Hur kan jag förbättra min hälsa? ️ Du håller en närmare matchning mellan den verkliga världen och din modell. Istället för vaga "Oops" -meddelanden talar ditt system i tydliga termer som återspeglar faktiska händelser. Felmeddelanden i den Innehåller specifik information om vad som gick fel och hur man fixar det. Den verkliga världen En kassör säger inte "Oops, något gick fel" när ditt kort nekas - de berättar det specifika problemet och föreslår lösningar. Denna refactoring anpassar mjukvarumodellen med felkommunikationsmönster, vilket gör systemet mer intuitivt och användbart för användarna Bijection Begränsningar ️ Du måste vara försiktig med att inte avslöja känslig systeminformation som kan hjälpa angripare. Vissa fel kan behöva förbli generiska av säkerhetsskäl (till exempel autentiseringsfel). Dessutom kräver skapandet av specifika felmeddelanden mer utvecklingstid och noggrann testning av felscenarier. Refactor med AI 
 
 Föreslagna meddelanden: 1. identifiera alla generiska felmeddelanden i din kodbas som använder termer som "Oops", "Något gick fel" eller "Ett fel inträffade" 2. ersätta generiska meddelanden med specifika beskrivningar av vad som hände 3. Lägg till handlingsbar vägledning som berättar användarna exakt vad de kan göra för att lösa problemet 4. Implementera korrekt intern loggning för att fånga tekniska detaljer för utvecklare 5. Lägg till övervakningsvarningar för att meddela utvecklingsteamet när fel inträffar ofta Föreslagna meddelanden: 1. identifiera alla generiska felmeddelanden i din kodbas som använder termer som "Oops", "Något gick fel" eller "Ett fel inträffade" 2. ersätta generiska meddelanden med specifika beskrivningar av vad som hände 3. Lägg till handlingsbar vägledning som berättar användarna exakt vad de kan göra för att lösa problemet 4. Implementera korrekt intern loggning för att fånga tekniska detaljer för utvecklare 5. Lägg till övervakningsvarningar för att meddela utvecklingsteamet när fel inträffar ofta 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 Chattar Chattar Claude är Claude är förvirring förvirring Barnpilot Barnpilot du du Tvillingar Tvillingar djupt sökande djupt sökande Målet för AI Målet för AI Grekiska Grekiska Kvinna Kvinna Dagar ️ 
 
 undantag Nivå 
 
 [x] Medelstora Relaterade reaktioner https://hackernoon.com/refactoring-014-how-to-remove-if?embedable=true Så här 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 Krediter Bild från är Följ Ryan McGuire från Pixabay Denna artikel är en del av Refactoring-serien. 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.

Refactoring 031 - Ta bort OOP

About Author

KOMMENTARER

HÄNG TAGGAR

DENNA ARTIKEL PRESENTERAS I

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps