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.

Como crear documentación online atractiva

Como crear documentación online atractiva

Es fácil asumir que el contenido es el único elemento por el que se preocupan los usuarios cuando utilizan documentación de ayuda. Pero esta conclusión está muy lejos de la realidad. El diseño es uno de los elementos más importantes de cualquier documentación online.
Una documentación visualmente atractiva, como una guía de usuario con imágenes relevantes y los vídeos adecuados incluidos, además de fuentes y temática en consonancia con el diseño de la página web, siempre resulta atractiva a la vista de los usuarios y resulta más fácil de usar.
Te presentamos 5 consejos fáciles para crear documentaciones online con atractivo visual que sean fáciles de usar.

Lee Mas →

Consejos para redactar guías de usuario online

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 escritos correctamente para resultar eficaces y fáciles de usar.
Al contrario que los manuales y guías de usuario en papel, a los manuales online a menudo se accede a través de dispositivos móviles como smartphones o tablets. Aunque no están limitados a tales dispositivos: descubre más sobre los mejores formatos para publicar tus archivos de ayuda.
Así pues, ¿en qué deberías pensar al escribir manuales y guías de usuario online? Volvamos a los fundamentos.

Lee Mas →

6 principios de redacción técnica para hacer tu documentación más fácil de usar

6 principios de redacción técnica para hacer tu documentación más fácil de usar

Una documentación fácil de usar es la documentación ganadora para cualquier escritor técnico. Pero crear una puede resultar complicado, sobre todo si estás escribiendo para un público diverso con diferentes ubicaciones e idiomas. Estos son algunos sólidos principios de redacción que te servirán de guía siempre que busques redactar materiales fáciles de usar por los usuarios.

Lee Mas →

Escribir documentación de software para usuarios finales: cómo hacerlo bien

 Escribir documentación de software para usuarios finales: cómo hacerlo bien

Una documentación de software efectiva ayuda a los usuarios finales que trabajan con el software a entender sus características, funciones y cómo realizar tareas específicas. Para los escritores técnicos, la pregunta es: ¿cómo puedes lograr exactamente todo esto al tiempo que escribes para usuarios finales con pocos o ningún conocimiento técnico? ¡Vamos a descubrirlo!

Lee Mas →

7 razones clave por las que necesitas una página web HTML dinámica

7 razones clave por las que necesitas una página web HTML dinámica

¿Te encantaría que tu página web tuviese un aspecto fantástico, con una experiencia de usuario más rica y asombrosa en todos los dispositivos, plataformas y tamaños de pantalla?
Es fácil llegara la conclusión de que necesitas una página web así debido a los usuarios de smartphones y tablets. Punto. Pero debes mirar más allá de los dispositivos actuales e imaginar dispositivos futuros como smartwatches, gafas Google, realidad virtual y aumentada o cualquier otro nuevo dispositivo que se les ocurra a los expertos. Las páginas web dinámicas y el desarrollo también funcionarán en ellos. Veamos lo importante que son las páginas web HTML dinámicas.

Lee Mas →

Por qué los usuarios no leen tus manuales y cómo lograr que lo hagan

 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 usar que resuelva problemas de uso. Quieres que los usuarios de tu producto empiecen a disfrutar del mismo desde el principio. Los escritores técnicos hicieron un trabajo fantástico y tu equipo de experiencia de usuario lo ha confirmado.
Pero después de lanzar tu producto o presentar una actualización, pareces estar gastando mucho más en atención al cliente. En muchos casos, las respuestas que buscan los usuarios están dentro del manual de usuario. Así que ahora te estás haciendo la misma pregunta que muchos fabricantes y desarrolladores: ¿Se leen el manual de ayuda alguna vez los usuarios de los productos?

Lee Mas →

Manual impreso vs en pantalla - ¿Cuál necesitas?

Manual impreso vs en pantalla - ¿Cuál necesitas?

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…).

Lee Mas →

Principales errores que cometen los escritores primerizos de manuales de ayuda

 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 en práctica con facilidad. Pero si es la primera vez que escribes un manual de ayuda, crear uno bueno puede ser complicado, sobre todo si es tu primer proyecto de redacción técnica.
Interesantemente, todos los escritores de manuales de ayuda excelentes también fueron primerizos y cometieron varios errores en sus primeros intentos. Hemos recopilado estos errores, para que no tengas que cometer ninguno de ellos. Por suerte, puedes aprender de estos errores y crear un manual de ayuda excelente a la primera.

Lee Mas →

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 →