Formatos de documentación


Formatos de documentación generados mediante un programa o herramienta de creación de 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 →

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 →

Cómo crear documentaciones fáciles de usar con inglés técnico simplificado

 Cómo crear documentaciones fáciles de usar con inglés técnico simplificado

El idioma inglés es uno de los idiomas más utilizados para la escritura técnica. Pero el inglés es un idioma complejo, rico en giros, frases hechas, figuras retóricas, sinónimos, palabras ambiguas y términos que pueden resultar confusos para los hablantes de otro idioma o incluso los nativos. Esta es una de las razones clave por las que algunos usuarios no se leen los manuales de ayuda.
Al crear documentación, la mayoría de los escritores técnicos se enfrenta a la desafiante tarea de comunicar términos técnicos complejos con palabras, frases e instrucciones sencillas y fáciles de entender. En la mayoría de los casos, los esfuerzos del escritor técnico se miden en opiniones de usuarios.
Así que para crear documentos técnicos como manuales de usuario, archivos de ayuda, guías de usuario, etc. fáciles de entender y utilizar, la Asociación Europea de Industrias Aeroespaciales y de Defensa (ASD) desarrolló el inglés técnico simplificado (STE), también conocido como ASD-STE100 o la técnica de “pulgares arriba”.

Lee Mas →

Análisis de público en redacción técnica: cómo determinar correctamente los hechos

 Análisis de público en redacción técnica: cómo determinar correctamente los hechos

La efectividad de cualquier documento técnico depende de lo bien que el escritor técnico haya adaptado su contenido para atraer al público objetivo. Pero en muchos casos, adaptar el contenido a la audiencia objetivo no es lo más complicado.
El principal desafío consiste en identificar y analizar el público. Por este motivo, no es raro que los escritores se pregunten: “¿Cómo puedo adaptar el contenido para que atraiga a un público específico si ni siquiera sé cuál es?” Esta es una de las razones por las que los usuarios no se leen tus manuales.
Es posible que el análisis del público sea el factor individual más importante de la escritura técnica. Si se hace correctamente, permitirá al equipo de atención al cliente exhalar un profundo suspiro de alivio y se reducirán dramáticamente los costes de atención al cliente.
Pero, ¿qué pasa cuando no se hace correctamente? Pues que tendrás que gastar más en atención al cliente. Quizá hasta debas crear un nuevo manual, por no hablar del golpe para el nombre de tu producto como marca, especialmente si tus competidores lo están haciendo correctamente. Todo esto se puede evitar con solo analizar a tu público.

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 →

Cómo escribir un gran manual de ayuda

 Cómo escribir un gran manual de ayuda

Escribir un gran manual de ayuda consigue dos cosas: ayudar a los clientes a encontrar y utilizar las soluciones adecuadas fácilmente y reducir considerablemente los costes de atención al cliente de tu negocio.
Lo que es más, los clientes estarán más que dispuestos a recomendar tu producto y es fácil que los líderes de tu sector de negocio recomienden tu marca a otros expertos y a sus clientes. Esta es la razón por la que escribir un gran manual de ayuda es una de las mejores inversiones que puede hacer cualquier negocio.
Pero, ¿cómo se escribe exactamente un gran manual de ayuda?

Lee Mas →

Los 7 mejores formatos para publicar tus manuales de ayuda

 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.

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 →