Saltar al contenido principal
Para recopilar y ver comentarios, debes habilitar los comentarios desde la página de Add-ons en tu dashboard.
La pestaña Feedback muestra los votos cuantitativos de pulgar hacia arriba y pulgar hacia abajo que ha recibido tu documentación, así como cualquier comentario cualitativo que hayan proporcionado los usuarios. Usa esta información para evaluar la calidad de tu documentación y realizar mejoras. Consulta los comentarios en la página de Analytics en tu dashboard.
Pestaña Feedback en la página de Analytics.

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.
La pestaña de comentarios muestra información según los Add-ons de comentarios que habilites.
Controles de comentarios en la página Add-ons.
  • Valoración con pulgares: Votación simple de pulgar arriba/abajo para medir la satisfacción general con las páginas.
  • 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.
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

Para los comentarios contextuales y sobre fragmentos de código, puedes establecer el estado de cada comentario y añadir notas internas para hacer un seguimiento de tu trabajo al resolver los comentarios de los usuarios.

Cambiar el estado de los comentarios

Selecciona el estado junto a un comentario para marcarlo como Pendiente, En curso, Resuelto o Descartado. Mejores prácticas para definir estados de comentarios:
  • Pendiente: El comentario está a la espera de revisión.
  • En curso: El comentario ha sido validado y se está trabajando en él.
  • Resuelto: El comentario se ha resuelto.
  • Descartado: El comentario se ha descartado por no ser procesable, relevante o por ser inexacto.

Filtrar por estado

Utiliza el filtro por estado para controlar qué comentarios se muestran. Quita un estado para ocultar todos los comentarios con ese estado. De forma predeterminada, se muestran todos los comentarios.

Añadir notas internas

Haz clic en un elemento de feedback para añadir una nota interna. Estas notas solo son visibles para las personas con acceso a tu dashboard. Usa las notas para añadir información para colaborar, vincular tickets relevantes de soporte o de ingeniería, o recordar cualquier otra información útil.

Usa los datos de feedback

Revisa tus datos de feedback para:
  • 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.