Si quiero escribir una instrucción sobre un software en inglés, ¿qué tipo de estilo e idioma se debe aplicar?

Aquí hay algunos consejos:

  • Sus instrucciones deben estar en primera persona. Diríjase al usuario / alumno como ‘usted’.
  • Tener un tono neutral.
  • Sea positivo en sus instrucciones.
  • No degrades al usuario / alumno.
  • No asuma el nivel de conocimiento que tiene el usuario sin un análisis adecuado.
  • No use términos coloquiales.
  • Estar al punto
  • No incluya ninguna de sus opiniones o preferencias personales.
  • Intente mantener cada acción del procedimiento en un paso separado para que sea más fácil para el usuario leer y aprender.
  • Agregue algunas capturas de pantalla si cree que el usuario se beneficiará de ello.
  • Mantenga sus oraciones cortas, es decir, entre 7-10 palabras.
  • Ponte en la piel del alumno y comprende qué tipo de información los beneficiará.

Espero que esto ayude.

Calcule el nivel educativo de su posible usuario. Escriba las instrucciones (las sugerencias de Nikhil Lobo son excelentes por cierto).

Una vez que tenga un borrador, busque a alguien en o justo debajo del nivel educativo al que apunta, un hablante nativo de inglés, pero que no sea un experto en este tipo particular de software. Siéntelos con el software y las instrucciones. Negarse a responder cualquier pregunta y ver qué tan lejos llega este usuario simplemente leyendo sus instrucciones. Donde se atascan es donde necesitas reescribir.

Esto no tiene nada que ver con el inglés, por cierto, es válido para cualquier otro idioma.

Usa el estilo de Chicago. Use solo una tercera persona. NO asuma conocimiento por parte del lector si está escribiendo instrucciones. Por ejemplo, si la PC necesita estar conectada, dígalo claramente. Si el usuario necesita hacer clic en un ícono específico, proporcione una imagen del ícono y diga si debe ser un clic derecho o izquierdo y cuántas veces hacer clic y qué tan rápido hacer clic.

La mayoría de los manuales de software que he visto tienen otros escritores de manuales de software como público objetivo. Eso está mal. Su audiencia debe ser la persona que utiliza no solo su software por primera vez, sino también una PC por primera vez. La persona que no necesita la información adicional la ignorará. La persona que lo necesita lo usará.