Las guías de usuario son una parte importante de la prestación de servicios digitales. Los clientes digitales esperan poder acceder al autoservicio y exigen un acceso inmediato a la información. Un paseo por teléfono ya no es suficiente; se pierden horas explicando cosas que pueden ilustrarse mejor en las guías de documentación del usuario.
En Docsie, abogamos por que todas las empresas creen una biblioteca de guías de usuario informativas para los clientes. Esto permitirá el autoservicio, reducirá la carga de trabajo de soporte y proporcionará acceso en tiempo real las 24 horas del día, los 7 días de la semana, a la información que sus clientes necesitan para disfrutar y trabajar con su producto o servicio.
10 consejos principales para las guías de usuario y la documentación en Docsie
Antes de empezar, ¿tienes una forma de almacenar, escribir y alojar documentación?
Diríjase a la página Docsie Onboarding para una colaboración centrada en el cliente, una amplia incrustación, traducciones a medida y una potente publicación al alcance de su mano.
Ahora que te has unido al club, pasemos a nuestros 10 consejos principales.
1 - Enriquezca sus guías de usuario con medios
Texto, palabras, letras: los usamos todos los días. Por desgracia, la palabra escrita no puede compararse con la veracidad del vídeo o la inspiración de las imágenes.
Cuando cree guías de documentación para el usuario, léalas desde la perspectiva del usuario. ¿Podría explicarse mejor esta sección con un GIF, un vídeo incrustado o una imagen comentada? Si es así, ¡añade una!
Puedes añadir imágenes, incrustar vídeos e integrar contenido iFrame en Docsie. ¡Pruébalo!
Imágenes, vídeos y GIF en Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_CdhFEVXwXaefNXxxg/boo_dqsfhc7ObadQ3xWmV/e0eda1c6-284a-3e0f-5c43-0ff4099966d0BlogGIF10TipsforUserGuides.gif)
2 - Cree una Orden, ¡no del tipo Jedi!
Las instrucciones paso a paso son el pilar de los libros de cocina de todo el mundo. Cuando sigues una receta, ¿mezclas los huevos con la harina? Eso es lo que debes hacer, ¡y lo sabes porque sigues los pasos!
Bromas aparte, asegúrate de que sigues todas las guías con instrucciones paso a paso. Si sigues esos pasos, ¿obtienes realmente el resultado previsto? Las instrucciones imprecisas que no consiguen el resultado deseado son una gran señal de alarma para los clientes. Por otro lado, unas instrucciones precisas infunden confianza y aportan valor a los clientes y a la empresa mediante el intercambio de información.
Cree un orden utilizando las listas numeradas de Docsie, o con Docsie Book Articles para segmentar su documentación.
Artículos, estanterías y espacios de trabajo en Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_O4Ux6ERzhyIS0eB1X/boo_dqsfhc7ObadQ3xWmV/aa925138-ab48-e18b-ff33-50557a2897cfArticlesShelvesWorkspacesinDocsie.png)
3 - Adaptarse a todos los niveles de lectura
¿Asume que los clientes conocerán su JavaScript a partir de sus consejos principales? El uso de jerga y terminología compleja suele recomendarse en el contexto de guías de usuario técnicas. Sin embargo, para los legos en la materia, cuanto más sencillo sea el lenguaje, ¡mejor!
La mayoría de los lectores sólo quieren saber cómo hacer una cosa, y repetirla. Uno de los enfoques consiste en presentar un concepto complejo y de alto nivel sobre el papel y, a continuación, repetirlo de nuevo con una versión simplificada para legos. Así se atiende a la vez a los usuarios técnicos y a los profanos, entintando dos páginas con un solo bolígrafo.
"La inteligencia artificial implica la emulación algorítmica de la inteligencia humana en busca de la productividad; la inteligencia artificial tiene como objetivo realizar el trabajo igualando la inteligencia humana mediante código informático". - Ambos significan lo mismo, pero se dirigen a públicos diferentes.
Utiliza Docsie para crear estanterías para profanos y estanterías para usuarios técnicos. De este modo, podrá disponer de Libros para ambos públicos, con alojamiento completo disponible a través del Portal Docsie.
Código complejo simplificado para legos en la materia en un ejemplo de Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cnLx3DDYwihXopx74/boo_dqsfhc7ObadQ3xWmV/411ea34c-096b-3bf2-fde0-2f8fdaddd55aLaypersonSimplificationforDocsie.png)
4 - ¡Utilice plantillas y deje de trasnochar!
¿Reescribe cada guía de usuario desde cero? En su lugar, debería crear plantillas con una estructura básica y mensajes de marca, y construir en torno a este contenido.
Escribir desde cero lleva tiempo, esfuerzo y riesgos de inconsistencia si varios escritores están trabajando en el mismo proyecto. Las plantillas son una buena forma de ahorrar tiempo al escribir y de lograr una mayor coherencia entre las páginas. La confianza se basa en la coherencia de los mensajes y la generación de valor, que es lo que fomentan las plantillas.
Haga clic en ...Más y seleccione Plantillas en Docsie. Aquí puede almacenar plantillas y comenzar nuevos Libros utilizando la plantilla como fuente.
Plantillas en Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_Hv9JSg74vQE1zgYjT/boo_dqsfhc7ObadQ3xWmV/833830aa-871c-d3ba-19e7-0fbbba2adbfbTemplatesinDocsie.png) Plantilla en vivo en el editor de Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_jdf9iWL3NXlFFePHx/boo_dqsfhc7ObadQ3xWmV/2bfcea18-df94-30ff-4931-799345e4ae74Templates2inDocsie.png)
5 - Escribir rápido, iterar a menudo
En el desarrollo ágil de software, el mantra es fallar rápido e iterar a menudo. Aplicándolo a las guías de documentación de usuario, su personal debe tener como objetivo escribir rápido e iterar a menudo.
Esto no significa sacrificar la calidad por la velocidad. Por el contrario, esto permite obtener comentarios y respuestas de los clientes con menos esfuerzo inicial. Esta información puede aprovecharse en posteriores iteraciones de la guía de documentación del usuario y ayuda a la empresa a centrarse más en el cliente.
Docsie Vocally elucida los comentarios de los lectores, con puntuaciones y grabaciones de pantalla para señalar el contenido exacto que han leído. Pruébalo mientras escribes rápido e iteras a menudo.
Docsie Vocally Feedback View](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_8uO5DnYSHSsLteI2X/boo_dqsfhc7ObadQ3xWmV/b9f841c9-1dde-5eee-c723-809f13df3255DocsieVocallyLivePreview.png)
6 - Conocimiento anidado con backlinks internos
¿Está la documentación de su guía de usuario enlazada con otras páginas? Al añadir enlaces a secciones relevantes de la documentación, ayudas a los lectores a profundizar y comprender tu producto o servicio a nivel conceptual.
Cuando haga referencia a una característica o función específica, añada siempre un enlace. Permita que el lector acceda rápidamente a esa información, en lugar de obligarle a buscar y cargar la página por sí mismo. ¿Habla del inicio de sesión en una cuenta? Añada una URL de inicio de sesión al texto "inicie sesión en su cuenta" de su página, y de cualquier otra página. Haz que tu documentación sea cómoda y navegable dentro del cuerpo del texto, en lugar de una biblioteca interminable en la que rebuscar.
Docsie permite a los redactores de guías de usuario crear backlinks internos. Basta con resaltar un texto y hacer clic en el botón 🖇️ de la barra de herramientas del editor de Docsie. Además, puede hacer que los enlaces sean independientes del idioma y de la versión con los enlaces a objetos relativos .
Enlaces internos en Docsie con enlaces de referencia a objetos](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_dclZdrsTWJrB8WETc/boo_dqsfhc7ObadQ3xWmV/7d8c9e37-3aa6-580d-644b-0d7a8039fa89DocsieObjectLinksforBacklinking.png)
7 - Limpie las telarañas y actualice el contenido antiguo
¿Tiene guías de usuario y documentación antiguas visibles en línea? Si tiene documentación de la versión 1.2 publicada mientras su producto está en la versión 1.3, su documentación ya no es relevante. En lugar de publicar nueva documentación para cada versión, utilice Docsie Versioning.
Docsie Versioning permite a los usuarios acceder a las versiones históricas y actuales de la documentación. A medida que se publican nuevas versiones, las antiguas se archivan por motivos de redundancia y se puede acceder a ellas desde un menú desplegable. Todo ello se encuentra en la misma página web, lo que facilita a los usuarios la navegación y la búsqueda de información relevante.
Del mismo modo, si su guía de consejos para 2021 sigue publicada en 2022, ¡actualícela! Cambie el nombre, actualice las citas y las fuentes con datos de investigación actualizados y compruebe que la información sigue siendo pertinente. Elimina las telarañas y mantén el contenido perenne; siempre se puede reutilizar.
Buscador de versiones para encontrar contenido antiguo en Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_OaCUumTVGz3CQ2ha2/boo_dqsfhc7ObadQ3xWmV/4edbd225-b61b-0921-4f63-e55b3052ed28DocsieVersionsPickerMenu.png)
8 - Miniaturice las tareas, complételas por lotes
Cuando escribes, ¿escribes toda la página de un tirón sin ninguna planificación previa? Parte de esto se reduce a las preferencias personales de los escritores. Sin embargo, al miniaturizar las tareas, el trabajo puede completarse más rápido y con más concentración.
Crea una estructura sencilla con etiquetas H1 y H2 y breves descripciones de cada sección. Utilízala cuando escribas y ocúpate de las secciones individuales en lugar de preocuparte por toda la página. En el sector de la escritura esto se conoce como esquema. El esquema ofrece la oportunidad de intercambiar opiniones con los editores antes de empezar a escribir y sirve de marco de referencia a medida que el redactor escribe.
Cree un nuevo libro en Docsie y añada algunos encabezados básicos y texto para un esquema. También puedes añadir tareas en el menú de la derecha, para dividir el trabajo en lotes más pequeños a medida que varios miembros del equipo colaboran en el contenido. El historial de versiones te permite volver atrás si un redactor añade un contenido que no es del todo bueno: ¡perfecto para escribir rápido e iterar a menudo!
Calendario para asignatarios de tareas en Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)
9 - Un índice para más lectores de contenido
Con documentación de guía de usuario compleja y diversa, una pared de texto puede ser intimidante para los lectores. Esto puede resolverse con una Tabla de Contenidos exhaustiva. Comúnmente utilizado en enciclopedias, ayuda a los usuarios a identificar y saltar a la información relevante, mientras que proporciona estructura a un entorno de portal de conocimiento.
Docsie Articles, Shelves y Workspaces funcionan para crear un Índice. Este se mostrará automáticamente en el lado izquierdo de su portal de conocimiento, proporcionando una manera fácil de navegar a través de su base de conocimientos. Con este consejo, Docsie lo hace por usted.
Tabla de contenidos generada automáticamente por Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_oxDNcw0pA6rCZa3J7/boo_dqsfhc7ObadQ3xWmV/35d48662-895e-b83f-c7c3-abb0ce6edd0dTableofContentsDocsie.png)
10 - Domine su materia
¿Es su escritor un experto en la materia? Del mismo modo, ¿es su escritor ingenioso y bueno investigando sobre temas con los que puede no estar familiarizado? En última instancia, a pesar de todos nuestros consejos, el escritor dicta la calidad de sus guías de documentación de usuario.
Cuanto mejor conozca su producto, más preciso será su trabajo. Permita a los redactores la flexibilidad de probar y romper su producto, ya que los usuarios pueden encontrarse con problemas similares. Mejor aún, guíe a su redactor a través de una demostración del producto con su equipo de ventas y proporciónele experiencia práctica con el canal de ventas y los mensajes que contiene. De este modo, se fomenta la coherencia y se convierte a los redactores en usuarios. No todos los redactores se convierten en usuarios, pero todos los usuarios pueden convertirse en buenos redactores con conocimientos prácticos.
Ponga en práctica estos consejos en Docsie!
Gracias por leer nuestros 10 consejos para mejorar las guías de usuario. Le invitamos a aplicar estos consejos a sus documentos Docsie.
Docsie es una plataforma integral de gestión de documentación que las empresas utilizan para crear preguntas frecuentes basadas en web, documentos de producto, guías de usuario, documentos de ayuda y manuales de usuario. La plataforma ofrece colaboración centrada en el cliente, amplia incrustación, traducciones a medida y una potente publicación al alcance de su mano.
Dé el paso incorporándose a Docsie hoy mismo y ofrezca a sus clientes una documentación que les encantará.