esta es la forma de 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 bien elaborado y fácil de usar o una guía de usuario puede significar la diferencia entre una experiencia de cliente fantástica y una terrible.

y, la documentación del Usuario no es solo para nuevos usuarios.,

los clientes experimentados también pueden consultar manuales de usuario o guías de productos para refrescar sus recuerdos sobre una función que no han utilizado con frecuencia o para resolver un problema específico que puedan tener.

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 casi todos, de estos consejos también se aplican al ámbito del producto físico.

esto es lo que aprenderás:

• ¿Qué es la documentación del usuario y por qué es importante?
• Cómo la documentación del usuario final forma parte de la experiencia del cliente.,
• La buena documentación del 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 del usuario.
• Los cuatro pasos para crear documentación que deleite a sus clientes y resista la prueba del tiempo.

¿qué es la documentación del usuario?

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

Estos son los materiales didácticos que ir con el producto para ayudar a alguien a aprender a usarlo correctamente o — en el caso de los productos físicos — incluso de poner juntos.,

si alguna vez has ensamblado un mueble de Ikea, has utilizado la documentación del usuario final.

pero, la documentación del usuario toma muchas formas.

Los Videojuegos vienen con manuales para decirte 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 llenarlos correctamente.

Las cortadoras de césped y lanzadores de nieve tienen guías de productos para mostrarle cómo encender los motores y dónde recargar el combustible.

vaya a cómo hacer que la documentación del usuario

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

sabes que tu producto es genial. También quieres que tus clientes 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 se trate de cómo guardar un documento, arrancar un motor, utilizar una herramienta específica o información de seguridad importante, la documentación del usuario final es una parte importante de su relación con sus clientes.

puede deleitar a sus clientes

la documentación de usuario es fácil, ¿verdad? Quiero decir, solo escribe algunas cosas sobre cómo usar tu producto y ¡ya estás listo!

no Es tan simple.

es más que solo material «práctico». 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 geniales y horribles. Apuesto a que la mayoría de ustedes han tenido experiencias similares.

Un gran manual de usuario o guía de productos muestra a sus clientes que le importa no solo si compran su producto, sino si tienen una experiencia realmente genial usándolo.

y los clientes que sienten que te preocupas por ellos más allá de su billetera seguirán regresando a ti.,

si quieres que griten al mundo sobre lo mucho que aman tus productos y servicios, proporcionar documentación de usuario impresionante es una parte esencial de esa experiencia posterior a la compra.

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

La gente se pone en contacto con su equipo de soporte cuando algo no funciona, pero también llaman cuando simplemente no pueden averiguar 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 Gran documentación del Usuario no solo tiene que ser 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 llaman. Cuando incluye piezas esenciales, como una tabla de contenidos o un índice, pueden encontrar rápidamente la información que necesitan. Y, si se trata de un documento electrónico con capacidad de búsqueda, ¡eso es 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 al soporte cuando no pueden averiguar algo., Pero, si los clientes pueden averiguarlo 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 usar un teléfono o correo electrónico.

ahora, incluso la mejor documentación no eliminará todas estas llamadas, pero crear guías de usuario y manuales que sean completos, fáciles de entender, claros y concisos ayudará mucho a reducir el volumen general de llamadas, correos electrónicos, chats, etc.

¿cuáles son los elementos esenciales de una gran documentación de usuario?,

a pesar de que cada producto es único y requerirá diferentes elementos para crear documentos de usuario realmente excelentes, hay algunas prácticas recomendadas de documentación para el usuario final a seguir sin importar qué.,

La Gran documentación del Usuario debe incluir:

• Lenguaje Sencillo
• simplicidad
• visuales
• Un enfoque en el problema
• una jerarquía lógica y un flujo
• Una tabla de contenidos
• contenido buscable
• contenido accesible
• buen diseño
• comentarios de usuarios reales
• enlaces a otros recursos

lenguaje sencillo

nada frustrará más a un cliente que leer algo que no puede entender. Nadie quiere sentirse tonto., Hacer que su cliente se sienta de esa manera ciertamente no es una manera 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 frente a atrás es mucho más difícil de lo que podría pensar. Conoces todo tipo de jerga, acrónimos y otra información «privilegiada» que los clientes probablemente no conocen. ,

pero ahí es donde puedes tener serios problemas.

no asuma que su cliente sabe nada sobre 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. Escríbelo para ellos.

no escribas como si fueran niños,pero entiende que pueden necesitar ayuda adicional para ponerlos al día. Escriba la documentación de una manera fácil de leer.

Simplicity

manténgalo 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 páginas repletos 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 obtener ayuda que para tratar de resolver sus preguntas por su cuenta. Y es mucho menos probable que tengan una buena experiencia de cliente.

Visuals, visuals, visuals

La mejor documentación del usuario ilustra perfectamente el adagio » show, don’t tell.,»

el Contenido Visual, incluidas imágenes, capturas de pantalla anotadas, gráficos y videos, muestra rápidamente a alguien cómo funciona tu producto. No tienen que leer, ¡pueden verlo!

una investigación reciente de TechSmith muestra que las personas absorben la información visual más rápido y realizan mejor las tareas cuando se proporcionan instrucciones con contenido visual o de video.,

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

Las formas más 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 gráficos simplificados?, A veces llamada 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 su nombre indica — los simplifica. Esta versión más básica resalta la información más esencial al tiempo que reduce el texto y los gráficos que no son importantes para las formas más simples.,

Así, algo que se parece a esto:

Ahora se parece a esto:

Si yo estuviera tratando de mostrar a alguien cómo seleccionar Conectar el Dispositivo Móvil elemento de menú, en la segunda imagen, se elimina todo el desorden y permite que el cliente ojos para enfocar donde deben estar.

Lo más probable es que ya hayas encontrado gráficos simplificados y ni siquiera te hayas dado cuenta.,

como este de G Suite Learning Center:

hay muchas herramientas por ahí, pero si estás buscando formas potentes y fáciles de crear capturas de pantalla y grabaciones de pantalla, recomendamos descargar una prueba gratuita de SnagIt.

centrarse en el problema a resolver

cada producto resuelve un problema., Pero con demasiada frecuencia, estamos tan enamorados de nuestras características de productos geniales, 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 implicará características del producto, pero hágalo en el contexto de ayudar al usuario a llegar a la razón por la que compró su producto en primer lugar: para resolver un problema específico.,

por ejemplo, nuestros tutoriales de Camtasia y Snagit (sí, los videos tutoriales pueden ser una forma de documentación) resaltan características específicas, pero lo hacen en el contexto de por qué alguien podría usar esa característica. Se trata del por qué, no solo del cómo.

Aquí hay un gran ejemplo

jerarquía lógica y flujo

una buena documentación necesita una jerarquía de encabezados y subtítulos que le permita al usuario saber lo que cada sección les mostrará., 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 sus clientes cómo usar las funciones más avanzadas sin primero mostrarles los conceptos básicos de cómo funciona su producto. Comience con las cosas fáciles primero y luego, a medida que sus usuarios desarrollen sus conocimientos, muéstreles las funciones avanzadas.,

tabla de contenidos

una tabla de contenidos proporciona a sus clientes una forma sencilla, eficiente y familiar de encontrar rápidamente una solución a su pregunta o problema. Está justo al principio del documento para que no tengan que examinar páginas de texto para encontrar lo que están buscando. Debería incluir todos los encabezamientos y subtítulos principales descritos anteriormente.

que se pueda buscar

hubo un tiempo cuando la mayoría de la documentación de usuario impreso., Ahora, en una era donde 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 veremos en más detalle a continuación.

Al igual que una tabla de contenidos, el contenido con capacidad de búsqueda ofrece a los usuarios un acceso más fácil a su contenido y les ayuda a encontrar soluciones por su cuenta.

Accesibilidad

Crear contenido accesible., Esto significa garantizar que la documentación electrónica cumpla con los estándares de accesibilidad para las personas que pueden ser ciegas o con discapacidad visual, sordas o con problemas de audición, o que pueden 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

dé a sus usuarios un documento que quieran ver y será más probable que lo usen.

diseñe materiales pensando en sus clientes. Hacer usable y amigable., Evite párrafos largos de texto o páginas que estén demasiado llenas de contenido. Permita que el espacio en blanco ayude a romper la monotonía y haga 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 decirle a sus clientes cómo usar su producto. Para la documentación electrónica, utilice video y gifs.

utilice fuentes coherentes y colores complementarios en varios documentos. Si su organización tiene una guía de estilo (lo cual le recomiendo encarecidamente), asegúrese de que su documentación se adhiera a ella.,

Snagit templates hace 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 e imagen de plantilla y ya está en su camino.

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

comentarios de usuarios reales y/o probadores beta

no puedes crear una documentación de usuario realmente excelente hasta que hayas escuchado a las personas fuera de tu organización que realmente usan los productos.,

conozca sus puntos débiles y trate de abordarlos lo mejor que pueda. Averigüe lo que le dicen que necesitan saber para utilizar mejor sus productos. Si bien algunas de ellas pueden ser obvias, te garantizo que aprenderás cosas que ni siquiera consideraste.

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 mayor soporte.

¡Bonus! Agregue instrucciones paso a paso

Las guías paso a paso ayudan a evitar bloques largos de texto y proporcionan una forma mucho más clara de mostrar un proceso que intentar 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 súper fácil de usar que le ayuda a crear una gran 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 facilitar la edición y el marcado.

Cómo crear una gran documentación de usuario

Paso 1: Plan de

Cada gran conjunto de documentación del usuario comienza con un plan., Aquí hay algunos consejos sobre cómo llegar a donde vas.

sepa por dónde empezar

muchas personas asumen que si conoce su producto, puede comenzar a crear su documentación, pero hay mucho más que incluye. En su lugar, comienza con un plan para asegurarte de que realmente estás ayudando a tus usuarios.

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

• ¿Qué debe incluir? ¿Qué debería omitir? (Pista: ¡aquí es donde los comentarios de los usuarios pueden ser realmente útiles!)
• ¿En qué orden debemos presentar la información?, (Recuerde esbozos de ensayo de la escuela secundaria? ¡Úsalos!)
• ¿Qué otros recursos estarán disponibles? ¿Cómo proporcionaremos acceso / enlaces a ellos?
• ¿Quién es responsable de crear el documento? ¿Quién es responsable de los comentarios 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 sin problemas y un mejor documento de usuario.

Conozca su producto

asegúrese de conocer su producto.,

eso no significa que necesites ser el experto absoluto en todo, pero cualquiera 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 el conocimiento más profundo, sin duda, pero debe saber cómo usarlo usted mismo antes de intentar enseñar a alguien más.

Elija su formato

Además, un documento del formato final es igual de importante. ¿Será solo para imprimir? ¿Será electrónico? Si es así, ¿dónde vivirá?,

no hace mucho tiempo que casi toda la documentación del usuario solo se imprimía. Pero, a menos que tenga una muy buena razón, 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 lo quieren saber. Poner los recursos del 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 las personas con discapacidades. Una versión de solo Impresión funcionará para la mayoría de las personas, pero ¿está preparado para crear una versión en braille para los usuarios que pueden ser ciegos o con discapacidad visual? ¿Qué pasa con los usuarios que tienen una discapacidad física donde es difícil para ellos manipular objetos con sus manos?

Existen herramientas para facilitar el acceso de todos a la documentación electrónica, pero las versiones de solo Impresión presentan 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.

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

Paso 2: Cree su Documento de usuario

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

• evite la jerga y los Términos altamente técnicos excepto cuando sea absolutamente necesario (y luego asegúrese de definirlos).
• Evite los acrónimos a menos que explique lo que significan.
• Use un estilo de escritura comúnmente reconocido como AP o Chicago siempre que sea posible., Si tu organización tiene una guía de estilo de empresa, úsala.
• NO asuma que el usuario sabe nada sobre su producto o lo que hace. Muéstrales lo que necesitan saber para tener éxito.
• recuerde usar un lenguaje sencillo. Escribe para un nivel de OCTAVO GRADO. 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 quieran usar tu documentación.,

Paso 3: pruébelo

Una guía de usuario solo es excelente si ayuda a sus clientes a usar su producto de la mejor manera posible. Y no puedes saberlo hasta que alguien lo use. Antes de que tu nueva creación salga al mundo en general, quieres probarlo. Aquí hay algunos consejos!

• buenas prácticas: dáselo a un grupo de usuarios reales o beta testers y mira cómo lo hacen. Incorpore sus comentarios en el documento terminado.
• si no tiene comentarios de los usuarios de pruebas beta, pruébelo 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ñalar cosas que puede que te hayas perdido.

Paso 4: Mantenga su documentación actualizada

Cuando su producto cambie, necesitará todo actualizado. Como se señaló anteriormente, esto le da a la documentación electrónica una gran ventaja sobre la impresión. Sin embargo, incluso los documentos de solo impresión se pueden actualizar y poner a disposición para su descarga en su sitio web.

recuerda, tu contenido solo es genial si es preciso. Asegúrese de que lo que le da a sus clientes realmente les ayuda a usar su producto.,

resumen

si no recuerda nada más, tenga en cuenta que la gran documentación del Usuario debe crearse, diseñarse y presentarse de la manera que sea más útil para sus usuarios.

Dales documentación que les siga encantando y les proporcione el tipo de experiencia de cliente que te gustaría tener.

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

preguntas Frecuentes

Nota: Este post se publicó originalmente en agosto de 2019, pero se actualizó en septiembre de 2020 para mayor claridad e incluir nueva información.