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 [Featured]

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 [Featured]

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 [Featured]

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 →

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

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

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 →

Cómo escribir un gran manual de ayuda

 Cómo escribir un gran manual de ayuda [Featured]

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 [Featured]

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 [Featured]

¿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 [Featured]

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 [Featured]

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 →