Lenguaje sencillo con frases largas requeridas

Estoy tratando de crear documentación para una aplicación, y es para usuarios finales que usan teclado (no mouse) y un lector de pantalla.

Algunas de nuestras convenciones requieren que siempre usemos la frase completa como se muestra en la pantalla: si estamos hablando del cuadro combinado de categoría, pero la etiqueta dice "Por favor, elija una categoría:" [sic], eso es lo que tenemos que usar .

Otra convención es para los atajos de teclado: siempre tienen varias "palabras" de largo, ya que usamos espacios en blanco (o voy sin espacios) entre cada elemento. Entonces tenemos CTRL + INSERT + T para la lista de tablas.

Entonces, como habrás notado, tengo una tendencia hacia oraciones largas con muchas cláusulas. Estoy usando a Hemingway para revisar cada sección en lenguaje sencillo y estoy tratando de revisar las oraciones difíciles/muy difíciles.

El problema es que mis oraciones a menudo son muy largas y ¡no es mi culpa!

Si reemplazo una frase de varias palabras, ya sea un método abreviado de teclado o una etiqueta en pantalla con "xx", eso generalmente hace que la cuenta regresiva de palabras de la oración sea "aprobada".

¿Es esto "hacer trampa?" ¿Son estos "términos de arte" y está bien decir "Ctrl + INSertar + teclado numérico 6" se entiende como una "palabra"?

Si solo los atajos de teclado cuentan como 1 palabra, ya que los usuarios pueden conocerlos por otros usos del lector de pantalla (por lo que reemplazarlos mentalmente con "X" para una verificación de idioma simple está bien), pero la "casilla de verificación Enviar correo electrónico del sobre" todavía tiene contar como 4 palabras, ya que serían nuevas para el usuario? ¿O solo el primer uso dentro de una sección?

Nota: mi lugar de trabajo no permite el uso de la segunda persona, a pesar de que PlainLang fomenta los pronombres personales. Ya estoy "desperdiciando" palabras al tener que decir siempre "el usuario" en lugar de "tú".

Me gustaría saber si otros escritores técnicos tienen un consenso sobre cómo manejar estos conflictos.

Muchas preguntas aquí... ¿Es posible usar la segunda persona inferida , donde simplemente se omite "usted/el usuario"?
Sí, uso mucho de eso. "Presione insertar+f5, navegue con las flechas hacia abajo hasta la opción más precisa, luego presione Intro para activarla".
sí, esa es una oración larga... ¿Y esto es necesario cada vez?
Puede intentar engañar al software reemplazando los espacios en esas frases con algún carácter especial que normalmente no usa; como '^', que puede hacer un reemplazo global más tarde con un espacio (o un espacio sin interrupciones). Así que "CTRL^+^INSERT^+^T", y tal vez Hemingway lo cuente como una sola palabra.
Me pregunto si hay convenciones específicas para lectores de pantalla que deberían tener esto en cuenta. Esta pregunta se beneficiaría de la información de alguien que usa regularmente un lector de pantalla.
¿Sus herramientas admiten variables en la fuente? Y si es así, ¿Hemingway está contando desde la salida o desde su fuente?
Utilizo el espacio que no se rompe (ctrl+shift+barra espaciadora, o ^s cuando busco y reemplazo para conexiones de teclas de comando). Mi "herramienta" es simplemente Word, eso es todo lo que tenemos. Hemingway es solo una herramienta que estoy usando para contrarrestar mi tendencia a conectar todo en una frase monstruosa del siglo XIX. Solo estoy tratando de editar las cosas lo mejor que puedo antes de declarar este borrador "terminado" y enviarlo a revisión por pares y líder de equipo. (revisión por pares: solo 6 meses más de experiencia que yo. El líder del equipo tiene más de 12 años aquí, pero siempre está abrumado).
Además, todo el mundo dice que los borradores se marcan mucho, y me gustaría minimizar o evitar mucho de eso. (Tiendo a reaccionar emocionalmente de forma exagerada, aunque sé que no debería hacerlo). Este borrador tiene unas 40 páginas, si se cuenta la TOC y la locura del formato.
Acabo de hacer otra edición, esta vez impresa en papel, mientras seguía en otra computadora con una versión ligeramente diferente del lector de pantalla y leyendo en voz alta. (Afortunadamente, no hay nadie más en la oficina). Tengo mil millones de ediciones más. por supuesto.

Respuestas (1)

Es posible que te estés enredando con Hemingway, lo que quizás sea mejor para los escritores en prosa que para los escritores técnicos.

El propio Hemingway afirma:

Pero, ¿y si quiero romper las reglas?

Las reglas están para romperse. Si sabes lo que haces, no dejes que te detengamos. Vea nuestras sugerencias como eso.

Solía ​​escribir manuales de instrucciones para IBM y Sun Microsystems. Para los nuevos usuarios, intentaría emular el formato de un libro Dummies. Word 2007 for Dummies tiene un Look Inside para que veas cómo lo manejan.

Si no está limitado por el formato de la empresa, intente dividir los procesos con una explicación rápida, seguida de una lista numerada de comandos, con los clics y las pulsaciones del teclado en negrita y las explicaciones sin negrita. Como esto:

IMPORTAR UNA IMAGEN A UN DOCUMENTO DE MS WORD

Importar imágenes a Word es muy fácil, solo siga los siguientes pasos:

  1. Haga clic con el botón izquierdo en la opción de menú INSERTAR . Aparece un menú emergente.

  2. En el menú emergente, seleccione IMÁGENES . Aparece un menú lateral.

  3. En el menú lateral, seleccione IMAGEN DESDE ARCHIVO .

Separar cada método en listas numeradas evita oraciones largas y complejas con comandos incrustados en el medio. De oraciones cortas como esta, Hemingway debería aprobar.

He usado clics del mouse en este ejemplo, que simplemente cambiaría por comandos de teclado. ¡No conocía los comandos de teclado para este ejemplo!

HTH, pero dificil aconsejar mejor cuando no se todas las reglas que hay que cumplir.

Sin imágenes: estos usuarios tienen problemas de visión. Las cosas ya están numeradas y tan cortas como puedo hacerlas.
Entonces, ¿es posible que ya hayas hecho un gran trabajo y que Hemingway te esté haciendo dudar de tus propias habilidades?
Puede ser. No he hecho un documento técnico antes (aunque he enseñado escritura técnica), y nunca he tenido tanto tiempo para revisar/editar algo. Como instructor, era escribir y seguir (hojas de tareas) o dar algunos consejos en los comentarios de los estudiantes. No tenemos mucha colaboración en esta oficina, que es en parte lo que esperaba.
@April, ¿realmente no hay nadie en su oficina que pueda revisar su trabajo y asegurarse de que va en la dirección correcta? Si ya lo ha formateado de esta manera, tan simple como un libro de Dummies, siguiendo las pautas de la compañía, diría que ha hecho su trabajo. La única forma de saberlo con certeza es entregándolo y recibiendo comentarios. Pero me parece que lo estás pensando y analizando demasiado con herramientas como Hemingway. Es solo una herramienta para ayudarte, no para seguirla a ciegas. ¡Quizás deje un comentario aquí y háganos saber si estaban contentos con eso! Buena suerte.
Hice una edición de lectura en voz alta, así que encontré algunos errores (algunos de formato, algunos estaban mal redactados), pero más tarde lo declararé "hecho". Me he reunido un poco con una coguionista, pero ella tiene sus propios proyectos. Me dijo que el primer borrador no era lo que yo llamaría un primer borrador, pero que debería ser "lo más completo/correcto posible". (En parte, hice esta pregunta debido al impulso de preguntas de la etiqueta de la semana, no por pura ansiedad)
Lenguaje sencillo con frases largas requeridas
RespuestasAquíPolítica de privacidad1y, 0v