Ayuda a los usuarios, no confusión 
 
 TL;DR: reemplaza los mensajes de error vagos por comentarios específicos y actuables que ayudan a los usuarios a resolver problemas. TL;DR: reemplaza los mensajes de error vagos por comentarios específicos y actuables que ayudan a los usuarios a resolver problemas. Problemas solucionados 
 
 
 
 
 
 
 
 
 
 
 Confusión y frustración de los usuarios No hay guía de acción disponible Jargón Técnico Errores no tratados Pobre UX Recuperación de errores Información de error incompleto Disminuye la confianza de los usuarios Mensajes genéricos Los fracasos silenciosos Código relacionado Olor 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 Pasos 
 
 
 
 
 
 Identificar todos los mensajes de error genéricos en su base de código que utilicen términos como "Oops", "Algo salió mal" o "Se produjo un error" Reemplazar mensajes genéricos con descripciones específicas de lo que sucedió Agregar una guía actuable que diga a los usuarios exactamente lo que pueden hacer para resolver el problema Implementar el registro interno adecuado para capturar detalles técnicos para los desarrolladores Añadir alertas de seguimiento para notificar al equipo de desarrollo cuando los errores ocurren con frecuencia Código de muestreo Antes de 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
  });
}
 Después de 🙂 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." };
}
 Tipo 
 
 [x] El manual Seguridad ️ Este refactoring cambia el comportamiento y es seguro si mantiene el registro y las alertas activas para el borrado. Evite eliminar los detalles necesarios para los equipos de soporte. El riesgo de romper los cambios es bajo ya que está mejorando el manejo de errores existentes en lugar de cambiar la lógica de negocio principal. ¿Por qué el código es mejor? Usted da a los usuarios una guía útil en lugar de confusión. Crea una mejor experiencia de usuario al proporcionar comentarios claros y actuables en lugar de confundir jargón técnico. Los usuarios entienden lo que pasó mal y saben sus próximos pasos. Separa las preocupaciones manteniendo los detalles técnicos en los registros mientras muestra mensajes amigables a los usuarios. Tu equipo de soporte obtendrá una mejor eliminación de la información a través de un registro estructurado. Puede abordar proactivamente los problemas del sistema mediante el seguimiento de las alertas antes de que los usuarios los reporten. Mantén la información técnica alejada de ellos, pero todavía la registra para una resolución de problemas más rápida. ¿Cómo mejorar la bijeción? ️ Usted mantiene una coincidencia más cercana entre el mundo real y su modelo. En lugar de los mensajes vagos "Oops", su sistema habla en términos claros que reflejan eventos reales. Mensajes de error en la Contiene información específica sobre lo que ha ido mal y cómo corregirlo. El mundo real Un cajero no dice "Oops, algo salió mal" cuando su tarjeta es rechazada - le dicen el problema específico y sugieren soluciones. Este refactoring alinea el modelo de software con patrones de comunicación de error, haciendo que el sistema sea más intuitivo y útil para los usuarios Bijeción Limitaciones ☀️ Usted debe tener cuidado de no exponer información sensible del sistema que podría ayudar a los atacantes. Algunos errores pueden tener que permanecer genéricos por razones de seguridad (como fallos de autenticación). Además, la creación de mensajes de error específicos requiere más tiempo de desarrollo y pruebas minuciosas de escenarios de error. Refactor con AI 
 
 Prompt sugerido: 1. Identificar todos los mensajes de error genéricos en su base de código que utilicen términos como "Oops", "Algo salió mal", o "Se produjo un error" 2.Sustituir los mensajes genéricos con descripciones específicas de lo que sucedió 3.Añadir una guía actuable que diga a los usuarios exactamente lo que pueden hacer para resolver el problema 4.Implementar el registro interno adecuado para capturar detalles técnicos para los desarrolladores 5.Añadir alertas de seguimiento para notificar al equipo de desarrollo cuando los errores ocurren con frecuencia. Prompt sugerido: 1. Identificar todos los mensajes de error genéricos en su base de código que utilicen términos como "Oops", "Algo salió mal", o "Se produjo un error" 2.Sustituir los mensajes genéricos con descripciones específicas de lo que sucedió 3.Añadir una guía actuable que diga a los usuarios exactamente lo que pueden hacer para resolver el problema 4.Implementar el registro interno adecuado para capturar detalles técnicos para los desarrolladores 5.Añadir alertas de seguimiento para notificar al equipo de desarrollo cuando los errores ocurren con frecuencia. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 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 ChatGPT ChatGPT Claude Claude Perplejidad Perplejidad piloto piloto tú tú Gemini Gemini profundidad profundidad El objetivo es El objetivo es Grúas Grúas Quien Quien Tags ️ 
 
 Excepciones Nivel 
 
 [x] El Intermedio Reacciones relacionadas https://hackernoon.com/refactoring-014-how-to-remove-if?embedable=true Es decir, 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 Créditos Imagen por es por Ryan McGuire Pixabay Este artículo forma parte de la serie 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.

Refactoring 031 - Eliminación de OOPs

About Author

COMENTARIOS

ETIQUETAS

ESTE ARTÍCULO FUE PRESENTADO EN

Related Stories

Una breve introducción a la teoría del cerebro de Boltzmann

Toque para ganar: Telegram puede incorporar a los próximos 10 mil millones de usuarios de criptomonedas antes de Solana

La guía completa para una migración exitosa a la nube: estrategias y mejores prácticas

El modelo Bitcoin UTXO, impulsando un ecosistema único

Una breve introducción a la teoría del cerebro de Boltzmann

Toque para ganar: Telegram puede incorporar a los próximos 10 mil millones de usuarios de criptomonedas antes de Solana

La guía completa para una migración exitosa a la nube: estrategias y mejores prácticas

El modelo Bitcoin UTXO, impulsando un ecosistema único

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps