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”.

El inglés técnico simplificado STE es fundamentalmente importante para redactar contenido claro y conciso, especialmente para instrucciones de usuario como manuales de mantenimiento, guías de usuario, guías de seguridad y otra documentación de ayuda. Puedes aprender a escribir un gran manual de ayuda utilizando el enfoque del inglés técnico simplificado.

Cómo utilizar el inglés técnico simplificado (STE)

La técnica de “pulgares arriba” comprende tres pasos clave para utilizar el inglés técnico simplificado. Estos pasos son:

  1. Determina cuál es la información importante y elimina la irrelevante.
  2. Comprueba el significado aprobado de las palabras en el Diccionario online STE Dictionary
  3. Cambia las frases utilizando palabras sencillas y fáciles de entender de acuerdo con las sugerencias del diccionario STE.

1. Determina la información importante y elimina la irrelevante

Mucho contenido instructivo como las advertencias o descripciones de tareas suele contener información irrelevante para explicar a los usuarios cómo completar una tarea.

Por ejemplo: Cómo instalar la versión 2.11 de software rápidamente en minutos sin perder tiempo.
Se puede cambiar por: Cómo instalar rápidamente la versión 2.11 de software.
Eliminar la parte de la frase “en minutos sin perder tiempo” no afectará para nada a las instrucciones.

El primer paso de la técnica de “pulgares arriba” es eliminar toda la información irrelevante y conservar únicamente la relevante. Una forma fácil de identificar la información irrelevante es hacerte esta sencilla pero lógica pregunta: “¿Necesita el usuario esta información o palabra para realizar esta tarea?” Si eliminar cualquier palabra o frase no afecta a la comprensión de cómo se realiza la tarea, eso quiere decir que no la necesitas.

2. Consulta el significado aprobado de las palabras en el diccionario online STE

El diccionario online STE contiene el significado aprobado de las palabras que hacen la documentación técnica más fácil de entender para los usuarios. Al crear documentación, es probable que utilices palabras cuyo significado no estás del todo seguro si es entendido o no por los usuarios.

Puedes utilizar el diccionario online STE como guía de verificación para asegurarte de que tu documentación sea fácil de entender para los usuarios. El uso de palabras aprobadas y no aprobadas se resume en las cuatro normas de redacción siguientes:

  1. Utilizar solo las formas de verbbos y adjetivos incluidos en el diccionario STE.
  2. Mantener el significado aprobado de una palabra en el diccionario STE. No utilizar la palabra con ningún otro significado.
  3. Elegir solo palabras incluidas en el diccionario.
  4. Usar las palabras aprobadas solo como parte del discurso determinado.

Al escribir tu documentación, puedes considerar el uso de una herramienta de creación de documentación de ayuda, o HAT como HelpNDoc, que incluye múltiples diccionarios para garantizar que el contenido sea todo lo perfecto posible.

3. Cambia las frases utilizando lenguajes sencillos y fáciles de entender, según las sugerencias del diccionario STE

Este paso se refiere a la aplicación práctica del primer paso del inglés técnico simplificado. En primer lugar, deberás determinar la información relevante en tu documentación y mantenerla. Elimina toda la información irrelevante. Puedes hacer dos cosas para convertir las frases de tu documentación en inglés técnico simplificado (STE).

En primer lugar, busca tus frases en el “Ejemplo Aprobado” del diccionario STE. Hay 66 Reglas de Redacción, y aunque no las conozcas todas, puedes copiar y pegar frases comunes similares de esta columna o emular su estructura para crear tus propias frases.

En segundo lugar, presenta la información fundamental con un lenguaje sencillo y fácil de entender. Sin embargo, crear documentación en un lenguaje controlado requiere un enfoque funcional. En la práctica hay reglas específicas para funciones de texto como instrucciones, resultados o mensajes de advertencia. Hay dos ejemplos clave de reglas funcionales de lenguaje controlado:

Ejemplo 1: Función de texto: Instrucción Patrón: Verbo (infinitivo) + artículo + objeto + signo de puntuación Ejemplo de texto: Hacer clic en el botón.

Ejemplo 2: Función de texto: Resultado Patrón: Artículo + objeto + verbo (tiempo presente) + signo de puntuación. Ejemplo de texto: Aparece la ventana del Informe de Gastos.

Los dos ejemplos presentan el contenido fundamental de la información, expresándolo en un lenguaje sencillo y fácil de entender. Tenlo en mente al modificar tus frases para adaptarlas al inglés técnico simplificado (STE).

¡Disfruta creando documentación!

Ver también...

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 …

Lee Mas →
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 …

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 …

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 …

Lee Mas →