Cómo construir la mejor documentación de usuario

Lo más probable es que si sus productos son más complejos que un rollo de toallas de papel, cree algún tipo de documentación de usuario para ayudar a las personas a aprender a usarlos.

Un manual de producto o guía de usuario bien elaborado y fácil de usar puede significar la diferencia entre una experiencia fantástica para el cliente y una terrible.

Además, la documentación del usuario no es solo para nuevos usuarios.

Los clientes experimentados también pueden consultar los manuales de usuario o las guías de productos para refrescar sus recuerdos sobre una característica que no han usado con frecuencia o para resolver un problema específico que tienen.

Para esta publicación, nos centraremos principalmente en las mejores prácticas para crear documentación de usuario para productos no físicos como el software, pero la mayoría (si no todos) de estos consejos también se aplican al ámbito del hardware.

Esto es lo que aprenderá:

• Qué es la documentación del usuario y por qué es importante.
• Cómo la documentación del usuario final es parte de la experiencia del cliente.
• Cómo una buena documentación de usuario puede ayudar a aliviar la carga de su equipo de atención al cliente.
• Por qué el contenido visual es el ingrediente secreto de la mejor documentación.
• Los elementos esenciales que aseguran la mejor documentación de usuario.
• Los cuatro pasos para crear documentación que deleite a sus clientes y resista el paso del tiempo.

¿Qué es la documentación del usuario?

La documentación del usuario (también denominada manuales de usuario final, guías de usuario final, manuales de instrucciones, etc.) es el contenido que proporciona a los usuarios finales para ayudarlos a tener más éxito con su producto o servicio.

Estos son los materiales instructivos que acompañan a su producto para ayudar a alguien a aprender a usarlo correctamente o, en el caso de productos físicos, incluso a ensamblarlo.

Si alguna vez armó un mueble de IKEA, usó la documentación del usuario final.

Sin embargo, la documentación del usuario toma muchas formas.

Los videojuegos vienen con manuales que te dicen qué botones presionar para disparar a los malos. La documentación del software le muestra lo que puede hacer su compra y cómo hacerlo.

Los formularios de impuestos vienen con guías sobre cómo completarlos correctamente.

Las cortadoras de césped y los sopladores de nieve tienen guías de productos que le muestran cómo encender los motores y dónde recargar el combustible.

Saltar a cómo hacer la documentación del usuario

¿Por qué es importante la documentación del usuario?

Sabes que tu producto es genial. Quiere que sus clientes también lo sepan. La documentación del usuario ayuda a garantizar que sus clientes o usuarios realmente aprendan cómo aprovechar al máximo su producto.

Ya sea cómo guardar un documento, arrancar un motor, usar una herramienta específica o incluso información de seguridad importante, su documentación de usuario final es una parte importante de su relación con sus clientes.

La documentación del usuario puede deleitar a sus clientes

La documentación del usuario es fácil, ¿verdad? Quiero decir, solo escriba algunas cosas sobre cómo usar su producto, ¡y listo!

No es tan simple.

Es más que material de "cómo hacerlo". Es parte de la experiencia del cliente. Y eso significa que también es material de marketing.

Como consumidor, he experimentado guías de usuario excelentes y horribles. Apuesto a que la mayoría de ustedes han tenido experiencias similares.

Un excelente manual de usuario o guía del producto les muestra a sus clientes que no solo le importa si compran su producto, sino también si tienen una experiencia realmente excelente al usarlo.

Los clientes que sienten que te preocupas por ellos más allá de su billetera seguirán volviendo a ti.

Si desea que griten al mundo cuánto aman sus productos y servicios, proporcionar una excelente documentación de usuario es una parte esencial de esa experiencia posterior a la compra.

Cómo la documentación del usuario apoya a su equipo de soporte

Las personas a menudo se comunican con su equipo de soporte cuando algo no funciona, pero también pueden llamar cuando simplemente no pueden resolver algo. Tener una excelente documentación de usuario ayuda a su equipo de soporte de dos maneras principales.

1. Les da una guía de referencia fácil

La excelente documentación del usuario no tiene que ser solo para los clientes. Su equipo de soporte de productos puede usar la documentación para ayudar a brindar un mejor soporte a sus clientes cuando solicitan ayuda. Cuando incluye piezas esenciales, como una tabla de contenido o un índice, pueden encontrar rápidamente la información que necesitan. Y, si se trata de un documento electrónico que permite realizar búsquedas, ¡aún mejor! Aprenderemos más sobre esto más adelante en el artículo.

2. Reduce las llamadas

Como se señaló anteriormente, las personas a menudo llaman a soporte cuando no pueden resolver algo. Pero, si los clientes pueden resolverlo por sí mismos, es mucho menos probable que necesiten ayuda. De hecho, más del 70 por ciento de las personas prefieren usar el sitio web de una empresa para obtener ayuda en lugar de obtener asistencia por teléfono o correo electrónico.

Incluso la mejor documentación no eliminará todas estas llamadas, pero la creación de guías de usuario y manuales que sean claros, completos y concisos contribuirá en gran medida a reducir el volumen general de solicitudes de soporte.

¿Cuáles son los elementos esenciales de una excelente documentación de usuario?

Si bien cada producto es único y requerirá diferentes elementos para crear documentos de usuario verdaderamente excelentes, existen algunas prácticas recomendadas de documentación para el usuario final que se deben seguir sin importar qué.

Una gran documentación de usuario debe incluir:

• Lenguaje simple
• Sencillez
• Visuales
• Un enfoque en el problema
• Una jerarquía lógica y un flujo
• una tabla de contenido
• Contenido de búsqueda
• Contenido accesible
• Buen diseño
• Comentarios de usuarios reales
• Enlaces a más recursos

Lenguaje simple

Nada frustrará más a un cliente que leer algo que no puede entender. Nadie quiere sentirse tonto, y el lenguaje que hace que su cliente se sienta de esa manera ciertamente no es una forma de fomentar una gran experiencia.

Utilice un lenguaje sencillo y sencillo siempre que sea posible para ayudar a sus clientes a comprender incluso los conceptos más complejos.

Recuerde, escriba para el usuario, no para el desarrollador.

Suena como una obviedad, pero escribir en un lenguaje sencillo sobre un producto o servicio que conoce de adelante hacia atrás es más difícil de lo que piensa. Conoce todo tipo de jerga, acrónimos y otra información "privilegiada" que los clientes probablemente no conozcan. Es natural que lo uses.

Pero ahí es donde puedes encontrarte con serios problemas.

No asuma que su cliente sabe algo acerca de su producto. No asuma que conocen todas las palabras de moda técnicas y/o de la industria que probablemente use todos los días dentro de su oficina.

No escriba como si fueran niños, pero comprenda que pueden necesitar ayuda adicional para realmente ponerse al día. Escriba la documentación de una manera fácil de leer.

Sencillez

Mantenga la documentación lo más simple posible para lograr su objetivo. Esto se aplica tanto al contenido del documento como a su diseño. Los largos bloques de texto y las páginas repletas de contenido escrito y gráfico pueden hacer que las guías de usuario o los manuales se sientan intimidantes y hostiles.

Los clientes que se sienten intimidados por sus materiales de usuario son mucho más propensos a llamar a su equipo de soporte para pedir ayuda que a tratar de resolver sus preguntas por su cuenta. Además, es mucho menos probable que tengan una buena experiencia de cliente.

Visuales

La mejor documentación de usuario ilustra perfectamente la frase "mostrar, no decir".

El contenido visual, que incluye imágenes, capturas de pantalla con anotaciones, gráficos y videos, muestra rápidamente a alguien cómo funciona su producto. No tienen que leer sobre esto: ¡pueden verlo!

Investigaciones recientes de TechSmith muestran que las personas realmente absorben la información visual más rápido y realizan mejor las tareas cuando las instrucciones se proporcionan con contenido visual o de video.

El contenido visual también ayuda a dividir largos bloques de texto y puede ayudar a eliminar gran parte del texto que hace que muchas guías de usuario o manuales se sientan intimidantes y desagradables.

Las formas populares de incluir contenido visual en la documentación del usuario incluyen capturas de pantalla, grabaciones de pantalla, videos tutoriales y más.

¿Has oído hablar de los gráficos simplificados? A veces llamado interfaz de usuario simplificada (o SUI), los gráficos simplificados toman imágenes de una interfaz de usuario u otro gráfico y, tal como sugiere el nombre, las simplifica. Esta versión más básica resalta la información más esencial mientras reduce el texto y los gráficos que no son importantes para formas más simples.

Entonces, algo que se parece a esto:

Ahora se ve así:

Si estuviera tratando de mostrarle a alguien cómo seleccionar el elemento de menú Conectar dispositivo móvil, la segunda imagen elimina todo el desorden y permite que los ojos del cliente se concentren donde deben estar.

Es probable que ya haya encontrado gráficos simplificados y ni siquiera se haya dado cuenta, como este del Centro de aprendizaje de G Suite:

Existen muchas herramientas, pero si está buscando formas poderosas y fáciles de crear capturas de pantalla y grabaciones de pantalla, le recomiendo que descargue una versión de prueba gratuita de Snagit.

Centrarse en el problema a resolver

Cada producto resuelve un problema. Pero con demasiada frecuencia, estamos tan enamorados de las características geniales de nuestro producto que todo lo que queremos hacer es resaltar lo que puede hacer en lugar de por qué nuestros clientes lo necesitan.

Asegúrese de mostrar a los usuarios cómo realizar tareas con su producto.

Naturalmente, esto involucrará las características del producto, pero resáltalas en el contexto de ayudar al usuario a llegar a la razón por la que compró tu producto en primer lugar: para resolver un problema específico.

Por ejemplo, nuestros tutoriales de Camtasia y Snagit (sí, los tutoriales en video pueden ser una forma de documentación) destacan funciones específicas, pero lo hacen en el contexto de por qué alguien podría usar esa función en particular. Se trata del por qué, no sólo del cómo.

Aquí hay un gran ejemplo...

Jerarquía lógica y flujo

Una buena documentación necesita una jerarquía de títulos y subtítulos que le permita al usuario saber qué le mostrará cada sección. Y esa jerarquía debe seguir un flujo lógico que ayude al usuario a aprender a usar su producto de la manera más útil.

Por ejemplo, probablemente no desee comenzar su documentación mostrando a los clientes cómo usar las funciones más avanzadas sin mostrarles primero los conceptos básicos de cómo funciona su producto. Comience primero con las cosas fáciles y luego, a medida que sus usuarios desarrollen sus conocimientos, muéstreles las funciones avanzadas.

Tabla de contenido

Una tabla de contenido proporciona a sus clientes una forma simple, eficiente y familiar de encontrar rápidamente una solución a su pregunta o problema. Está justo al principio del documento, por lo que no tienen que examinar páginas de texto para encontrar lo que buscan. Debe incluir todos los títulos y subtítulos principales descritos anteriormente.

Haz que se pueda buscar

Hubo un tiempo en que la mayoría de la documentación del usuario se imprimía. Ahora, en una era en la que casi todo el mundo tiene acceso a un teléfono inteligente, tiene más sentido crear documentación electrónica. Eso no significa que no pueda crear versiones impresas también, pero una versión electrónica ofrece una serie de ventajas que discutiremos con más detalle a continuación.

Al igual que una tabla de contenido, el contenido que se puede buscar brinda a los usuarios un acceso más fácil a su contenido y los ayuda a encontrar soluciones por sí mismos.

Accesibilidad

Crear contenido accesible. Esto significa garantizar que la documentación electrónica cumpla con los estándares de accesibilidad para las personas ciegas o con discapacidad visual, sordas o con problemas de audición, o que puedan tener discapacidades cognitivas.

Recuerde, muchos de sus clientes necesitan esto para comprender y acceder completamente a su documentación de usuario. ¡No los dejes atrás!

Buen diseño

Proporcione a sus usuarios un documento que deseen consultar y será más probable que lo utilicen.

Diseña materiales pensando en tus clientes. Hazlo usable y amigable. Evite párrafos largos de texto o páginas demasiado llenas de contenido. Deje espacio en blanco para ayudar a romper la monotonía y hacer que la perspectiva de aprender un nuevo producto sea menos desalentadora.

Incluya gráficos e imágenes tanto como sea posible para mostrar en lugar de decirles a sus clientes cómo usar su producto. Para la documentación electrónica, use videos y GIF.

Utilice fuentes uniformes y colores complementarios en varios documentos. Si su organización tiene una guía de estilo (que recomiendo ENCARECIDAMENTE crear si aún no existe), asegúrese de que su documentación se adhiera a ella.

Las plantillas de Snagit hacen que sea increíblemente fácil crear documentación de usuario de aspecto profesional a partir de una serie de capturas de pantalla u otras imágenes. Simplemente reúna las imágenes que necesita, elija Crear y luego Imagen de plantilla, y ya está en camino.

Snagit viene con un montón de plantillas gratuitas diseñadas profesionalmente, y con TechSmith Assets para Snagit, ¡tienes acceso a muchas más!

Comentarios de usuarios reales y/o probadores beta

No puede crear una documentación de usuario realmente excelente hasta que haya escuchado a las personas ajenas a su organización que realmente usan los productos.

Conozca sus puntos débiles y trate de abordarlos lo mejor que pueda. Descubra lo que le dicen que necesita saber para utilizar mejor sus productos. Si bien algunas de ellas pueden parecer obvias, te garantizo que aprenderás cosas que ni siquiera habías considerado.

Enlaces a otra documentación

Asegúrese de que sus clientes tengan acceso a más recursos de su organización sobre cómo tener éxito con sus productos. Para la documentación electrónica del usuario, esto puede ser tan simple como proporcionar enlaces a tutoriales, preguntas frecuentes, foros de usuarios y más.

Pero incluso la documentación impresa puede incluir cosas como direcciones de sitios web y números de teléfono para obtener más asistencia.

¡Prima! Agregar instrucciones paso a paso

Las guías paso a paso ayudan a evitar largos bloques de texto y brindan una forma mucho más clara de mostrar un proceso que tratar de explicarlo solo con texto. Son más fáciles de seguir, más fáciles de entender y ofrecen una experiencia mucho más fácil de usar que simplemente decirle a alguien cómo completar una tarea.

Y recuerda, incluir contenido visual en tus instrucciones paso a paso las hace aún mejores.

Snagit proporciona una herramienta paso a paso fácil de usar que lo ayuda a crear excelente documentación paso a paso. Además, la herramienta Combinar imágenes le permite combinar capturas de pantalla individuales y otras imágenes en una sola imagen para editar y marcar más fácilmente.

Cómo crear una gran documentación de usuario

Paso 1: Planificar

Cada gran conjunto de documentos de usuario comienza con un plan. Aquí hay algunos consejos sobre cómo llegar a donde quieres ir.

Sepa por dónde empezar

Mucha gente asume que si conoce su producto, puede comenzar a crear su documentación. Pero hay mucho más que va en él. En su lugar, comience con un plan para asegurarse de que realmente está ayudando a sus usuarios.

Antes de hacer la documentación, aquí hay algunas cosas a considerar:

• ¿Qué debes incluir? ¿Qué debes dejar de lado? (Sugerencia: ¡Aquí es donde los comentarios de los usuarios pueden ser MUY útiles!)
• ¿En qué orden debemos presentar la información? (¿Recuerdas los esquemas de los ensayos de la escuela? ¡Úsalos!)
• ¿Qué otros recursos estarán disponibles? ¿Cómo proporcionaremos acceso/enlaces a ellos?
• ¿Quién es el responsable de crear el documento? ¿Quién es responsable de la retroalimentación sobre el documento? ¿Quién tiene la aprobación final?
• ¿Será necesario traducirlo o localizarlo?

Las respuestas a esas preguntas dan forma a cómo crea su documentación. La planificación garantiza un proceso fluido y un mejor documento de usuario.

Conozca su producto

Asegúrese de conocer su producto.

Eso no significa que deba ser un experto absoluto en todo, pero cualquier persona que cree un manual de usuario o una guía de usuario debe tener experiencia práctica con el producto.

Confíe en sus expertos en la materia para obtener un conocimiento más profundo, pero debe saber cómo usarlo usted mismo antes de intentar enseñar a otra persona.

Elige tu formato

Además, el formato final de un documento es igualmente importante. ¿Será solo impreso? ¿Será electrónico? Si es así, ¿dónde vivirá?

No hace mucho tiempo que casi toda la documentación del usuario se imprimía únicamente. Sin embargo, a menos que tenga una muy buena razón, le recomiendo al menos tener una versión electrónica disponible en su sitio web.

La mayoría de los usuarios tienen acceso las 24 horas a teléfonos inteligentes, computadoras o tabletas, y están acostumbrados a encontrar todo lo que quieren saber cuando quieren saberlo. Poner los recursos de usuario en línea les da acceso dondequiera que estén, lo que significa que no tienen que buscar en cajones o archivadores para encontrar un manual de usuario que no han visto en años.

Además, es simplemente más fácil hacer que la documentación electrónica sea accesible para personas con discapacidades. Una versión impresa solo funcionará para la mayoría de las personas, pero ¿está preparado para crear una versión en braille para usuarios ciegos o con problemas de visión? ¿Qué pasa con los usuarios que tienen una discapacidad física donde les resulta difícil manipular objetos con las manos?

Existen herramientas para facilitar el acceso de todos a la documentación electrónica, pero las versiones solo impresas plantean un problema de accesibilidad mucho más difícil.

Además, la documentación electrónica es mucho más fácil de actualizar, ya que vive en la web.

¿Debo convertir mi documentación en PDF?

Si desea ofrecer una versión en PDF descargable de su documentación, está bien. Pero asegúrese de que también esté disponible en su sitio web en un formato que no sea PDF.

Paso 2: Crea tu documento de usuario

Una vez que haya respondido todas las preguntas y tomado todas las decisiones descritas anteriormente, es hora de crear su documentación de usuario. No voy a pretender decirle cómo EXACTAMENTE crear la documentación para su producto específico, pero hay algunas cosas clave que debe tener en cuenta.

• Evite la jerga y los términos muy técnicos excepto cuando sea absolutamente necesario (y luego asegúrese de definirlos).
• Evite las siglas a menos que explique lo que significan.
• Utilice un estilo de escritura comúnmente reconocido, como AP o Chicago, siempre que sea posible. Si su organización tiene una guía de estilo de la empresa, utilícela.
• No asuma que el usuario sabe algo sobre su producto o lo que hace. MUÉSTRALES lo que necesitan saber para tener éxito.
• Recuerda usar un lenguaje sencillo. Escribe para un nivel de octavo grado o inferior. Incluso para los lectores avanzados, el lenguaje simple conduce a un procesamiento más rápido y una mejor comprensión.
• El diseño debe ser agradable, no intimidante y atraer al usuario. Haz que QUIERA usar tu documentación.

Paso 3: Pruébelo

Una guía del usuario solo es excelente si ayuda a sus clientes a usar su producto lo mejor que puedan. Y no puedes saber eso hasta que alguien lo use. Antes de que su nueva creación salga al mundo en general, desea probarla. ¡Aquí hay algunos consejos!

• Práctica recomendada: dárselo a un grupo de usuarios reales o probadores beta y ver cómo les va. Incorpore sus comentarios en el documento terminado.
• Si no tiene comentarios de usuarios de pruebas beta, pruébelos internamente, preferiblemente con empleados que estén menos familiarizados con el producto.
• Obtenga comentarios de los desarrolladores e ingenieros. Conocen el producto mejor que nadie y pueden señalarte cosas que quizás te hayas perdido.

Paso 4: Mantén tu documentación al día

Cuando su producto cambie, deberá mantener actualizada la documentación del usuario. Como se señaló anteriormente, esto le da a la documentación electrónica una gran ventaja sobre la impresa. Sin embargo, incluso los documentos impresos pueden actualizarse y estar disponibles para su descarga en su sitio web.

Recuerde, su contenido solo es excelente si es preciso. Asegúrese de que lo que le da a sus clientes realmente los ayude a usar su producto.

Resumen

Si no recuerda nada más, tenga en cuenta que se debe crear, diseñar y presentar una excelente documentación para el usuario de la manera que sea más útil para sus usuarios .

Proporcióneles documentación que continúe deleitándolos y que brinde el tipo de experiencia del cliente que desearía tener.

Haga que su documentación sea accesible, útil y visual.

preguntas frecuentes