Los 7 mejores formatos para publicar tus manuales de ayuda

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.

Siete formatos de ayuda a tener en cuenta

1. Copia en papel

Los fabricantes de productos y dispositivos de hardware como televisores, juguetes, vehículos, lavadoras, herramientas eléctricas, equipo de oficina, mobiliario, etc. a menudo publican una copia en papel de sus manuales de ayuda. Estas copias en papel a menudo se imprimen para que lo usuarios puedan utilizar el manual sin tener que recurrir a software ni dispositivos y consultarlo fácilmente siempre que lo necesiten. A veces hay versiones PDF disponibles en la página web del fabricante para que los usuarios puedan imprimir el manual si no tienen su copia en papel.

2. WebHelp

En apariencia, WebHelp es parecido a HTML Help, pero se ve en un navegador web y es compatible con todas las plataformas, entre ellas Windows, Linux, Mac OS X, Unix… WebHelp está diseñado principalmente para su uso en la web y en intranet.
Si publicas tu manual de ayuda en un formato WebHelp, podrás actualizarlo en cualquier momento sin tener que volver a publicar un manual físico. Los usuarios de tu producto siempre sabrán que están consultando la versión más reciente de tu manual de ayuda sin necesidad de contactar con atención al cliente. Esta es una buena razón para utilizar una herramienta de creación de documentación de ayuda, que permite generar documentación en múltiples formatos para poder reducir considerablemente los costes de atención al cliente.

3. HTML Help

Este archivo de ayuda es la versión de Microsoft de cómo debería publicarse la documentación electrónica. Principalmente, HTML Help es el formato de ayuda electrónica de la aplicación Windows. Si has creado una aplicación compatible con Windows, tendrás que considerar publicar tu manual de ayuda como HTML Help y se mostrará en el HTML Help Viewer. Con ello, podrás meter todo tu archivo de ayuda en un archivo CHM.

4. PDF y MS Word

Puedes publicar tus manuales de ayuda en formato PDF y Word, para poder distribuirlos rápidamente por e-mail o en la web. El archivo PDF se puede ver en cualquier ordenador, smartphone o tablet con un lector PDF. El archivo Word puede verse en ordenador, smartphone o tablet con Microsoft Word. Si publicas tus manuales de ayuda en formato PDF o Word, tus usuarios tendrán la opción de imprimir o descargar estos archivos con facilidad.

5. eBook ePub

La popularidad de los dispositivos inteligentes no paran de crecer y no va a disminuir en un futuro previsible. Por ello, no deberías limitar el acceso a tus manuales de ayuda a solo unas cuantas opciones. Puedes publicar tu manual de ayuda en formato eBook ePubb para que los usuarios de tu producto puedan usar un dispositivo Kobo eReader o Apple iOS (iPad, iPhone, iPod Touch), Nook… para acceder fácilmente al archivo. Quizá te interese aprender más sobre cómo publicar tus manuales de ayuda para la gran mayoría de los lectores electrónicos.

6. Vídeos

Puedes usar manuales de ayuda en vídeo para complementar cualquier otro formato de archivo de ayuda que hayas publicado. Un tutorial en vídeo corto y sencillo puede ** hacer un proceso complicado muy fácil de entender y de recordar**. Puedes subir tus vídeos a páginas populares de vídeos como YouTube o Vimeo, donde los usuarios puedan encontrarlos.

7. Archivos de ayuda incrustados

Puedes insertar archivos de ayuda directamente en tu producto para que los usuarios los encuentren fácilmente exactamente donde los necesitan. Si eliges esta opción, tus usuarios finales no tendrían que abrir ninguna ventana, navegador ni documento impreso para acceder al contenido de ayuda.
Si tu producto es un programa de software, toda la información que los usuarios necesitan estará disponible en el espacio de trabajo y a menudo incluirá ventanas emergentes con consejos, asistentes para tareas o paneles laterales con explicaciones. Pero si tu producto es un dispositivo como una lavadora, podrá imprimirse en el producto.

¿Cómo decidir cuál es el formato adecuado?

Así pues, ¿cuál es el formato adecuado para ti? Pues el que más ayude a tus usuarios. Así que deberías publicar tus manuales de ayuda en formatos de archivo que reflejen la naturaleza de su contenido, de tu producto y de los usuarios más probables. Si tu producto es una aplicación para móvil que los usuarios se descargan e instalan, tu mejor opción es ofrecer una versión web adaptada a móviles que los usuarios puedan consultar desde sus dispositivos móviles. Tampoco deberías dedicar esfuerzos a crear contenido para eBooks ePub si con un corto tutorial en vídeo puedes demostrar fácilmente cómo utilizar tu producto.

Ver también...

Cuando los manuales 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 …

Lee Mas →

Los documentos de ayuda ahora son más fáciles de escribir

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 …

Lee Mas →

¿Por qué deberías crear versiones ePub y Kindle de tus archivos de ayuda?

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 …

Lee Mas →

Consejos para redactar guías de usuario online

Los manuales y guías de usuario online son muy cómodos para los usuarios ya que les permiten acceder fácilmente desde casi cualquier parte. Por ello, las guías de usuario y manuales online deben estar …

Lee Mas →