Herramientas de creación de documentación de ayuda


Una herramienta de creación de documentación de ayuda (HAT en inglés) es un programa de software utilizado por los escritores técnicos para escribir manuales y documentación de ayuda.

La documentación de ayuda no tiene por qué ser aburrida

 La documentación de ayuda no tiene por qué ser aburrida

Reconozcámoslo, hoy en día la documentación de ayuda tiene una imagen terrible. Casi todo el mundo con quien hablas tiempo tiene una mala impresión de los manuales de ayuda. Hay muchas razones para ello, estas son algunas de las más habituales:

  • No siempre tiene respuesta a las preguntas que buscas
  • No consigues encontrar la respuesta, aunque sabes que está ahí, en alguna parte
  • Es difícil orientarse por el manual
  • La documentación está anticuada
  • La documentación todavía no existe

Lee Mas →

¿Cómo benefician los programas de creación de documentación de ayuda a todo el mundo?

Los programas de creación de documentación de ayuda benefician a todo el mundo

Muchos autores de manuales de ayuda han descubierto que las herramientas de creación de documentación de ayuda o HAT son una gran manera de de redactar manuales rápida y fácilmente, así como otros documentos de ayuda. No mucha gente se para a pensar que el uso de los programas HAT en realidad beneficia a todo el mundo, incluyendo el fabricante del producto que paga por el manual y el usuario final del producto.

Lee Mas →

¿Debería utilizar Microsoft Word para crear la documentación de mi producto?

¿Debería utilizar Microsoft Word para crear la documentación de mi producto?

Microsoft Word es un programa de software increíble. Permite a los usuarios redactar rápida y fácilmente cualquier cosa, desde un trabajo escolar hasta una carta profesional. La mayor ventaja de Microsoft Word es su familiaridad para los usuarios, es un programa con la que la mayoría de nosotros hemos crecido, utilizándolo tanto en el colegio como en la oficina. Para muchas personas sigue siendo la opción natural a la hora de redactar cualquier cosa en un entorno profesional. Y en la mayoría de los casos Microsoft Word es perfecto, pero hay algunas aplicaciones, incluyendo la redacción de documentación de productos, para los que no funciona tan bien.
Hay muchas razones por las que Microsoft Word no es la herramienta adecuada para ayudarte a escribir la documentación de tu producto, estas son solo cinco de ellas.

Lee Mas →

Cuando los manuales de ayuda salen mal

cuando los manuales y documentos de ayuda salen mal

Casi todo el mundo tiene al menos una historia de terror relacionada con la documentación de ayuda. Puede ser un manual de ayuda escrito o traducido tan mal que es imposible de entender, o un producto acompañado de un manual para un modelo totalmente diferente, o quizá se trate de uno de esos manuales tan abarrotado de detalles que hay demasiada información y resulta prácticamente imposible encontrar rápidamente la respuesta que necesitas. Hay muchas maneras en que los manuales de ayuda pueden salir mal, pero en general se puede dividir en dos áreas principales:

  • El manual está anticuado o contiene la información incorrecta
  • El manual está mal escrito o es difícil moverse por él

Lee Mas →

Mejores prácticas para escribir manuales y documentos de ayuda

Escribir documentos de ayuda

Escribir documentación de ayuda puede ser un proceso complicado. Es necesario aprender a pensar como un usuario del producto, y no como un desarrollador. Como la persona responsable de redactar la documentación de ayuda, es muy probable que lleves cierto tiempo relacionado con el producto, y que estés muy familiarizado con su funcionamiento. Esto resulta útil a la hora de redactar documentación de ayuda, pero también puede ser una desventaja, ya que miras el producto con ojos diferentes a los de aquellos que lo ven por primera vez. Lo que a ti puede parecerte obvio puede ser un misterio total para alguien sin experiencia previa con el producto, ni conocimientos sobre el proceso de diseño.

Lee Mas →

Por qué escribir un manual de ayuda de calidad puede ser la mejor inversión que haga tu negocio

Atención al Cliente

Lanzar un nuevo producto requiere una inversión tanto de tiempo como de dinero, dos recursos que en general no abundan en los negocios. Siempre existen presiones para reducir costes y conseguir finalizar y preparar el producto para su venta lo antes posible.
A veces, al buscar maneras de mantener los costes al mínimo, puede resultar tentador pensar en el manual de ayuda como en un gasto extra que debería producirse al menor coste posible. Es creencia común que la mayoría de las personas deberían ser capaces de deducir por sí mismas cómo funciona un producto, y si tienen dificultades, siempre pueden llamar al centro de asistencia.
Este fallo de planteamiento puede muy bien ser uno de los mayores errores empresariales en la actualidad. Nadie puede negar que producir una documentación de ayuda adecuada puede suponer un coste, pero también debemos tener en cuenta el ahorro que puede aportarnos el manual de ayuda, o solo estaremos contemplando la mitad de la situación.

Lee Mas →

Escribe mejores documentos de ayuda en la mitad de tiempo

Documentos en la mitad de tiempo

Escribir documentación de ayuda puede ser un proceso muy largo. Si tu producto es complicado de explicar, no es inusual encontrar varios cientos de páginas de ayuda, y hasta un producto relativamente simple puede necesitar un manual que cubra entre 50 y 100 temas.
No es solo su longitud lo que hace que los documentos de ayuda puedan resultar complicados de escribir. Para que tu manual sea útil a tus clientes, debes asegurarte de que la documentación incluya todas las funciones del producto y que describa con exactitud todos los aspectos del producto, de un modo que resulte útil para tus usuarios finales.
Con tal cantidad de información que incluir, organizar tu documentación de ayuda y hacerlo en no mucho tiempo puede resultar un importante desafío para cualquier escritor técnico. Por suerte, hay un modo de escribir documentos de ayuda más rápido, incluir todo lo que necesitas explicar y además crear un documento profesional de alta calidad que se puede producir en múltiples formatos.

Lee Mas →

El manual para tontos para escribir manuales y documentos de ayuda

Escribir manuales y documentos de ayuda

Si nunca antes has escrito documentación de ayuda, intentarlo puede dar un poco de miedo. Los usuarios finales de tu producto confían en ti para que les ayudes a entender cada función del producto, y que continúen utilizando el producto depende del éxito que tengas en ofrecer respuestas a sus preguntas. Aquí te ofrecemos nuestro “manual para tontos” para escribir manuales y documentos de ayuda. Estos trucos te ayudarán a escribir documentos de ayuda que cubran todos los detalles que deben incluir de un modo fácil de entender para tus usuarios finales.

Lee Mas →

Usa una herramienta de creación de documentación de ayuda para reducir tus costes de atención al cliente

Un cliente feliz

¿Cuáles son los principales costes del producto para tu negocio? Todo el mundo sabe que crear un producto nuevo cuesta dinero. Hay costes asociados al diseño, las pruebas, la fabricación del producto, y también para hacer llegar el producto a los clientes. Hay que hacer todas estas cosas si queremos crear un producto que se pueda vender y que genere unos beneficios que permitan prosperar al negocio.

Lee Mas →

3 cosas que no sabías sobre las herramientas de creación de documentación de ayuda

Cosas que no sabías

Si alguna vez has intentado escribir cualquier clase de documentación, sabes que no es un proceso tan sencillo como pueda parecer a simple vista. Escribir manuales o documentos de ayuda de calidad lleva tiempo y gran cantidad de planificación para asegurarse de que todas las funciones del producto están correctamente explicadas. Muchos escritores técnicos han oído hablar de las herramientas de creación de documentación de ayuda y muchos hasta han pensado en probarlas, pero no tenían claro cuáles eran exactamente las ventajas de utilizar una herramientas de creación de documentación de ayuda en vez de un paquete estándar de procesamiento de texto. Hay tres maneras en las que una herramientas de creación de documentación de ayuda te puede ayudar a escribir mejor documentación de ayuda.

Lee Mas →