5 errores a evitar al redactar documentación de ayuda

Errores a evitar al redactar documentación de ayuda [Featured]

¿Con qué frecuencia te pasas una eternidad buscando un archivo de ayuda para algo que saber que debería estar ahí, pero eres incapaz de encontrar? La documentación de ayuda suele ser el primer lugar en que miramos cuando no sabemos cómo funciona algo. Si la información que hay en el archivo de ayuda no es fácil de entender, o peor, puede conducir a error, terminaremos frustrados y hasta rechazando el producto por algo que en realidad es más fácil de entender.

No escribir primero la tabla de contenido

Si estás escribiendo documentación de ayuda, esta debe explicar a fondo todos los aspectos de tu producto. Es importante no olvidar ninguna característica que tu usuario final deba conocer. La forma más rápida de asegurarte de incluirlo todo es empezar con un plan. Redacta tu índice de contenidos al principio haciendo una lista de todos los temas sobre los que debes escribir. Así podrás estar seguro de no dejarte nada fuera.

Asumir conocimientos que el usuario no posee

Uno de los problemas con gran cantidad de documentación de ayuda es asumir que todo el mundo llegar al producto con el mismo nivel de conocimiento. A menudo, la documentación está escrita para una clase particular de cliente en mente, cuando la realidad es que hay muchas personas diferentes utilizando el producto, todas con distintos niveles de conocimiento. La mejor documentación de ayuda explica cada procedimiento con claridad desde el principio, sin confiar en que los usuarios ya sepan algo.

No actualizar los documentos de ayuda

La documentación de ayuda que no se actualiza cuando cambia el producto a menudo es peor que inútil. No hay nada peor que intentar seguir unas instrucciones, solo para descubrir que nos piden que pulsemos un botón que no existe. Utilizar una buena herramienta de creación de documentación de ayuda puede ahorrar mucho tiempo en esta situación. HelpNDoc y otros programas similares simplifican la edición del índice de archivos de ayuda y permiten reescribir o cambiar secciones de texto de sitio sin tener que rediseñar el documento entero cada vez que realices cambios.

No tener un índice adecuado

Cuando un usuario acude a tu documento de ayuda con un problema, ¿qué es lo primero que miran? En muchos casos no empezarán por el principio y continuarán progresando hasta el final del documento. Empezarán por el índice y buscarán lo que dice sobre su problema. El índice es una herramienta vital en todos los documentos de ayuda, asegúrate de que sea lo más completo posible. Incluir sinónimos en el índice es una idea excelente, ya que a menudo se puede utilizar más de una palabra para describir un tema y así se facilita al usuario encontrar lo que quiere saber.

No permitir a nadie más comprobar o editar tu trabajo

Hasta si piensas que puedes crear la mejor documentación de ayuda del mundo, siempre es buena idea pedir a alguien que la lea y sugiera cambios. Todo el mundo tiene diferentes aproximaciones a un tema y es probable que otro par de ojos encuentre áreas que se pueden mejorar o explicar mejor.

Evitar estos cinco errores habituales mejorará la calidad de tu documentación de ayuda y también la experiencia de los usuarios de tu producto. Escribir una buena documentación de ayuda aumenta las probabilidades de que los usuarios se mantengan fieles a tu producto y en último término te permite crear una base de clientes más leal a tus productos.