Guía paso a paso sencilla¶

Así que finalmente decidiste escribir una guía de usuario sobre tu increíble producto.

Lo que uno descubre en 2021 es que crear una guía de usuario sigue siendo un proceso principalmente manual. Consigues la mejor aplicación disponible para crear tu guía y comienzas a organizar el contenido.

¿Cómo empezar? ¿Por qué empezar? ¿Por qué necesitas una guía de usuario (obviamente...)? Intentaré responder algunas preguntas comunes sobre la creación de guías de usuario y ayudarte a crear tu primera guía en Docsie, aunque puedes usar cualquier otra herramienta.

Razones y beneficios de crear una guía de usuario¶

Existen muchas razones para crear guías de usuario. Estas guías son extremadamente útiles y juegan un papel crucial en el mundo de los consumidores, dispositivos electrónicos, programas de software y todo tipo de productos tangibles o intangibles. Las guías proporcionan a tus usuarios instrucciones simples y paso a paso sobre cómo usar y/o ensamblar los productos.

Tus clientes necesitan conocer los productos que vendes, los servicios que ofreces o los métodos y procedimientos que deben seguir. Las guías ofrecen un proceso paso a paso donde tus clientes pueden aprender a usar y educarse sobre las diferentes características y funciones de tu producto.

Las guías de usuario adecuadas limitan la responsabilidad legal:¶

Las guías también limitan las responsabilidades por uso incorrecto de tus productos. Una guía de usuario es muy útil para productos que pueden causar lesiones potenciales o incluso la muerte como resultado de no usar o ensamblar el producto correctamente. Por ejemplo: dispositivos de alto voltaje, aparatos que generan fuego e incluso láseres requieren manuales extensos para proteger al cliente del uso inadecuado.

Las buenas guías de usuario ahorran tiempo:¶

Las guías de usuario de buena calidad comparten instrucciones sobre cómo usar tus productos, lo que puede ahorrar mucho tiempo a tu equipo técnico explicando cosas o a los equipos de ventas haciendo demostraciones. Muchos productos de software complicados requieren buenas guías técnicas para ayudar a sus clientes a aprender a usar sus productos con el mayor potencial. Los programas suelen estar llenos de muchas características, y tener las guías adecuadas para proporcionar información útil puede ayudar a largo plazo a retener clientes y ahorrar tiempo explicando cómo se deben usar los diversos aspectos del software y productos complejos.

Educar a tus clientes sobre los usos de tus productos:¶

Educar a los clientes sobre productos técnicos es muy importante. Sin guías adecuadas, tus clientes pueden confundirse con una avalancha de características ocultas y no saber cómo usar todo el potencial del producto técnico. Las guías permiten un proceso sencillo en el que tus clientes pueden aprender a interactuar con los diversos aspectos técnicos de tu producto y sentirse cómodos teniendo una guía a mano cuando necesiten profundizar. Esto eliminará el estrés de intentar descubrir las cosas sin una orientación formal escrita. Además, para productos peligrosos, las guías pueden proporcionar advertencias contra el uso indebido de manera peligrosa.

Qué hace que una guía de usuario sea excelente¶

Para empezar a crear una guía de usuario, necesitas entender qué problema estás intentando resolver para un cliente específico. Hacer una guía sobre todo acerca de todo la convierte en un desastre incomprensible que nadie entenderá, incluido su público objetivo. Si observas algunos de los mejores ejemplos de guías de usuario en línea, escritas por empresas excepcionales como Stripe o Slack, notarás un patrón particular.

Cada guía de usuario se enfoca en resolver un problema específico.

Entonces, ¿qué debería hacer cada guía? Debería centrarse en acciones simples que tu usuario pueda realizar siguiendo esta guía. No hay necesidad de complicaciones. Por el contrario, si te enfocas en abordar acciones simples y comunes que ayuden a tus usuarios a resolver problemas frecuentes con tu producto, conseguirás un conjunto de guías extraordinarias que tus clientes adorarán.

Veamos de cerca algunas guías de usuario para entender cuál es la estructura de una guía excepcional, para que podamos tomarlo como punto de referencia sobre cómo escribir una gran guía nosotros mismos.

¿Qué incluye una gran guía de usuario?¶

Veamos la guía de Gestión de Libros de arriba y definamos algunos puntos importantes.

Organizando tus guías de usuario¶

Usando Docsie para crear guías de usuario

Docsie tiene varias herramientas y características que te permiten crear excelentes guías de usuario. Primero, veamos cómo funciona Docsie. Docsie funciona bajo la premisa de libros, estanterías y colecciones.

Las colecciones se utilizan para aislar varios libros que quieres mostrar a diferentes tipos de clientes. Por ejemplo, esta colección se usa para mostrar solo a Usuarios de Negocios. Esto significa que seleccionamos solo 3 libros de todos los creados para mostrar a estos clientes específicos.

Esto es útil cuando tienes varios tipos diferentes de clientes que usan distintos niveles de tus productos. Esto se hace fácilmente en Docsie haciendo clic en los tres puntos junto a "Todos" y pulsando añadir.

Una vez que estás en la barra de herramientas de Colecciones de Docsie, puedes crear el nombre de tu colección y también elegir qué guías de usuario quieres en esta colección específica. La razón por la que esto es importante es porque diferentes clientes pueden necesitar conocer diferentes guías de tus productos, y esta herramienta te permite mostrar solo las guías específicas que necesitan ver.

Ahora empecemos a escribir tu primera guía de usuario con Docsie, esto se hace con el "Libro" de Docsie.

Piensa en un libro como tu guía de usuario o manual. Dentro de tu libro abierto verás el Editor, un lugar para crear 'Artículos' y Encabezados.

El editor en la parte superior, la capacidad de crear varias versiones e idiomas en la esquina superior izquierda y, por supuesto, secciones de "Artículos y subencabezados" a la izquierda.

El editor es fácil de usar, te permite agregar videos, imágenes y código con nuestro sencillo proceso de arrastrar y soltar. También te permite estilizar tu contenido como desees.

Los artículos son muy fáciles de crear; solo escribe tu título. En este caso el tipo es "¿Qué es Docsie?", pero puedes escribir lo que desees para el título de tu Guía de Usuario.

Para crear subsecciones en tus guías que aparecerán como 1.1, 1.2, etc., solo necesitas seleccionar la ubicación de tu texto y establecerlo como 'Encabezado'. Esto se hace haciendo clic en la H en la pestaña del editor.

Docsie también te permite crear varias versiones e idiomas de tus guías. Esto es muy útil y práctico para la localización y para hablar sobre varias modificaciones de las guías de tus productos.

Una vez que has preparado tus guías, las has redactado y estilizado con fotos que ayudan a explicar los diversos aspectos de tus productos y características, el siguiente paso es publicarlas.

En resumen, aquí están los consejos y trucos para crear una guía de usuario¶

La mayoría de los productos de software y técnicos son muy complejos y tienen múltiples facetas. Para abordar este problema al crear una guía para productos complejos, es buena idea dividir la información e instrucciones en partes más pequeñas. Básicamente, crear varias guías pequeñas y compilarlas en una configuración de manual de usuario.

Tus clientes no están familiarizados con tu producto o servicio. Cuanto más técnico sea tu producto, más descriptivas deberían ser tus guías en la etapa de creación. Las palabras y fraseología vagas no serán tus aliadas en este proceso. Sé lo más específico posible para que tu cliente pueda comprender incluso los aspectos más básicos de tu producto.

Una imagen vale más que mil palabras. Esto es cierto, especialmente para guías y manuales de usuario. Este paso es muy descuidado por la mayoría de las empresas, pero tener las fotos adecuadas o capturas de las características y aspectos de tu producto mientras los explicas en tus guías es muy importante. De esta manera, tu cliente puede entender a qué aspectos de tu producto te estás refiriendo.

Tus guías están diseñadas para ayudar a tus clientes a entender los diversos usos de tus productos. Explica las cosas de la manera más simple posible para que puedan comprender fácilmente sus diversas características y aspectos.