Errores que hay que evitar al escribir manuales de ayuda en línea
A pesar de lo importante que puede ser para ti tener listo un buen manual de ayuda en línea, puede ser bastante fácil que cometas algunos errores reales. Entre ellos se encuentran muchos problemas que pueden surgir simplemente porque no estabas prestando mucha atención a tu trabajo. Sin embargo, no es demasiado difícil evitar estos errores comunes si simplemente entiendes cómo se producen.
1. La dispersión de las frases
La dispersión de frases se produce cuando se utilizan frases extremadamente largas. Se trata de oraciones que a menudo se alejan del punto principal y acaban pasando a otros detalles o conceptos.
A veces, una frase extensa puede implicar más palabras de las necesarias. En otros casos puede suponer que se repitan elementos dentro de la misma frase.
La extensión de las frases añade más peso a una frase de lo necesario. Esto hace que el manual no sea fácil de seguir porque se soportan frases cansinas y difíciles de entender.
2. No organizar los datos
Los mejores manuales de ayuda en línea están siempre bien organizados. Tienen extensos índices y tablas de contenido. También se organizan fácilmente en una serie de secciones y divisiones que son fáciles de ordenar. Hay que mantener los datos organizados para que encajen bien en el manual. También le resultará más fácil añadir contenido cuando lo necesite.
Y lo que es más importante, los datos organizados son más fáciles de encontrar para los lectores. Sabrán que determinadas secciones de su guía pueden tener ciertos detalles que quieren utilizar. Debes utilizar este plan de organización con cuidado para tener más control sobre tus datos.
Es posible que quieras utilizar un mapa de tu información cuando prepares tu contenido la primera vez. Un buen mapa puede ayudarte a organizar tus datos y a saber cómo se van a distribuir. Asegúrate de que está cuidadosamente ejecutado y que la información es relevante para cada sección que tienes.
3. Ser excesivamente complicado
No puede dar por sentado que todas las personas que van a leer su manual van a entender lo que usted quiere decir. Hay que evitar la confusión y el exceso de palabras.
Además, los términos técnicos que tenga que utilizar deben estar cuidadosamente definidos. Esto es para evitar que el lector se confunda con los términos extranjeros que puedan aparecer.
Asegúrate de que tus párrafos también están revisados. No los hagas demasiado largos ni abarrotados. Mantener párrafos cortos ayuda a que el contenido sea más fácil de leer.
4. Uso de la voz pasiva
La voz pasiva suele dar la impresión de que no estás siendo directo con alguien. Dice que sólo tratas de abordar un problema u otro resultado antes de introducir realmente la solución. Tienes que introducir la solución primero y luego explicar lo que sucede.
Por ejemplo, en lugar de decir «La gotera se arregló con el pegamento», puedes decir «El pegamento ayudó a arreglar la gotera». Esta voz activa es urgente y crea una sensación directa dentro de lo que estás escribiendo.
5. Ser vago
A menudo, en un manual de ayuda en línea hay que ser muy específico. Esto puede implicar cuando necesitas que alguien vaya a un menú específico dentro de tu programa o qué entradas de código tienen que ser utilizadas.
No sea vago ni indirecto al hablar de soluciones. Sea lo más detallado posible, incluso si eso significa tomarse un poco más de tiempo para compartir su información.
Lo más importante es que te asegures de utilizar tantas palabras clave relacionadas con tu contenido como sea posible. Esto evita que su contenido sea vago y hace que todo sea más fácil de entender y utilizar por sí mismo. Si se hace correctamente, hará que su contenido sea más fácil de entender y menos complicado.
Ten cuidado al escribir un buen manual de ayuda en línea. Asegúrate de evitar los numerosos errores que suelen producirse al escribir para que tus datos sean fáciles de entender y tengan un aspecto profesional.