Дайте користувачам допомогу, а не плутанину 
 
 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 Крок за кроком 
 
 
 
 
 
 Визначте всі загальні повідомлення про помилку у вашій кодовій базі, які використовують такі терміни, як «Опс», «Щось пішло не так» або «Виникла помилка». Замінити загальні повідомлення конкретними описами того, що сталося Додайте дієве керівництво, яке точно розповість користувачам, що вони можуть зробити, щоб вирішити проблему Впровадити правильне внутрішнє журналювання для захоплення технічних деталей для розробників Додайте попередження про моніторинг, щоб повідомляти команду розробників, коли часто виникають помилки Зразковий код Раніше 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", ваша система говорить в ясних термінах, які відображають реальні події. Повідомлення про помилки в - містить конкретну інформацію про те, що пішло не так і як це виправити. Реальний світ Касир не говорить "Опс, щось пішло не так", коли ваша картка відмовляється - вони розповідають вам про конкретну проблему і пропонують рішення. Цей рефакторинг узгоджує модель програмного забезпечення з шаблони комунікації з помилками, що робить систему більш інтуїтивною та корисною для користувачів Бієкція Обмеження ️ Ви повинні бути обережні, щоб не розкривати конфіденційну інформацію системи, яка може допомогти нападникам. Деякі помилки можуть залишатися загальними з міркувань безпеки (наприклад, невдачі аутентифікації). Крім того, створення конкретних повідомлень про помилки вимагає більшого часу розробки та ретельного тестування сценаріїв помилок. Створення Refactor with AI 
 
 Визначте всі загальні повідомлення про помилки у вашій кодовій базі, які використовують такі терміни, як "Oops", "Щось пішло не так" або "Виникла помилка" 2.Замінити загальні повідомлення конкретними описами того, що сталося 3.Додайте дієві рекомендації, які розповідають користувачам точно, що вони можуть зробити, щоб вирішити проблему 4.Впровадити належне внутрішнє реєстрацію для захоплення технічних деталей для розробників 5.Додайте спостереження, щоб повідомити команду розробників, коли помилки відбуваються часто. Визначте всі загальні повідомлення про помилки у вашій кодовій базі, які використовують такі терміни, як "Oops", "Щось пішло не так" або "Виникла помилка" 2.Замінити загальні повідомлення конкретними описами того, що сталося 3.Додайте дієві рекомендації, які розповідають користувачам точно, що вони можуть зробити, щоб вирішити проблему 4.Впровадити належне внутрішнє реєстрацію для захоплення технічних деталей для розробників 5.Додайте спостереження, щоб повідомити команду розробників, коли помилки відбуваються часто. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 ЧатГП ЧатГП Клод Клод Занепокоєння Занепокоєння дитячий пілот дитячий пілот Ви Ви Близнюки Близнюки DeepSeek DeepSeek Мета AI Мета AI ГРОК ГРОК Квін Квін День ️ 
 
 Винятки Рівень 
 
 [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 Кредити Зображення від Є Райан МакГайр Pixabay Ця стаття є частиною серії 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.

Рефакторинг 031 - Видалення ООП

About Author

КОМЕНТАРІ

ПОВІСИТИ БИРКИ

ЦЯ СТАТТЯ БУЛА ПРЕДСТАВЛЕНА В

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps