Saltar al contenido principal
Los comentarios requieren un plan Pro o Enterprise.
La sección de comentarios de la página de analíticas muestra los votos cuantitativos de pulgar arriba y pulgar abajo que reciben tus páginas por parte de los usuarios, así como cualquier comentario cualitativo que proporcionen. Utiliza esta información para evaluar la calidad de tu contenido y realizar mejoras. Revisa tus datos de comentarios para:
  • Identificar contenido exitoso: Las páginas con más comentarios positivos muestran qué funciona bien en tu documentación.
  • Priorizar mejoras: Las páginas con más comentarios negativos indican qué contenido podría necesitar atención.
  • Tomar medidas: Realiza actualizaciones en la documentación basadas en los comentarios directos de los usuarios.
Pestaña de comentarios en la página de analíticas.

​
Habilitar comentarios

Si desactivas la telemetría en tu archivo docs.json, no podrás habilitar las funciones de comentarios.
Para recopilar y ver los comentarios, debes habilitar los comentarios desde la página Add-ons en tu panel.
  1. Navega a la página Add-ons.
  2. Habilita los tipos de comentarios que desees.
  • Thumbs rating: Votación simple con pulgar arriba/abajo para evaluar la satisfacción general con las páginas.
  • Edit suggestions: Permite a los usuarios sugerir modificaciones a tu documentación. Solo disponible para repositorios públicos.
  • Raise issues: Permite a los usuarios crear issues directamente desde tu sitio. Solo disponible para repositorios públicos.
  • Contextual feedback: Comentarios de formato libre sobre el contenido de una página. Opcionalmente, habilita la recopilación de correos electrónicos para permitir que los usuarios proporcionen su dirección de correo al enviar comentarios.
  • Code snippet feedback: Comentarios específicamente sobre fragmentos de código.
  • Agent feedback: Comentarios enviados por agentes de IA de terceros que acceden a tu documentación.
Interruptores de comentarios en la página de Add-ons.

​
Gestionar comentarios

Puedes establecer el estado de un comentario y añadir notas internas para realizar un seguimiento de tu trabajo resolviendo los comentarios de los usuarios.

​
Cambiar el estado de un comentario

Selecciona el estado junto a un comentario para marcarlo como Pending, In Progress, Resolved o Dismissed. Mejores prácticas para establecer los estados de los comentarios:
  • Pending: El comentario está en espera de revisión.
  • In Progress: Se está trabajando en abordar el comentario.
  • Resolved: Resolviste el comentario.
  • Dismissed: El comentario es irrelevante o inexacto.

​
Filtrar por estado

Utiliza el menú Filters para controlar qué comentarios se muestran. Desmarca un estado para ocultar todos los comentarios con ese estado. De forma predeterminada, se muestran todos los tipos de comentarios.

​
Filtrar por tipo

Selecciona entre Ratings by page, Detailed feedback y Code snippets según la información que quieras analizar.
  • Ratings by page: Ve qué páginas tienen más comentarios positivos y negativos. Utiliza estos datos cuantitativos para identificar las páginas que los usuarios encuentran más y menos útiles.
  • Detailed feedback: Revisa los comentarios abiertos que los usuarios dejan en las páginas para identificar mejoras específicas para páginas concretas. Los comentarios detallados solo muestran comentarios que incluyen información adicional. Los envíos que utilizan únicamente la calificación de pulgar arriba o pulgar abajo sin seleccionar una opción adicional de comentarios no aparecen en la vista detallada.
  • Code snippets: Revisa los comentarios abiertos que los usuarios dejan en los fragmentos de código para identificar mejoras específicas para bloques concretos de código.

​
Añadir notas internas

Haz clic en un comentario para añadir una nota interna. Estas notas solo son visibles para las personas con acceso a tu panel. Utiliza las notas para añadir información para la colaboración, vincular tickets relevantes de soporte o ingeniería, o recordar cualquier otra información útil.

​
Comentarios de agentes

Los comentarios de agentes están en beta y sujetos a cambios.
Cuando los agentes de IA de terceros obtienen tu documentación, pueden enviar comentarios estructurados sobre páginas que consideran incorrectas, desactualizadas o difíciles de usar. Estos comentarios aparecen en la sección Detailed feedback identificados con una insignia Agent. Gestiona los comentarios de agentes de la misma manera que los comentarios humanos.

​
Cómo funcionan los comentarios de agentes

Debes habilitar los comentarios de agentes en tu panel para recopilarlos. Una vez habilitados, Mintlify añade un bloque <AgentInstructions> con instrucciones y el endpoint para enviar comentarios cuando un agente obtiene una página utilizando la exportación de Markdown. Los agentes publican comentarios en el endpoint con la ruta de la página y el texto del comentario. Los comentarios aparecen en el panel junto con los comentarios humanos. El endpoint de comentarios siempre está disponible en https://your-domain.com/feedback como una solicitud POST, incluso si no añades las instrucciones a la exportación de Markdown. Puedes indicar a los agentes que envíen comentarios manualmente publicando en el endpoint.

​
Recuperar los comentarios de agentes vía API

Utiliza el endpoint de comentarios de analíticas para recuperar los comentarios de agentes de forma programática. Filtra por source=agent para devolver únicamente 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 sobre la que trata el comentario.