Saltar al contenido principal
Para recopilar y ver comentarios, primero debes habilitarlos desde la página de Add-ons en tu dashboard.
La pestaña de comentarios muestra los votos cuantitativos de pulgar arriba y pulgar abajo que han recibido tus docs y cualquier comentario cualitativo que los usuarios hayan proporcionado. Usa esta información para evaluar la calidad de tus docs y realizar mejoras. Accede a la pestaña de comentarios desde la página Insights en tu dashboard.

​
Tipos de comentarios

Los comentarios contextuales y en fragmentos de código están en beta. Para habilitarlos en tu sitio de documentación, contacta a nuestro equipo de ventas.
La Tab de comentarios muestra información según los Add-ons de comentarios que habilites. Habilita tus tipos de comentarios preferidos:
Captura de pantalla de los conmutadores de comentarios en la página de Add-ons.
  • Solo valoración con pulgares: Votación simple de pulgar arriba/abajo para medir la satisfacción general con las páginas.
  • Solo comentarios en fragmentos de código: Comentarios específicamente sobre fragmentos de código.
  • Valoración con pulgares y comentarios contextuales: Votación de la página más comentarios detallados y motivos de las valoraciones.
  • Valoración con pulgares y comentarios en fragmentos de código: Votación de la página más comentarios sobre ejemplos de código.
  • Valoración con pulgares, contextuales y en fragmentos de código: Sistema de comentarios completo con votación de la página, comentarios detallados y comentarios en fragmentos de código.
Si deshabilitas la telemetría en tu archivo docs.json, las funciones de comentarios no aparecerán en tus páginas de documentación, incluso si las habilitas en tu dashboard.

​
Gestión de comentarios

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

​
Cambiar el estado del feedback

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

​
Filtrar por estado

Usa el filtro de estado para controlar qué comentarios se muestran. Limpia un estado para ocultar todos los comentarios con ese estado. De forma predeterminada, se muestran todos los comentarios.

​
Agregar notas internas

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

​
Uso de 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 requerir atención.
    • Tomar medidas: Realiza actualizaciones en la documentación basadas en feedback directo de los usuarios.