Escoger el formato adecuado para publicar tus archivos de ayuda puede resultar complicado, especialmente si estás creando tu primer manual de ayuda y quieres evitar los mayores errores que cometen los autores primerizos de manuales de ayuda. El formato correcto permitirá a tus usuarios tener acceso a sus archivos de ayuda exactamente como y cuando lo necesiten.
Si estás utilizando una herramienta de creación de documentación de ayuda (y deberías, porque permiten redactar mejores documentos de ayuda en la mitad de tiempo), publicar en múltiples formatos no debería suponer ningún problema.
La gran pregunta a la que hoy damos respuesta es si deberías publicar un manual impreso (copia en papel) o un manual en pantalla (PDF, CHM, HTML basado en web, formato eBook…).
Manuales impresos
Es fácil asumir que los manuales impresos están pasados de moda y no son tan importantes. Pero los manuales impresos siguen siendo muy relevantes, especialmente para productos como lavadoras, automóviles, electrodomésticos, equipo de oficina, televisores, juguetes, muebles y otras categorías.
Los fabricantes de estos productos a menudo publican sus manuales de ayuda en formato impreso para que los usuarios no necesiten un dispositivo adicional para acceder a sus manuales. Además, al contrario que los manuales en pantalla, que requieren dispositivos que necesitan electricidad o batería como un PC o un smartphone, los manuales impresos no se quedan sin batería y nunca pueden quedarse sin electricidad.
Algunos usuarios de productos están más habituados a leer documentación impresa. Por ello, les parece más fácil leer guías de usuario en papel que pueden abrirse sobre una superficie plana. Además, algunos usuarios prefieren manuales impresos porque pueden escribir apuntes cortos o poner marcas en ellos mientras los leen. Lo que es más, si estás viajando a una zona remota con acceso a Internet poco sólido, tener un manual en papel es la mejor opción. Imagina las dificultades que tendrías buscando una señal para el teléfono para poder acceder al manual de ayuda de tu coche mientras estás de acampada…
Manuales en pantalla
Los manuales de ayuda en pantalla son manuales o guías de usuario a los que los usuarios pueden acceder en un PC o dispositivo móvil, como smartphones o tablets. Esta es una buena razón por la que deberías crear versiones ePub y Kindle de tus archivos de ayuda. Una ventaja clave de los manuales en pantalla frente a los manuales impresos es el uso de vídeos tutoriales. Como es más fácil aprender rápido si se hace visualmente, algunos fabricantes suelen crear tutoriales en vídeo para demostrar el uso de las funciones de sus productos.
Además, cuando los manuales de ayuda salen mal, los manuales en pantalla como manuales de ayuda basados en web son fáciles de actualizar. Los fabricantes pueden actualizar una o más secciones de sus manuales para tratar un problema específico dependiendo de la recomendación de atención al cliente. Pueden añadir fácilmente nuevas secciones sin tener que volver a imprimirlo todo. Adicionalmente, los manuales de ayuda están disponibles para todos los usuarios con independencia de su ubicación, siempre que tengan dispositivos móviles con acceso a internet. Los manuales impresos son engorrosos de transportar en el mejor de los casos, por lo que los manuales en pantalla son más convenientes para los productos móviles.
Además, los manuales online son más efectivos de enlazar a través de hipervínculos, lo que permite a los usuarios encontrar respuestas relacionadas o más información sobre lo que estén buscando. Al contrario que con los manuales impresos, los manuales en pantalla pueden encontrarse con facilidad mediante palabras clave en los manuales de ayuda o el nombre del producto. Los manuales en pantalla no ocupan espacio como los manuales impresos, ni se estropean con facilidad.
Impreso o en pantalla: ¿Cuál es el formato correcto para publicar tu manual de ayuda?
Hemos hecho un resumen rápido para ayudarte a decidir qué clase de manual de ayuda necesitas.
Tipo de producto | Impreso o en pantalla |
---|---|
Producto físico, como relojes | Ambos |
Solo descarga, como apps móviles | Solo en pantalla |
Productos móviles, como cámara | Normalmente en pantalla, pero a veces puede ser útil impreso |
Productos fijos, como fotocopiadoras | Normalmente impreso, pero a veces puede ser útil en pantalla |
Aunque la elección ideal depende del tipo de producto que vendas, la mayoría de los productos se beneficiarán de ambas clases. Con la herramienta de creación de documentación de ayuda correcta puedes crear un único manual de ayuda y publicarlo online y en papel. Dependiendo del tipo de producto para el que se haya hecho, el manual impreso puede incluirse con el producto, mientras que la versión online estará disponible para descargar en formato de vídeo, Word o PDF. De esa manera, los usuarios del producto podrán elegir: los que prefieran leer contenido electrónico pueden leer la versión online, mientras que los que prefieran un manual físico pueden leer la copia en papel.
Ver también...
Por qué los usuarios no leen tus manuales y cómo lograr que lo hagan
Has diseñado un producto prácticamente perfecto o creado un gran programa de software. Después, has contratado a algunos de los mejores escritores técnicos para escribir un manual de ayuda fácil de …
Lee Mas →Principales errores que cometen los escritores primerizos de manuales de ayuda
¿Cuál es el peor error que puedes cometer como autor primerizo de manuales de ayuda? Un buen manual de ayuda es fácil de usar y contiene instrucciones claras que los usuarios pueden encontrar y poner …
Lee Mas →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 …
Lee Mas →Cómo la IA está transformando el panorama de la redacción técnica
En el ámbito de la redacción técnica, la precisión de la comunicación es primordial. Tradicionalmente, los redactores técnicos se han enfrentado a una serie de retos únicos: transformar información …
Lee Mas →