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 →

Escribir un manual de ayuda a menudo puede ser un proceso muy frustrante. Todo el mundo entiende que el objetivo final es crear un manual que ayude a los usuarios a solucionar sus dudas con tus productos y entender todas sus funciones. La dificultad estriba en cómo conseguirlo.. La mayoría de los autores habrán tenido la experiencia de quedarse mirando un papel o una pantalla en blanco, preguntándose cómo empezar su nuevo libro o artículo. Al escribir documentación de ayuda, el principal problema es decidir cómo tratar el tema.

Lee Mas →

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 →

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 →

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 →

Todos entendemos la importancia de una documentación de ayuda precisa y actualizada. El único modo de sacar el máximo partido a cualquier producto es leer el manual y aprender a utilizar correctamente todas sus funciones. Una dificultad a la que se enfrentan los desarrolladores de muchos productos es elegir los formatos en que deberían producir su documentación de ayuda. En el pasado, un manual impreso se consideraba suficiente para la mayoría de los productos. En los últimos años, el manual impreso a menudo se ha visto sustituido bien por un PDF o bien por una versión online, pero, ¿son estas realmente las mejores opciones disponibles?

Lee Mas →

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 →

¿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 →

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 →

En pocas palabras el software HAT son programas de creación de documentación de ayuda utilizados por escritores técnicos para desarrollar documentos de ayuda, manuales técnicos y soluciones de ayuda.

Por ejemplo, tomemos cualquier producto del competitivo mercado mundial de consumo de hoy en día - ya sea un coche, un electrodoméstico, un programa de software o cualquier tipo de producto que necesite instrucciones de operación, realización de operaciones o montaje por parte del consumidor. Sea el producto que sea, es muy frecuente encontrar una iniciativa “en la trastienda” impulsada por profesionales dedicados que ha permitido el lanzamiento con éxito de dicho producto para la venta..

Este es el caso (que nunca debe pasarse por alto) en el conjunto de documentación de ayuda para el usuario que normalmente acompaña al producto; con el objetivo final de maximizar el uso y la experiencia de las funciones por parte del comprador, además de disminuir costes de soporte para el productor. Unas instrucciones de usuario claras y eficaces a menudo pueden ser el factor diferencial en cuanto a la apreciación, fidelidad y aceptación del cliente, ya que con frecuencia “producen o impiden” el éxito de un producto.

Lee Mas →