Trucos y consejos


Consejos, sugerencias e ideas para desarrollar y mejorar la redacción y producción de 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 →

Ventajas de obtener tus manuales y documentos de ayuda online para los motores de búsqueda

Ventajas de obtener tus manuales y documentos de ayuda online para los motores de búsqueda

Millones de usuarios de internet en todo el mundo están constantemente buscando respuestas y soluciones en internet a través de motores de búsqueda. Solo Google procesa 3.500 millones de búsquedas al día y 1,2 billones de búsquedas al año en todo el mundo. Estas enormes cifras no han pasado desapercibidas a varias compañías y negocios, que ahora hacen todo lo posible por adaptar su contenido a las búsquedas en motores de búsqueda.
Pero, ¿qué pasa con contenido técnico como manuales o documentos de ayuda? ¿Deberían las empresas y los escritores técnicos publicar sus sistemas de ayuda online en servidores que puedan ser accedidos e indexados por los motores de búsqueda? Y si lo hacen, ¿supone alguna ventaja respecto a otras compañías o escritores que no lo hacen? Vamos a averiguarlo.

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 →

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 →

5 capacidades esenciales que necesitas para convertirte en un gran escritor técnico

images/essential-skills-technical-writer.jpg

¿Cuál es la diferencia entre un gran escritor y un gran escritor técnico? Ambos son grandes escritores, pero uno de ellos ha dominado las capacidades esenciales necesarias para explicar y enseñar a utilizar a prácticamente todo el mundo cualquier producto que requiera cierto conocimiento técnico, con independencia de sus conocimientos tecnológicos.
Si eres escritor técnico o te interesa convertirte en uno, también es importante que domines las capacidades necesarias. Así que, para facilitarte la escritura técnica, hemos recopilado cinco de las capacidades más importantes que todo escritor técnico debe dominar para ser un profesional.

Lee Mas →