Para recopilar y ver comentarios, debes habilitar los comentarios desde la página de Add-ons en tu dashboard.
Tipos de comentarios
Los comentarios contextuales y sobre fragmentos de código están en versión beta. Para habilitarlos en tu sitio de documentación, contacta a nuestro equipo de ventas.
- Valoración con pulgares: Votación simple de pulgar arriba/abajo para medir la satisfacción general con las páginas.
- Sugerencias de edición: Permite que los usuarios sugieran ediciones para tu documentación. Solo disponible para repositorios públicos de GitHub.
- Crear issues: Permite que los usuarios creen issues de GitHub directamente desde tu documentación. Solo disponible para repositorios públicos de GitHub.
- Comentarios contextuales: Comentarios abiertos sobre el contenido de una página.
- Comentarios sobre fragmentos de código: Comentarios específicamente sobre fragmentos de código.
- Comentarios de agentes: Comentarios enviados por agentes de IA de terceros que acceden a tu documentación.
Recopilar direcciones de correo electrónico
- Ve a la página de Add-ons en tu dashboard.
- Habilita la opción Collect reader emails en la configuración de comentarios.
- Opcionalmente, añade un aviso de privacidad sobre cómo tu equipo utiliza los correos electrónicos recopilados.
Si deshabilitas la telemetría en tu archivo
docs.json, las funciones de comentarios no estarán disponibles en tus páginas de documentación.Gestionar comentarios
Cambiar el estado de los comentarios
- Pendiente: El comentario está a la espera de revisión.
- En curso: Se está trabajando para resolver el comentario.
- Resuelto: El comentario se ha resuelto.
- Descartado: El comentario es irrelevante o inexacto.
Filtrar por estado
Filtrar por tipo
- Ratings by page: Consulta qué páginas tienen más comentarios positivos y negativos. Usa estos datos cuantitativos para identificar las páginas que los usuarios consideran más y menos útiles.
- Detailed feedback: Revisa los comentarios abiertos que los usuarios dejan en las páginas para identificar mejoras específicas en páginas concretas.
- Code snippets: Revisa los comentarios abiertos que los usuarios dejan sobre fragmentos de código para identificar mejoras específicas en bloques de código concretos.
Añadir notas internas
Comentarios de agentes
Los comentarios de agentes están en versión beta y sujetos a cambios.
Cómo funcionan los comentarios de agentes
<AgentInstructions> con instrucciones y el endpoint para enviar comentarios cuando un agente obtiene una página mediante la exportación Markdown.
Los agentes envían comentarios al endpoint con la ruta de la página y el texto del comentario. Los comentarios aparecen en el dashboard junto a los comentarios humanos.
El endpoint de comentarios siempre está disponible en https://tu-dominio.com/feedback como una solicitud POST, incluso si no añades las instrucciones a la exportación Markdown, por lo que puedes indicar a los agentes que envíen comentarios manualmente publicando en el endpoint.
Habilitar comentarios de agentes
- Ve a la página de Add-ons en tu dashboard.
-
Habilita la opción Agent feedback.
Recuperar comentarios de agentes por API
source=agent para obtener solo los comentarios de agentes.
Las respuestas de comentarios de agentes incluyen:
comment: El texto del comentario enviado por el agente.path: La ruta de la página a la que se refiere el comentario.
Usa los datos de feedback
- Identificar contenido exitoso: Las páginas con más feedback positivo muestran qué funciona bien en tu documentación.
- Priorizar mejoras: Las páginas con más feedback negativo indican qué contenido podría necesitar atención.
- Tomar medidas: Realiza actualizaciones en la documentación basadas en el feedback directo de los usuarios.