Principales errores que cometen los escritores primerizos de manuales de ayuda

¿Cuál es el peor error que puedes cometer como autor primerizo de manuales de ayuda?

Un buen manual de ayuda es fácil de usar y contiene instrucciones claras que los usuarios pueden encontrar y poner en práctica con facilidad. Pero si es la primera vez que escribes un manual de ayuda, crear uno bueno puede ser complicado, sobre todo si es tu primer proyecto de redacción técnica.
Interesantemente, todos los escritores de manuales de ayuda excelentes también fueron primerizos y cometieron varios errores en sus primeros intentos. Hemos recopilado estos errores, para que no tengas que cometer ninguno de ellos. Por suerte, puedes aprender de estos errores y crear un manual de ayuda excelente a la primera.

Estos son los 5 mayores errores que cometen los autores primerizos de manuales de ayuda:

1. Mala estructuración

La escritura técnica requiere una estructura más clara y sencilla que cualquier otra forma de escritura. La estructura es la disposición de la información en el manual de ayuda. Muchos autores primerizos de manuales de ayuda cometen el error de ponerse a escribir sin tener primero una estructura sencilla y clara. Cuando falla la estructura, a los usuarios les puede resultar difícil orientarse o encontrar respuestas fácilmente, lo que resulta aburrido.
Pero tu manual de ayuda no tiene por qué ser aburrido, lo único que tienes que hacer es crear una estructura sencilla. Esta es la manera de hacerlo:

Utiliza frases cortas y fáciles de entender. Cada frase debería contener una única unidad de información.
Asegúrate de colocar la información más importante al principio. Pon las respuestas que todos los usuarios necesitan antes que las que solo unos cuantos necesitan.
Coloca la información más solicitada antes que la información que solo hace falta de vez en cuando.
Agrupa elementos de información de la misma categoría.
Haz fácil el acceso a cada unidad de información de manera selectiva.

2. Escribir en voz pasiva

Puedes escribir tanto en voz activa como en voz pasiva. Como los manuales de ayuda siempre son instructivos, escribir en voz activa hace que sea más fácil para los usuarios entender la información que contienen. Muchos manuales de ayuda suelen pedir a los usuarios que ejecuten una o más acciones, y escribir estas instrucciones en voz activa facilita a los usuarios la comprensión de las mismas.

Escribir en voz pasiva puede hacer tu manual de ayuda aburrido, ambiguo o incluso engañoso. Esta es una buena razón por la que te recomendamos seguir estas mejores prácticas para escribir documentos de ayuda y manuales.

3. Escribir contenido vago

Una de las razones principales por las que las personas leen manuales de ayuda es para encontrar respuestas. Si la información de tu manual de ayuda está técnicamente vacía y carece de significado, habrás logrado crear un manual de ayuda vago con éxito. Para evitarlo, debes:

Presenta la información en forma de procedimiento paso a paso.
Explica a los usuarios del producto las funciones disponibles y para qué se utiliza cada una, no te limites a describir cómo utilizarlo.
Utiliza imágenes, diagramas y terminologías que resulten familiares para los usuarios del producto.
No escribas para impresionar a los usuarios, escribe para expresar soluciones y respuestas.
Ten claro para qué y para quién estás escribiendo.

4. Mala estructuración

Si la estructura de tu manual de ayuda es poco profesional y funcional, los usuarios pueden llevarse una mala impresión de tu marca y tendrás que gastar más en atención al cliente. Pero, ¿qué es exactamente la estructura de un manual de usuario? Es el modo en que se organizan los textos y las imágenes en cada página del manual.
Si tu estructura es demasiado colorida o abarrotada, puede distraer a los usuarios de la información en sí. Para evitarlo, utiliza colores contrastados, sombreados o fuentes en negrita para indicar importancia. Asegúrate de que las imágenes sean claras y fáciles de entender.
Si estás creando un manual de usuario online, comprueba que las fuentes que uses sean las más adecuadas para leer en pantalla (las mejores son las fuentes sans-serif). Comprueba que los usuarios pueden identificar fácilmente dónde se puede hacer clic y dónde no. Con tantos dispositivos inteligentes disponibles, hay muchas disposiciones y plantillas que tener en cuenta. No limites tu manual de ayuda a un solo tipo de archivo o versión. Estas son las razones por las que deberías crear versiones ePub y Kindle de tus manuales de ayuda.

5. Proceso inadecuado de creación de documentos

Muchos autores primerizos de manuales de ayuda crean su primer manual sin una herramienta de creación de ayuda (HAT). Suelen utilizar Microsoft Word porque ya lo usan para crear documentos. Me encanta Microsoft Word, ¡es un gran programa! Pero no es la herramienta adecuada para crear manuales de ayuda.
La manera más fácil de escribir un buen manual de ayuda es utilizar una herramienta de creación de documentación de ayuda. Con una HAT, podrás actualizar y reproducir el manual de ayuda prácticamente sin esfuerzo. La herramienta permite la publicación a partir de una sola fuente para generar diferentes formatos (PDF, CHM, HTML, Word, iPhone, eBooks, ePubs…) de tu manual a partir de una sola fuente. Además, puedes personalizar la apariencia y la estructura de tus manuales con facilidad.
Ya puedes empezar a sacar partido al software de creación de documentación de ayuda HelpNDoc. ¡Puedes descargarlo de manera absolutamente gratuita para uso personal y de evaluación!

La clave para crear un manual de usuario fácil de usar es asumir que los usuarios del producto no tienen ninguna idea en absoluto sobre cómo se utiliza el producto, algo que, con frecuencia, no es más que la verdad. Dicho esto, deberás simplificar tu contenido sin que resulte aburrido ni demasiado técnico para los usuarios.