Cómo escribir un gran manual de ayuda

Escribir un gran manual de ayuda consigue dos cosas: ayudar a los clientes a encontrar y utilizar las soluciones adecuadas fácilmente y reducir considerablemente los costes de atención al cliente de tu negocio.
Lo que es más, los clientes estarán más que dispuestos a recomendar tu producto y es fácil que los líderes de tu sector de negocio recomienden tu marca a otros expertos y a sus clientes. Esta es la razón por la que escribir un gran manual de ayuda es una de las mejores inversiones que puede hacer cualquier negocio.
Pero, ¿cómo se escribe exactamente un gran manual de ayuda?

Cómo escribir un gran manual de ayuda en 8 sencillos pasos

1. Define para quién escribes

¿Cómo de bien conoces a los usuarios de tu producto? Antes de empezar a escribir, define tu público objetivo investigando sobre sus preferencias de palabras y nivel de conocimientos técnicos. Si te diriges a expertos técnicos, tu terminología y términos técnicos deberían ser diferentes de los utilizados para escribir para usuarios primerizos del producto con pocos o ningún conocimiento técnico.

2. Incluye todas las secciones relevantes

Los grandes manuales de ayuda tienen varias secciones esenciales, como portada, tabla de contenidos, lista de figuras y tablas, introducción, capítulos, apéndice, glosario, índice y contraportada. Todas estas secciones no tienen por qué ser relevantes en tu manual de ayuda, por lo que tendrás que seleccionar cuidadosamente las que hagan tus manuales de ayuda más fáciles de usar.
Estas secciones esenciales nunca deben complicar las tareas en el manual, sino simplificarlas. Para ello, utiliza un formato consistente para cada sección y presenta cada una de ellas con un resumen muy breve de la tarea que se vaya a realizar.

3. Haz el contenido fácil de leer

En primer lugar, tendrás que separar las instrucciones o procedimientos de los materiales de referencia. Esto facilitará a los usuarios orientarse rápidamente por el manual. Cada proceso debe escribirse para ayudar a los usuarios a realizar tareas específicas.
Empieza identificando las tareas principales y después divide cada una de ellas en subtareas. Con frases cortas y palabras fáciles de entender para los usuarios, escribe una serie de pasos para enseñar a los usuarios a realizar fácilmente cada subtarea.
Explica a los usuarios las características y funciones del producto, y cómo utilizarlas. Indica importancia o énfasis a través de contrastes, colores o sombreados. No asumas que los usuarios van a entender todos los términos técnicos simplificados que menciones: tienes que crear un glosario de términos técnicos que expliquen el significado de cada término según su uso en el manual.

4. Habla directamente a los usuarios

Tu manual de ayuda no tiene por qué ser aburrido, por lo que debes utilizar siempre la voz activa al escribir y referirte a la segunda persona: tú, vosotros. Al pedir a los usuarios que hagan algo, utiliza el imperativo del verbo más relevante. Por ejemplo: “Elije la segunda opción del menú desplegable y haz clic en Intro.”

5. Divide tus textos

Dependiendo de los conocimientos técnicos de tu público objetivo, quizá tengas de dividir las grandes secciones de información en secciones más pequeñas mediante un proceso de fragmentación. Este proceso es diferente de la creación de subtareas. Si una subtarea contiene una gran sección de información que pueda resultar complicada para los usuarios, puedes dividirla en una serie de fragmentos. Esta es una de las mejores prácticas para escribir documentos y manuales de ayuda.

6. Usa adecuadamente las imágenes e ilustraciones

A veces lo único que necesitas son una o dos ilustraciones para simplificar a los usuarios la realización de una tarea con facilidad. Una de las razones por las que algunos usuarios de producto nunca leen los manuales de ayuda es por las aburridas murallas de texto que contienen. Puedes hacer tu manual fácil de leer y de entender utilizando adecuadamente imágenes e ilustraciones para explicar las tareas complicadas.

7. Corrige el manual

Un simple error ortográfico o gramatical basta para estropear una instrucción entera en un manual de ayuda. Una vez hayas terminado de escribir, corrige el manual y pide al menos a otras dos personas con conocimientos exhaustivos sobre el producto que lo corrijan también.

8. Escoge cuidadosamente el formato correcto de publicación

¿Cómo tienes pensado exactamente publicar el manual de ayuda? ¿PDF, Word, eBook ePub, archivo HTML de ayuda o copia en papel? La solución es fácil. Tendrás que elegir formatos de documento que hagan tu manual fácilmente accesible para los usuarios cuando lo necesiten y exactamente cuando lo necesiten.
Pero, ¿qué sucede si los usuarios tienen acceso a varios formatos de documento diferentes? ¿Realmente tienes que sufrir el proceso de crear varios manuales distintos para diferentes formatos? La solución es sencilla. Puedes sacar partido a HelpNDoc, a help authoring tool, que genera distintos formatos de documentación a partir de un solo archivo de origen. Lo único que tienes que hacer es crear un archivo de manual de ayuda y HelpNDoc lo convertirá en cualquier otro formato que quieras.

Escribir un gran manual de ayuda requiere precisión y ser capaz de prestar atención a todos los detalles. Aunque esto pueda parecer bastante lento al principio, puedes aprovechar las funciones de las herramientas de creación de documentación de ayuda para escribir mejores manuales en la mitad de tiempo.

Ver también...

Análisis de público en redacción técnica: cómo determinar correctamente los hechos [Featured]

Etiquetas: Formatos de documentación Trucos y consejos

Cómo escribir un gran manual de ayuda