Solo hay una regla para elegir el mejor formato para publicar manuales de ayuda: elegir el formato que permita a los usuarios acceder fácilmente al manual cuando y como lo necesiten.
Un factor interesante es que los usuarios del producto tienen acceso a varios dispositivos, software y contenido digital como navegadores web, PDF o Microsoft Wor, además de dispositivos inteligentes como smartphones, tablets, lectores Kindle, iPads, ordenadores… la lista es casi infinita. Este es el motivo por el que escribir un manual de ayuda de calidad puede ser la mejor inversión que haga tu negocio.
Pero con una lista tan extensa, ¿cuál es el mejor formato para publicar tu manual de ayuda? Revisemos algunos de ellos.

Lee Mas →

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

Crear documentación de ayuda para productos tiene muchas similitudes con un proyecto académico típico. Un proyecto académico a menudo deberá:

• Hablar de un tema en profundidad, tratando cada aspecto del tema en profundidad
• Dividir un tema en secciones claramente identificables
• Incluir referencias detalladas que apoyen la conclusión del proyecto
• Proporcionar un índice completo que cubra el tema bajo discusión

Todas estas tareas se pueden gestionar mucho mejor en un software de creación de documentación de ayuda que en un paquete convencional de procesamiento de textos. Para redactar un proyecto académico en Microsoft Word, no queda otro remedio que empezar por el principio del tema y escribirlo todo seguido. Este enfoque convierte la redacción del proyecto en algo complicado y que requiere mucho tiempo.

Lee Mas →