9 consejos para una documentación de usuario impresionante (con ejemplos)

La documentación del usuario es una parte importante del producto general entregado a su cliente. Ayuda a los usuarios finales a tener más éxito con su producto o servicio.

En el pasado, la documentación del usuario se entregaba a través de un archivo de ayuda que era local para la máquina del usuario o un manual o folleto físico. Esto significaba que no podía actualizarse o cambiarse fácilmente y que los proveedores de software obtenían muy pocos datos sobre cómo se usaba su contenido.

Hoy en día, la documentación del usuario casi siempre se ofrece en línea, lo que ha ayudado a los escritores técnicos a ser más imaginativos en la forma en que ayudan a los usuarios. Pueden recopilar datos, probar diferentes técnicas de aprendizaje, iterar más rápidamente y producir una experiencia de contenido más rica para los usuarios.

¡Ahí es donde entra esta publicación de blog! I

En esta publicación, exploraremos lo que puede hacer para mejorar su documentación de usuario y revisaremos algunos ejemplos de excelente contenido de soporte al usuario.

Comience con un plan

Como la mayoría de las cosas en la vida, es mejor comenzar con un plan, y la creación de la documentación del usuario no es diferente. Es por eso que querrás asegurarte de hacerte muchas preguntas a ti mismo (y posiblemente a quienes solicitan la documentación) antes de comenzar.

1. Considera a tu audiencia

¿Para quién estás haciendo esto? ¿El usuario final? ¿Un administrador de sistemas? ¿Este contenido solo se revisará internamente o también se verá externamente? Para quién está creando la documentación del usuario ayuda a enmarcar la información que comparte.

2. Evalúa y ten en cuenta tu objetivo final

El propósito principal de cualquier documentación es enseñarle algo a su audiencia. Después de determinar quién consumirá su documentación, querrá decidir qué quiere que obtengan de ella.

¿Cuál es la acción que le gustaría que su audiencia pudiera realizar después de revisar la documentación? Si tiene en cuenta la respuesta a esa pregunta, podrá proporcionar la cantidad adecuada de contenido para la tarea en cuestión.

3. Asegúrese de que su documentación de usuario se pueda encontrar fácilmente

La documentación de usuario oculta es casi tan inútil como la mala documentación de usuario. Es importante asegurarse de que la documentación de usuario que cree sea fácil de encontrar para aquellos que la necesitan.

Eso no solo significa asegurarse de que sea visible, sino que también significa que los usuarios pueden navegar dentro de su documentación técnica y encontrar rápidamente respuestas a sus preguntas.

Cuanto más rápido su audiencia pueda encontrar esas respuestas, más felices estarán. También le ahorrará el tiempo de tener que responder preguntas importantes pero comunes sobre su producto.

Escritura concisa y fuerte.

La escritura sólida es esencial para una excelente documentación del usuario. Pero la escritura afecta más que cómo se lee o suena la documentación del usuario. También puede influir en lo fácil que es navegar por la documentación del usuario.

4. Escribe títulos y subtítulos descriptivos

Asegúrese de que sus títulos sean útiles y, lo que es más importante, específicos. Escribir títulos o subtítulos que se formulan para responder a una pregunta suele ser lo mejor. Enmarcar los títulos de esta manera facilita que los usuarios finales encuentren lo que buscan y también lo ayuda a escribir artículos que aborden las necesidades de los usuarios directamente.

Unbounce hace un trabajo fantástico al escribir títulos y subtítulos efectivos a lo largo de su documentación de usuario. Esto hace que su documentación sea fácil de navegar. Cada artículo específico tiene su propia tabla de contenido, lo que hace que encontrar la respuesta a una pregunta en particular sea pan comido.

5. Facilite la navegación

Proporcionar información de una manera que sea fácil de escanear ayuda a los usuarios a ahorrar tiempo. Como humanos, apreciamos cualquier ahorro de tiempo que podamos obtener. Además, es posible que los usuarios no sepan exactamente lo que están buscando. Ahí es cuando el contenido fácil de navegar es más beneficioso.

IBM hace un buen trabajo al hacer que su contenido de ayuda sea fácil de navegar al organizar una tabla de contenido limpia y proporcionar temas relacionados.

6. Haz que sea fácil de buscar

Google nos ha enseñado que encontrar las respuestas a nuestras preguntas es tan simple como escribirlas en un cuadro de búsqueda. Su documentación de ayuda debe reflejar esta expectativa. Si su contenido de ayuda no se puede buscar, entonces probablemente no sea muy útil.

La base de conocimientos en profundidad de Hubspot facilita el autoservicio para sus clientes.

Use imágenes para mejorar la comprensión

Una buena documentación de usuario es muy visual. Si bien la escritura y el texto sólidos son esenciales para una excelente documentación del usuario, las personas aprenden mejor cuando también hay elementos visuales.

7. Usa capturas de pantalla anotadas

Las capturas de pantalla anotadas son imágenes poderosas para usar en la documentación del usuario. Eliminan las conjeturas para los usuarios al mostrar exactamente qué pasos deben seguir.

Con programas como TechSmith Snagit, es fácil agregar llamadas de texto, flechas y más a las capturas de pantalla. Por ejemplo, notará que estoy usando capturas de pantalla anotadas que hice con Snagit a lo largo de esta publicación de blog.

Si se siente inspirado, incluso puede probar la herramienta de pasos de Snagit, que le permite identificar partes de una imagen colocando llamadas ordenadas mientras señala y hace clic. Cada vez que hace clic para agregar otro paso, el número avanza automáticamente.

Una empresa que está haciendo un trabajo maravilloso al utilizar el poder de las capturas de pantalla en su documentación es Asana. A lo largo de su increíble documentación de usuario, utilizan capturas de pantalla anotadas para guiar claramente a los clientes.

8. Aproveche el video para mostrar, no contar

El video funciona bien para demostrar un proceso. Una gran cantidad de documentación de usuario impresionante combina el poder del video con instrucciones de texto. Por ejemplo, es una buena práctica usar un video corto para guiar rápidamente un proceso.

Luego, junto con el video, puede proporcionar una guía de texto paso a paso para que los usuarios la consulten mientras prueban el proceso por sí mismos. De esa manera, no tienen que mirar el video una y otra vez si solo necesitan un recordatorio rápido.

En nuestros tutoriales de productos TechSmith, usamos un video principal para brindar una descripción general completa de la función o el tema que estamos discutiendo. Luego, debajo del video, proporcionamos fragmentos acompañados de capturas de pantalla o GIF animados para reiterar los puntos principales del video.

9. Mostrar ejemplos y resultados finales

Los usuarios necesitan saber cómo se ve completar con éxito cada tarea. Proporcionar a los usuarios una captura de pantalla de un resultado final de ejemplo es una buena manera de demostrar el resultado ideal a su audiencia.

La excelente documentación del usuario facilita que los usuarios finales encuentren respuestas a sus preguntas, lo que crea usuarios felices y satisfechos.

Una parte clave de la creación de una excelente documentación para el usuario es proporcionar información clara y fácil de escanear. Las imágenes como capturas de pantalla, videos o GIF animados son excelentes formas de comunicarse de manera más eficiente y efectiva con sus usuarios.