Tengo que escribir documentos técnicos como manuales, informes y artículos de revistas.
Recientemente, me encuentro comenzando oraciones con «This » mucho del tiempo. Por ejemplo,
Despliegue una boya marcadora en la ubicación GPS del ancla y otra en la ubicación GPS del marco. Esto hace que la navegación sea mucho más fácil.
o
Los archivos de registro serán analizado para la configuración de calibración y otros metadatos. Este proceso puede tardar unos minutos en archivos muy grandes.
o
Si se han introducido pilas nuevas, se debe volver a calibrar el magnetómetro. Esta operación es similar a la recalibración que a menudo se requiere cuando se usa la brújula de un teléfono inteligente.
¿Estas oraciones son correctas o hay otras construcciones de oraciones que se leen mejor? ¿Debo aceptarlo y seguir adelante?
Comentarios
- Los documentos técnicos deben redactarse para mayor claridad, no elegancia o estilo. Creo que los ejemplos que proporcionó son claros y requieren menos procesamiento cognitivo que las alternativas. Le digo que siga con ellos y siga adelante.
- Hace que la navegación sea mucho más fácil. Eso haría bla. Eso hace que la navegación sea aburrida. De cierto, de cierto os digo que facilitaría mucho la navegación.
Respuesta
Hay una ventaja distintiva de seguir haciendo lo que ha estado haciendo hasta ahora.
Esto es que la repetición del patrón
Indique al lector que realice una acción,
inmediatamente seguido de
Descripción / comentario sobre el resultado y / o beneficio de la acción,
disminuye la carga cognitiva de sus lectores: no se les exige constantemente que realicen el trabajo adicional de interpretar una variedad de formatos de presentación y estructuras de oraciones para clasificar las instrucciones de las descripciones o para comprender sus relaciones mutuas.
La forma en que presenta actualmente la información para leer ers les permite saber de inmediato qué se espera de ellos y por qué.
El hecho de que una oración comience con «Esto» es en realidad una señal útil para sus lectores de que lo que está por seguir es probablemente una descripción o comentario sobre una acción que les acaba de pedir que realicen.
Este aspecto de la presentación del material es una forma importante en la que la documentación técnica se diferencia de la ficción literaria.
Dependiendo del estilo del escritor de ficción, parte del placer de leer ficción depende al sorprenderse con yuxtaposiciones inesperadas y pequeños acertijos, algunos de los cuales se crean o se vuelven más intrigantes al variar la forma en que se presenta el material al lector.
En su caso, está (o debería estar) apuntando para el resultado opuesto: la previsibilidad de su presentación y la claridad de la comprensión de sus lectores irán de la mano. La relativa brevedad de las oraciones y la repetitividad del formato en su documentación reducen el margen para crear ambigüedad no intencional.
Vale la pena soportarlo en min d una razón importante para evitar la ambigüedad en la documentación técnica: no solo es molesto, incluso puede ser peligroso o dañino si un lector se confunde al realizar una acción incorrecta (como energizar un circuito que no debe energizarse).
Comentarios
- @geometrikal – Es ‘ probablemente los celos de mis orejas puntiagudas y mi linda naricita.
- Una excelente respuesta @Erik Kowal. Es por eso que lo voté a favor 🙂
Responder
Casi cualquier palabra o frase puede usarse en exceso, pero nombrar un tema (agente, «personaje» o sujeto) en una oración y luego hacer referencia a él con esto en la oración siguiente es una excelente manera de ayudar a los lectores a través de un pasaje con claridad y facilidad. Es un ejemplo de un tipo principal de cadena de temas , un elemento estilístico vital de la mayoría de los buenos escritos.
Es posible que a veces pueda encontrar una mejor manera de redactar, generalmente alargando la oración anterior en una o más cláusulas; pero, especialmente cuando se trata de material complejo, menos oraciones largas puede ayudar a sus lectores a procesar. (No hay nada de malo con oraciones largas bien estructuradas, pero prefiero los pares de oraciones en sus ejemplos a cualquier forma en que se me ocurra combinarlos).
En la ficción con mucho diálogo, estamos A menudo encontramos muchas apariciones de la palabra dijo. No es mejor revisarlos automáticamente y tratar de reemplazar muchos de ellos con verbos alternativos ( llorar, murmurar, emitir etc.). Algunas palabras se repiten a menudo sin llamar la atención. Esto (!) Se debe a que realizan sus funciones previstas bien y en silencio.
Responder
Todas las oraciones me parecen bien. Pero si quieres deshacerte del «esto» al comienzo de la segunda oración, puedes reescribir un poco la primera oración.
Por ejemplo, en lugar de
Implemente una boya marcadora en la ubicación GPS del ancla y otra en la ubicación GPS del cuadro. Esto hace que la navegación sea mucho más fácil.
write
Implementar una boya marcadora la ubicación GPS del ancla y otra en la ubicación GPS del marco hace que la navegación sea mucho más fácil.
En lugar de
Los archivos de registro se analizarán para la configuración de calibración y otros metadatos. Este proceso puede tardar unos minutos en archivos muy grandes.
write
Analizar los archivos de registro para la configuración de calibración y otros metadatos puede llevar unos minutos para archivos muy grandes.
En mi opinión, el tercer ejemplo es probablemente el mejor dejó como lo citó.
Comentarios
- Como supongo que se dará cuenta, sus alternativas cambian el significado de los pares de oraciones originales. Su primer cambio pierde la función principal del original: dar instrucciones para desplegar. Su segundo cambio pierde la función principal del original: informar que ocurrirá un análisis.
- Para el primero, podría usar la voz pasiva: El proceso facilita la navegación. Sin embargo, no es la mejor de las oraciones. Para el segundo, ¿qué tal » Los archivos muy grandes pueden hacer que este proceso demore unos minutos «?