Escribir documentación no es una tarea fácil. Se necesita mucho tiempo y esfuerzo para redactar una buena documentación para cualquier producto, servicio o tecnología. Pero todo ese esfuerzo y tiempo se desperdiciaría si los usuarios no lo encontraran útil. Para cerrar esta brecha, las grandes empresas proporcionan un formulario de comentarios simple al final de sus artículos de documentación que le pide al usuario una simple pregunta «¿Le resultó útil este artículo?». Recientemente, mientras trabajábamos en el proyecto de un cliente, encontramos la necesidad de una solución que nos permitiera obtener comentarios de los usuarios sobre nuestra documentación. En este artículo, le mostraremos cómo obtener comentarios de los lectores sobre su documentación en WordPress. Lo primero que debe hacer es instalar y activar el plugin Document Feedback. Una vez activado, el plugin agrega un pequeño aviso al final de sus páginas de WordPress solicitando comentarios de los usuarios.
Cuando los usuarios hacen clic en Sí, se les pregunta qué detalles encontraron útiles.
De lo contrario, si un usuario hace clic en No, se le pregunta qué información le gustaría ver aquí.
El plugin luego muestra los comentarios del documento a los autores / administradores.
Este plugin es bastante nuevo y todavía está en pañales. El plugin predeterminado está limitado solo a páginas. Sin embargo, puede habilitar Publicaciones, Páginas y cualquier otro tipo de publicación que desee. Todo lo que tendría que hacer es agregar el siguiente código en un plugin específico del sitio: // Función de filtro de comentarios del documento wpb_new_document_post_type ($ post_types) {$ post_types = array (‘page’, ‘post’); // Agrega el tipo de publicación return $ post_types; } add_filter (‘document_feedback_post_types’, ‘wpb_new_document_post_type’); Simplemente agregue cualquier otro tipo de publicación que desee en la tabla de arriba. El plugin también está limitado solo a usuarios registrados. Esto funcionó bien para nuestro caso de uso, ya que la documentación solo estaba disponible para clientes registrados. Según los comentarios sobre el desarrollo del plugin, parece que el autor también planea ponerlo a disposición de los usuarios desconectados. Este plugin proporciona comentarios privados rápidos para mejorar sus páginas de documentación. Esto es mejor que incrustar un formulario de contacto en la parte inferior de las páginas de documentación o activar comentarios. Háganos saber cómo obtiene comentarios de los usuarios sobre la documentación de sus sitios.