9 consejos para una excelente documentación del usuario (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 proporcionaba a través de un archivo de ayuda que era local en la máquina del usuario o un manual o folleto físico. Esto significaba que no se podía actualizar o cambiar fácilmente y que los proveedores de software obtuvieron 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 la documentación del usuario y revisaremos algunos ejemplos de excelente contenido de asistencia al usuario.

Cree fácilmente una guía de usuario (plantilla gratuita)

Las plantillas de Snagit son la forma más rápida de crear guías de usuario. Cree guías paso a paso con un aspecto simple y profesional.

Descargar

lista de consejos de documentación de usuario impresionante

Empiece 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á asegurarse de hacerse a sí mismo (y posiblemente a quienes soliciten la documentación) muchas preguntas antes de comenzar.

1. Considere su 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, se ayuda a enmarcar la información que comparte.

2. Evalúe y tenga en cuenta su objetivo final

El propósito principal de cualquier documentación es enseñar 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 correcta de contenido para la tarea en cuestión.

3.Asegúrate de que la documentación del usuario sea fácil de encontrar

La documentación de usuario oculta es casi tan inútil como la documentación de usuario incorrecta. Es importante asegurarse de que la documentación del usuario que cree sea fácil de encontrar para quienes la necesiten.

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á tiempo al no tener que responder preguntas importantes pero comunes sobre su producto.

Escritura fuerte y concisa

La redacción sólida es esencial para una excelente documentación de 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 más importante, específicos. Escribir títulos o subtítulos que se formulan para responder una pregunta suele ser lo mejor. Enmarcar títulos de esta manera facilita a los usuarios finales encontrar lo que buscan y también le ayuda a escribir artículos que se dirigen directamente a las necesidades de los usuarios.

Rebote hace un trabajo fantástico al escribir títulos y subtítulos efectivos en toda 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 muy fácil.

5.Haz que navegar sea fácil

Proporcionar información de una manera que sea fácil de escanear ayuda a los usuarios a ahorrar tiempo. Como seres humanos, apreciamos cualquier ahorro de tiempo que podamos conseguir. Además, es posible que los usuarios no sepan exactamente lo que buscan. 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.Haga 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, probablemente no sea muy útil.

HubspotLa profunda base de conocimientos facilita el autoservicio para sus clientes.

Utilice elementos visuales para mejorar la comprensión

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

7. Utilice capturas de pantalla anotadas

Las capturas de pantalla anotadas son elementos visuales poderosos para usar en la documentación del usuario. Eliminan las conjeturas de 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 leyendas ordenadas a medida que 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 impresionante documentación de usuario, utilizan capturas de pantalla anotadas para guiar claramente a los clientes.

8. Aprovecha el video para mostrar, no contar

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

Luego, junto con el video, puede proporcionar una guía de texto paso a paso para que los usuarios puedan consultar mientras prueban el proceso ellos mismos. De esa manera, no tendrán que ver el video una y otra vez si solo necesitan un recordatorio rápido.

En nuestros tutoriales de productos de 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. Muestre 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ácilmente escaneable. Los elementos visuales como capturas de pantalla, videos o GIF animados son excelentes formas de comunicarse de manera más eficiente y efectiva con sus usuarios.

Cree fácilmente una guía de usuario (plantilla gratuita)

Las plantillas de Snagit son la forma más rápida de crear guías de usuario. Cree guías paso a paso con un aspecto simple y profesional.

Descargar

9 consejos para una excelente documentación del usuario (con ejemplos)

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *