Comentarios

Recopila comentarios de tus lectores directamente desde las páginas.

Para asegurarte de que tu documentación sea de alta calidad, esté actualizada y ofrezca a tus lectores la información que necesitan, es muy importante recopilar sus comentarios. DeveloperHub lleva los comentarios de tus lectores a las páginas y procesa los datos por ti en el panel, para que puedas mejorar la documentación y tener lectores más satisfechos.

¿Cómo funcionan los comentarios para los lectores?

Cuando está habilitado, un aviso al final de cada página pide comentarios a los lectores. El lector puede responder con Sí o No. A continuación se abre un cuadro de texto para que explique su respuesta, que puede Enviar o Omitir.

Aviso de comentarios, después de que el lector responda

¿Dónde puedo encontrar los comentarios recibidos?

Los comentarios se pueden consultar en dos niveles: página y proyecto. Cuando una página recibe un me gusta o un no me gusta, puedes ver la valoración media de la página en la barra lateral derecha. También puedes ver el registro de la valoración a lo largo del tiempo, así como los mensajes que has recibido para esa página. Puedes marcar el mensaje como leído.

Los comentarios de una página: su valoración, la evolución de la valoración y los mensajes que dejaron los lectores

Además, en el panel también puedes ver la valoración del proyecto a lo largo del tiempo, así como todos los mensajes sin leer. Asimismo, en el panel encontrarás una lista de las páginas más valoradas y de las menos valoradas. Puedes usar esta información para aplicar en las páginas menos valoradas el buen estilo de documentación de las páginas más valoradas, y analizar los mensajes para aprender a mejorar las páginas.

El panel de comentarios: valoración a lo largo del tiempo, la bandeja de entrada y las páginas más y menos valoradas

También puedes descargar los comentarios como CSV desde el panel, usando la opción de descarga junto a Bandeja de comentarios.

Junto a ella, Analizar con IA envía los comentarios a AI Agent. El agente se abre con una solicitud para leer lo que a los lectores les gustó y no les gustó, encontrar los temas comunes y señalar las páginas que hay que mejorar, lista para que la envíes. Requiere un plan con funciones de IA, el agente activado para el proyecto y acceso de escritor o superior.

Descarga de los comentarios como CSV y envío a AI Agent

Cualquier miembro del equipo puede marcar un comentario como spam. Los comentarios marcados como spam se minimizan en el panel de comentarios. No aparecerán en la barra lateral de comentarios de una página. Tampoco cuentan en ninguna estadística ni se envían por nuestros canales de notificación. También puedes usar un filtro de spam automático.

Notificaciones de comentarios

Si tienes un canal de Slack conectado a tu proyecto, te avisaremos en ese canal de los comentarios que hayas recibido.

Enviamos las notificaciones cada hora.


Filtro de spam de comentarios

El filtro de spam de comentarios está desactivado por defecto y se puede habilitar desde Configuración de comentarios.

El filtro de spam marca como spam cualquier comentario nuevo cuyo mensaje parezca inútil, sospechoso, spam, demasiado corto, malicioso u ofensivo.

Cuando el ajuste está habilitado, cualquier comentario nuevo que contenga un mensaje se enviará a OpenAI para el filtrado de spam.

Los controles de comentarios también se pueden mostrar u ocultar según el sitio de referencia (el sitio desde el que el lector llegó a la documentación). Esto puede ser útil si los lectores confunden tu sitio con el sitio de soporte de tu propio cliente B2B. Por ejemplo, los controles de comentarios se pueden desactivar según el sitio de referencia añadiendo el siguiente JS personalizado:

<script>
var referrer = document.referrer;
if (!referrer) {
return;
}
var allowedReferrerSites = [
window.location.host, // Docs site
'example.com'
];
var disableFeedback = !allowedReferrerSites.reduce((acc, site) => acc || referrer.includes(site), false);
window.settings.apply({
feedback: {
disable: disableFeedback
}
});
</script>

Lo mismo se puede hacer para configurar una lista de denegación de sitios de referencia.

Ocultar datos personales en los comentarios

La información de identificación personal (PII) se puede redactar automáticamente de los comentarios. Está desactivado por defecto y se puede habilitar desde Configuración de comentarios.

El filtro de PII elimina de los mensajes de comentarios, al enviarse, cualquier información que parezca personal, como nombres, números de teléfono, direcciones de correo electrónico, direcciones postales, etc.

La PII no se puede recuperar una vez redactada.

Cuando el ajuste está habilitado, cualquier comentario nuevo que contenga un mensaje se enviará a OpenAI para redactar la PII.

Configuración de comentarios

Todos los ajustes de comentarios están en un solo lugar: Configuración del proyecto → General → Comentarios. Cambia lo que necesites y luego haz clic en Guardar cambios en el menú superior.

En Comentarios de los lectores:

  • Recopilar comentarios coloca el widget de reacciones al final de cada página publicada. Está activado por defecto en los proyectos creados después de abril de 2021.

  • Mensajes escritos permite a los lectores explicar el motivo con sus propias palabras en lugar de solo reaccionar. Requiere que Recopilar comentarios esté activado, porque el cuadro de mensaje se muestra dentro del widget, y requiere un plan que incluya mensajes escritos. Consulta Precios.

En Moderación con IA:

  • Ocultar información personal elimina correos electrónicos, números de teléfono y nombres de un mensaje antes de almacenarlo.

  • Marcar spam marca los envíos basura para que no estorben a los comentarios reales.

Ambos ajustes de moderación requieren que Mensajes escritos esté activado, porque una reacción no contiene texto que redactar o clasificar, y ambos requieren un plan que incluya funciones de IA.

Desactivar cualquiera de estos ajustes siempre está permitido, sea cual sea tu plan. Si tu proyecto conserva un ajuste de un plan que ya no tiene, puedes volver a desactivarlo.

Hook de JavaScript para comentarios

Si deseas enviar analíticas de búsqueda a servicios de terceros, puedes usar el evento de JavaScript onfeedback para escuchar los eventos de comentarios. Consulta On Feedback.

  Última actualización