Cómo crear un manual de usuario: de cero a héroe (guía completa)

¿No está seguro de cómo crear un manual de usuario para ayudar a sus clientes a obtener más valor de su producto?

Un manual de usuario es contenido que ayuda a sus clientes (o empleados) a usar su producto o servicio de manera efectiva. También puede verlo llamado guía del usuario, manual de instrucciones, manual del producto, etc.

Más allá de ayudar a sus clientes a usar su producto de manera efectiva, la creación de un manual de usuario de alta calidad también puede ayudarlo a reducir el servicio al cliente y las solicitudes de soporte porque los usuarios pueden resolver sus problemas sin comunicarse con el soporte.

En esta guía detallada, aprenderá a crear un manual de usuario que ayude a sus clientes a alcanzar el éxito.

Para que eso suceda, esto es todo lo que vamos a cubrir:

• Diferentes tipos de manuales de usuario.
• Dónde publicar su manual de usuario
• Cómo crear un manual de usuario

¡Vamos a profundizar en!

Diferentes tipos de manuales de usuario

Existen diferentes tipos de manuales de usuario, tanto de cara al cliente como de contenido interno.

Antes de comenzar, es importante comprender qué tipo de manual desea crear, ya que eso afectará la forma en que aborda el contenido.

Aquí hay un breve resumen de los diferentes tipos de manuales de usuario:

• Manual de usuario : un manual de usuario clásico que enseña a los usuarios cómo usar un producto.
• Manual de capacitación : un manual de capacitación enseña a los usuarios cómo realizar una determinada tarea o completar un determinado trabajo.
• Manual de operaciones : un manual de operaciones suele ser un manual interno que documenta las operaciones de su empresa.
• Manual de servicio : un manual de servicio se enfoca en enseñar a los usuarios cómo mantener adecuadamente un producto en diferentes puntos del ciclo de vida del producto.
• Procedimientos operativos estándar (SOP) : los SOP son manuales internos que enseñan a los miembros de la organización cómo completar correctamente ciertos procesos "de la manera correcta".

Para las instrucciones a continuación, nos interesa principalmente crear un manual de usuario público. Sin embargo, los principios básicos a continuación se aplicarán a cualquier tipo de manual de usuario.

Dónde publicar su manual de usuario

El lugar donde publique su manual de usuario dependerá del tipo de manual de usuario que esté creando.

Para los manuales de usuario orientados al cliente, casi siempre querrá publicarlos en su sitio web. De esa manera, los usuarios pueden acceder al manual desde cualquier lugar.

Además, publicar el contenido del manual del usuario en la web también le permite crear una experiencia más fácil de usar que con un manual del usuario físico, como agregar tablas de contenido en las que se puede hacer clic y sugerencias de búsqueda en tiempo real.

Sin embargo, para los productos físicos, es posible que desee incluir un manual de usuario físico como complemento de su manual basado en la web.

Para los manuales de usuario internos, normalmente querrá ocultarlos de la vista pública.

Una forma de lograr esto es hacerlos disponibles únicamente en la intranet de una empresa. Sin embargo, con tanta gente trabajando desde casa, esto puede ser difícil de hacer a menos que su empresa tenga su propia configuración de VPN.

En su lugar, puede considerar proteger con contraseña el contenido, ya sea solicitando al empleado que inicie sesión en una cuenta de usuario o simplemente agregando una contraseña para acceder a la página.

Para los manuales de usuario físicos, puede utilizar una herramienta de gestión del conocimiento dedicada para ayudarle a publicar manuales más complejos. O, para manuales de usuario más simples, puede simplemente escribir en Google Docs y publicar desde allí: nuestra colección de herramientas de escritura técnica tiene algunas herramientas útiles para facilitarle la vida.

Para publicar su manual de usuario en línea, puede usar la mayoría de la documentación o el software de base de conocimiento. Si desea una herramienta que pueda manejar tanto manuales de usuario internos como públicos, puede considerar el complemento Heroic Knowledge Base de código abierto para WordPress. Hablaremos de esto con más profundidad en el tutorial.

Aquí hay un ejemplo de un manual de usuario en línea de Heroic Knowledge Base (y sobre Heroic Knowledge Base):

Hablando del tutorial...

Cómo crear un manual de usuario en seis pasos

Ahora que tiene información básica, veamos cómo crear un manual de usuario, comenzando desde cero y llegando hasta un manual de usuario terminado.

1. Cree su(s) persona(s) de usuario

Antes de comenzar a crear cualquier contenido, desea comprender para quién es el contenido, lo que puede lograr mediante la creación de personajes de usuario.

Probablemente ya tenga una buena idea de quiénes son sus clientes, pero es útil escribir esto para enfocar realmente sus esfuerzos.

¿Porque es esto importante?

Bueno, aquí hay un ejemplo:

Hay una gran diferencia entre crear contenido técnico para ingenieros mecánicos y crear contenido técnico para usuarios no técnicos.

Para la mayoría de los productos, las diferencias no serán tan marcadas. Pero aún es importante comprender las personas de sus clientes para que pueda asegurarse de que su manual de usuario tenga sentido para las personas que realmente lo utilizarán.

2. Identifique los problemas clave y las metas

Una vez que comprenda quiénes son sus clientes, el siguiente paso es comprender qué intentan lograr con el manual de usuario que va a crear.

Es decir, ¿cuál es el objetivo final (o los objetivos finales) de las personas que leerán este manual?

Comprender esto es importante porque el propósito de su manual debe ser ayudar a sus usuarios a lograr ese objetivo de la manera más eficiente posible.

En algunos casos, este objetivo final puede ser algo específico. Por ejemplo, si tiene una herramienta de administración de redes sociales, podría ser "programar una publicación en las redes sociales".

En otros, podría ser un objetivo más abstracto, como "mejorar nuestros procesos de gestión de proyectos".

Para productos más grandes, puede haber varias cosas que el usuario está tratando de lograr, lo que nos lleva a la siguiente sección.

3. Crea una estructura lógica y una jerarquía

Ahora que comprende quiénes son sus clientes y qué quieren lograr, puede comenzar a trazar la estructura de su manual de usuario.

Desea crear una estructura que llevará a sus usuarios desde "cero" hasta lograr los objetivos finales que enumeró en la sección anterior.

Aquí hay algunos consejos para ayudarlo a hacer esto:

1. Piense en cómo ayudar a los clientes a comenzar a obtener valor de su producto lo más rápido posible.
2. Tome su propio conocimiento personal fuera de él. Obviamente, sabe mucho sobre su producto, pero sus clientes no tendrán ese nivel de conocimiento previo.
3. Asegúrese de cubrir cualquier problema común o detalles confusos que sus clientes puedan encontrar al intentar usar su producto. Estos deben abordarse lógicamente en los momentos en que es más probable que los clientes tengan problemas.

4. Escriba el contenido de su manual de usuario

Una vez que haya trazado su contenido, estará listo para comenzar a escribir.

Dependiendo del tamaño de su producto/organización, puede escribir todo usted mismo. O bien, es posible que deba colaborar con otros miembros del equipo para escribir el contenido.

Estas son algunas de las mejores prácticas generales del manual del usuario que debe tener en cuenta al escribir su manual del usuario:

• Utilice una plantilla para garantizar un formato uniforme . La creación de una plantilla formateada no solo acelera su trabajo, sino que también garantiza que cada artículo de su manual sea coherente con los demás.
• Incluya elementos visuales (imágenes y videos) para ayudar a los usuarios . Una imagen bien anotada o un GIF puede ser más útil que las instrucciones de texto independientes, sin importar cuán detallado y completo sea el texto.
• Utilice un lenguaje sencillo y evite la jerga . O, cuando la jerga sea completamente inevitable, asegúrese de explicarla.
• Manténgalo breve y al grano . Su objetivo con un manual de usuario debe ser cubrir completamente el tema, pero en la menor cantidad de palabras posible. No omita información importante, pero elimine despiadadamente cualquier contenido innecesario.
• Use viñetas y listas para las instrucciones cuando sea posible . El uso de una lista numerada o con viñetas puede facilitar a los usuarios el seguimiento de la guía. O, si necesita más detalles de los que permite una lista, puede hacer que cada paso tenga su propio subtítulo.
• Usa la voz activa . La voz pasiva puede ser especialmente confusa para las instrucciones de un manual de usuario. Es la diferencia entre "El producto se puede encender presionando el botón rojo" y "Puede encender el producto presionando el botón rojo". El último ejemplo (voz activa) es más claro y facilita que el lector se coloque en las instrucciones.

Finalmente, siempre es una buena idea probar las instrucciones del manual de usuario como si fuera un usuario primerizo.

Es decir, una vez que haya escrito un artículo, regrese y siga esas instrucciones paso a paso para asegurarse de que no se perdió nada.

5. Publica tu manual de usuario

Una vez que tenga su contenido, el último paso para publicarlo es publicar su manual de usuario para que esté fácilmente disponible para sus clientes.

La forma en que lo haga dependerá del tipo de producto que esté ofreciendo. Por ejemplo, es posible que desee incluir una versión física de su manual si está enviando productos físicos.

Sin embargo, no importa qué tipo de producto esté ofreciendo, querrá publicar su manual de usuario en línea para que las personas puedan encontrarlo fácilmente.

Para ayudarlo a hacer eso, puede usar la base de conocimiento/software de documentación.

Por ejemplo, con el complemento de WordPress Heroic Knowledge Base, puede publicar su manual de usuario utilizando el software de código abierto de WordPress.

Este enfoque de código abierto le otorga total propiedad y control sobre su plataforma, al mismo tiempo que brinda muchas herramientas útiles para ayudar a sus clientes a navegar su manual de usuario de manera más efectiva:

• Organización de categorías : puede organizar fácilmente su manual de usuario en categorías lógicas y ordenar esas categorías arrastrando y soltando.
• Sugerencias de búsqueda en tiempo real : si los clientes desean ir directamente a un tutorial específico, pueden comenzar a escribir en la búsqueda y ver sugerencias de búsqueda en vivo basadas en sus consultas.
• Tabla de contenido automática : el complemento generará automáticamente una tabla de contenido en la que se puede hacer clic para cada artículo del manual del usuario, lo que ayuda a los lectores a saltar directamente a la sección que es relevante para ellos.
• Textos destacados/formato fáciles: puede agregar fácilmente textos destacados y otros formatos para llamar la atención sobre los elementos clave de sus artículos.
• Widget de respuestas instantáneas : además de crear una página de manual de usuario dedicada en su sitio, también puede agregar un widget de respuestas instantáneas que permita a los visitantes explorar el contenido del manual de usuario desde cualquier lugar de su sitio.

Si desea ver aún más opciones de software que lo ayuden a publicar un manual de usuario, puede leer nuestras publicaciones sobre el mejor software de base de conocimiento y las mejores herramientas de documentación.

6. Actualice y revise su manual de usuario según sea necesario

Crear un manual de usuario no es un esfuerzo de una sola vez. En el futuro, deberá dedicar tiempo a revisar y actualizar su contenido.

Hay dos razones principales por las que podría necesitar actualizar su manual de usuario:

1. Agregó nuevas funciones a su producto o cambió el funcionamiento de las funciones/interfaces existentes.
2. Desea mejorar el contenido de su manual de usuario para que sea más útil.

La primera situación es obvia: si cambia su producto de alguna manera, debe actualizar su manual de usuario para tener en cuenta esos cambios.

Sin embargo, también es importante tener en cuenta la segunda situación. Por mucho que lo intente, probablemente no obtendrá todos los artículos del manual del usuario perfectos desde el primer día.

Para ayudar mejor a sus usuarios, querrá actualizar y revisar el contenido del manual de bajo rendimiento para que sea más útil.

Si publica su manual de usuario con una herramienta como Heroic Knowledge Base, incluye clasificaciones de utilidad de artículos integradas para que pueda ver fácilmente qué artículos necesitan mejorarse. Los usuarios también pueden dejar comentarios de texto sobre el artículo, que pueden indicarle partes específicas del artículo que no están ayudando tanto como podrían:

También es posible que le falten artículos sobre temas con los que los usuarios tienen problemas. Para ayudarlo a encontrar estos temas que faltan, Heroic Knowledge Base también incluye análisis de búsqueda incorporados para que pueda rastrear qué búsquedas no tienen resultados de ningún tema ( así como búsquedas generales en general ):

Cree su manual de usuario hoy

Aprender a crear un manual de usuario es importante si desea preparar a sus clientes para el éxito.

Con los consejos y las mejores prácticas en esta publicación, ahora debe tener el conocimiento que necesita para comenzar a usar su manual de usuario.

Para una manera fácil de publicar su manual de usuario en línea y ayudar a sus clientes a navegarlo, puede usar WordPress y el complemento Heroic Knowledge Base.

Heroic Knowledge Base facilita la publicación de sus artículos y los organiza según sea necesario. Además, sus clientes pueden aprovechar funciones útiles como sugerencias de búsqueda en vivo, tabla de contenido automática y más.

Comience hoy y publicará su manual de usuario en poco tiempo.

Si está interesado en crear documentación para mejorar el conocimiento interno de su empresa, también le puede interesar nuestro tutorial sobre cómo publicar un manual de capacitación para su personal.