¿Cómo debo responder a un supervisor/editor que piensa que mi redacción técnica es "demasiado conversacional"?

Un comentario que repitió varias veces fue que partes de mi texto sonaban "demasiado conversacionales". Creo que quería decir que no soné lo suficientemente profesional o académico.

Sería mejor pedir una aclaración en lugar de adivinar el significado.

También sugirió revisiones que aumentaron el número de palabras y la complejidad de las oraciones sin agregar ningún significado adicional. No estoy de acuerdo con esos comentarios y no me gustan las ediciones sugeridas, y he aquí por qué:

Eres exactamente como yo aquí. Tampoco estoy de acuerdo con la elaboración sin sentido.

Sin embargo, eso no significa que nunca haya una razón para elaborar. Ha guardado silencio sobre por qué se le sugirió dar más detalles. Tal vez el supervisor no te lo dijo, tal vez lo hizo pero no crees que sea relevante, tal vez subconscientemente lo omitiste de la pregunta, o tal vez lo omitiste intencionalmente.
No estoy aquí para juzgar; pero es imposible revisar los comentarios de alguien como significativos si no conocemos el problema que los comentarios intentan señalar.

Hay razones para elaborar una explicación:

• Razones legales
• Desambiguación que puede no parecerle necesaria, pero que puede ser útil para las personas que no tienen tanto conocimiento sobre el tema.
• Reformulación para evitar ciertas palabras que podrían confundirse con palabras clave en un tema relacionado tangencialmente (por ejemplo, evitar la palabra "clase" en una aplicación educativa de C#)

Tengo la sensación de que solo presentaste una parte del cuadro completo.

Creo que a veces (¿siempre?), el lenguaje sencillo es lo mejor.

Estoy de acuerdo con tu intención, pero no con tu afirmación. No siempre _ Esto depende mucho de quién sea su público objetivo.

• Para los legos, lo simple suele ser la mejor opción.
• Para los expertos, se debe privilegiar la precisión y la desambiguación, aunque eso suponga una mayor complejidad.
• Para los abogados y la documentación legal, la precisión pedante y la completa desambiguación es el estándar.

También creo que el estilo de escritura "académico" impenetrable de muchos científicos es una gran deficiencia: solo dificulta la comunicación entre los científicos y nos aísla del público, que no puede entender lo que estamos tratando de decir.

Todavía tengo que ver un solo documento que esté escrito de una manera que:

• Los profanos lo encuentran claro y comprensible.
• Los expertos lo encuentran lo suficientemente detallado como para confiar en él.
• Los abogados lo encuentran lo suficientemente desambiguado como para que no haya lagunas razonables.

Si hubiera un estándar de escritura que pudiera cumplir con todos estos requisitos, sería el único estándar de escritura en uso ya que no tiene inconvenientes.

Como escritor técnico, generalmente escribirá documentación para expertos. Los expertos generalmente no ven la simplicidad lingüística como la principal prioridad. Por lo tanto, la simplicidad no debe ser tu enfoque principal al escribir.

El mayor número de palabras, las estructuras de oraciones más complejas y la falta de significado adicional en las revisiones fueron una señal clara (al menos para mí) de que estaba tomando las cosas en la dirección equivocada.

Estás sobregeneralizando. La mayoría de las veces, la reducción de la complejidad de las oraciones conduce a un mayor número de palabras, y la reducción del número de palabras conduce a una mayor complejidad de las oraciones.

Si el supervisor agregara complejidad y cantidad de palabras al mismo tiempo, su retroalimentación obviamente no sería buena.

Sin embargo, volvemos a mi punto anterior de que solo estamos escuchando su versión de la historia. El nivel de detalle y la (aparente) falta de sentido común en los comentarios del supervisor no coinciden . Es probable que esté omitiendo una parte clave de la versión de la historia del supervisor (esto puede ser involuntario, no lo estoy acusando de nada).

Sé que hay espacio para la subjetividad, pero honestamente creo que las oraciones que elaboré son simplemente mejores, y no quiero tirarlas a la basura.

Nos dices que son mejores, pero no muestras tu punto. Dado que este problema depende en gran medida de si el supervisor tiene razón o no; Diría que es muy relevante incluir un ejemplo real para que podamos ver si sus comentarios tienen mérito.

Si tuviera que defender mi escritura, siento que estaría cuestionando sus propias habilidades de escritura y su autoridad en el lugar de trabajo.

En términos generales, pídales que expliquen los comentarios en lugar de discutir por qué los comentarios son incorrectos en su opinión. Pedir una aclaración no debe interpretarse como poner en duda las habilidades de la otra persona. En todo caso, pedir su explicación implica que él lo sabe mejor que tú .

Al mismo tiempo, me enorgullezco de mi escritura y quiero que mis documentos publicados lo reflejen.

El orgullo no debe tener un costo para la empresa. Si la versión del supervisor está objetivamente más en línea con las expectativas de la empresa, se debe elegir la versión del supervisor. Independientemente de si su versión fue solo marginalmente o notablemente peor.

No creo que debamos simplemente "aceptar" y dejar que ensucien nuestra escritura, especialmente si nuestros propios nombres estarán en el documento publicado.

Con la excepción de algunos casos marginales notorios, el cliente (en este caso, la empresa) obtiene el producto como lo desea. Si enfatizan que quieren que la palabra "computadora" se reemplace con "puterbox" en todo el documento, entonces esa es su elección.

Si la empresa hace demandas con las que usted personalmente no puede vivir (por ejemplo, diferencias ideológicas), entonces puede rechazar el proyecto; pero esto, por supuesto, tendrá consecuencias. Dependiendo de la empresa, esto puede verse como insubordinación y motivo de despido.

Cuando rechaza un proyecto, ya debería haber aceptado las consecuencias de su rechazo.

Comenzaré con una especie de confesión: he sido (ya menudo sigo siendo) un supervisor que sugiere cambios en informes técnicos, manuales de instrucciones y guías de funciones que parecen haber sido escritos en un estilo conversacional.

Vale la pena mencionar que existe una gran área gris entre el lenguaje oscuro y el conversacional. En algunos casos es tan distinto como el formal "establecer el parámetro" en oposición al conversacional "debe establecer el parámetro" (en cuyo caso el enfoque formal es más simple), o usar una voz pasiva en lugar de una activa ("los resultados fueron observado" en lugar de "observamos los resultados"). Si su supervisor está sugiriendo algo intrincado, debería ser posible eliminarlo sin volverse conversacional.

Pero a lo que esto realmente se reducirá es al conocimiento de la audiencia. Puede ser que su supervisor conozca el estilo de una casa o la audiencia prevista del estudio piloto, lo que sugiere que las personas que leen el estudio (que pueden incluir personas dentro de la organización) podrían responder mejor a un estilo más formal.

Si cree que la audiencia respondería mejor a un estilo menos formal, esta sería la línea de argumentación que probablemente sea más efectiva. Vale la pena presentar esto como algo positivo en lugar de concentrarse en los aspectos negativos al estilo de su supervisor; rara vez es un enfoque productivo en un entorno profesional.

Cuando escribí manuales de usuario y demás, para A Big Company, tenían una guía de estilo corporativo para redacción técnica.

Parte de él decía minimizar la "edad de lectura" o el "nivel de grado" del texto: maximizar su legibilidad. Había una herramienta, integrada en el software del procesador de textos, para evaluar la complejidad del texto.

Prefería oraciones más cortas.

Una de las razones que dio para preferir una gramática más simple fue que el inglés podría ser un segundo idioma para muchos lectores. Y de hecho, yo estaba trabajando en Italia. Incluso si el texto debe usar algunas palabras técnicas, puede ser directo y puede preferir palabras no técnicas más simples.

En resumen, existen pruebas de legibilidad automatizadas , que puede encontrar persuasivas o informativas; tal vez solo sean aproximadas, pero son independientes, impersonales, objetivas y baratas.

¿Cómo deberías responder? Eche un vistazo cuidadoso y crítico a su propia escritura y, de hecho, haga lo que su supervisor le ha sugerido.

Todos nos apegamos a nuestra propia escritura, elección de palabras, frases, etc. A los escritores (novelistas) a menudo se les aconseja que arraiguen sus frases favoritas y usadas en exceso y las eliminen. En lo que respecta a la redacción académica/técnica, la responsabilidad recae en el autor para que sea comprensible para el lector, y estoy totalmente de acuerdo en que se prefiere un lenguaje claro y conciso. Pero eso no significa que el estilo de escritura deba ser "hablador" o "informal".

Para ser honesto, suenas demasiado apegado a tu propio estilo de escritura; cuando comentarios como este regresan de un futuro revisor de su trabajo, ya sean trabajos académicos o comentarios de las personas que leyeron el informe, simplemente no puede discutir con ellos que están equivocados y usted tiene razón. Tiene que estar dispuesto a ceder y aprender de las aportaciones de los supervisores, editores, revisores, etc.

"Demasiado informal" es cómo, según mi experiencia, describiría la mayoría de los escritos de la mayoría de los estudiantes de pregrado y posgrado (eso, o demasiado grandioso). Aprender a escribir bien lleva tiempo, requiere retroalimentación y humildad. Si revisa como se sugiere, es probable que termine con un trabajo más sólido: esta es mi experiencia desde ambos lados de este escenario.

Ha habido cambios significativos en el estilo de la comunicación técnica en los últimos 20 años, y particularmente en los últimos cinco años, ya que los crecientes volúmenes de evidencia han demostrado que el lenguaje simple y amigable es más fácil de entender y más respetado por los usuarios.

Pero parece que su supervisor es un riguroso y la manera de convencer a un riguroso es citando una fuente autorizada. Así que aquí está esa fuente. Hay pocos trabajos sobre estilo de comunicación técnica mejor establecidos o más respetados que el Manual de estilo de Microsoft. Ese manual se ha sometido recientemente a una importante actualización para adecuarlo a la práctica y la investigación modernas. Puede encontrarlo en línea aquí: Guía de estilo de escritura de Microsoft

Estos son los diez mejores consejos de esa guía (consulte la guía para obtener detalles y ejemplos de cada consejo):

Use ideas más grandes, menos palabras: nuestro diseño moderno se basa en un minimalismo nítido. Más corto siempre es mejor.

Escribe como hablas: Lee tu texto en voz alta. ¿Suena como algo que diría una persona real? Sea amistoso y conversador.

Facilidad de proyecto: use contracciones: es, lo harás, eres, somos, vamos.

Vaya al grano rápidamente: dirija con lo más importante. Palabras clave de carga frontal para escanear. Haga que las elecciones de los clientes y los próximos pasos sean obvios.

Sea breve: brinde a los clientes la información suficiente para tomar decisiones con confianza.

En caso de duda, no escriba en mayúsculas: Predeterminado en mayúsculas al estilo de las oraciones: escriba en mayúsculas solo la primera palabra de un encabezado o frase y cualquier nombre o nombre propio.

Omitir puntos (y : ! ?): Omita la puntuación final en títulos, encabezados, subtítulos, títulos de la interfaz de usuario y elementos de una lista que tengan tres palabras o menos. Guarde los puntos para los párrafos y el cuerpo del texto.

Recuerda la última coma: en una lista de tres o más elementos, incluye una coma antes de la conjunción.

No seas espaciado: usa solo un espacio después de los puntos, signos de interrogación y dos puntos, y no espacios alrededor de los guiones.

Revise la escritura débil: la mayoría de las veces, comience cada declaración con un verbo. Edite lo que pueda y hay, hay, hubo.

Bueno, el primer paso sería obtener una opinión independiente sobre tu texto.

Todos los escritores, ya sean académicos o de ficción, suelen estar demasiado involucrados en su propia escritura para poder juzgarla objetivamente. Su supervisor podría estar en lo correcto en su evaluación de su escritura como "demasiado conversacional", y entonces la mejor estrategia para usted sería prestar atención a esa crítica y revisar su texto en consecuencia.

Entonces, el primer paso que daría es conseguir otro escritor experimentado (!) de su campo y pedirle que lea su texto. Señale a esa persona los pasajes criticados y pregúntele específicamente si está de acuerdo con la evaluación de que son "demasiado conversacionales".

Si esa segunda opinión está de acuerdo con la primera, aunque sea parcialmente, acepte la crítica de su supervisor y siga sus sugerencias. Si la segunda opinión está de acuerdo con usted, su curso de acción dependerá de la personalidad y el estado de su supervisor.

Si el artículo se publicará bajo su nombre (y no el de ellos también) y el supervisor es generalmente una persona de mente abierta y tranquila, dígales que no está de acuerdo, discuta su versión, trate de hacerles entender, y si no lo hacen, insista y envíe su versión del texto a la revista.

Si usted es el primer autor, pero su supervisor es el líder del grupo de investigación y será nombrado como el último autor (lo que significa su posición) y son del tipo dominante, entonces usted no es realmente independiente en su autoría, sino que escribe en su comisión, y la decisión final es de ellos, por mucho que eso pueda frustrarlo. En ese caso, acepte su dependencia y siga sus consejos.

Construir una carrera académica requiere una habilidad equilibrada para tomar una posición y dejarse llevar. Se necesitará mucha habilidad social para saber cuándo hacer qué. Hay supervisores que destruirán tu carrera si vas en su contra, y hay quienes esperan que los critiques y que recompensarán el pensamiento independiente. No sé de qué tipo es su supervisor.

En última instancia, su supervisor será responsable de la calidad de su trabajo y parece más familiarizado con el conocimiento del dominio, por lo que debe hacer todo lo posible para tratar de comprender su punto. Si es necesario, debe trabajar con él más de cerca, tal vez con ejemplos específicos, para que pueda comprender su razonamiento. Es posible que parte de esa conversación implique que suavice un poco su postura, pero debe estar dispuesto a seguir su ejemplo, ya que él es el supervisor.

Siento la necesidad de señalar que el lenguaje técnico existe por una razón; a menudo transmite un significado que es específico dentro de un dominio de conocimiento especializado. Cuando reviso sus dos ejemplos, veo varias ambigüedades en el significado que se resuelven con los cambios de su supervisor.

Cuando la diferencia entre observaciones únicas fue superior al 10 % de cobertura de agua, o cuando los porcentajes de cobertura no alcanzaron el 100 %, se descartaron puntos.

Para reducir el sesgo de muestreo, los puntos de datos de entrada se eliminaron cuando la varianza era superior al 10 % entre observaciones independientes. Los puntos de datos de entrada también se eliminaron si la clase de porcentaje de cobertura no era igual al 100 %.

• Una "diferencia superior al 10% de cobertura de agua" es diferente de una "variación del 10%". Por ejemplo, un cambio de 10 % de cobertura de agua a 12 % de cobertura de agua es una variación del 20 % pero solo una diferencia de 2 % de cobertura de agua. Creo (necesito más contexto).

• Una observación única no es necesariamente una observación independiente

• Un punto no es necesariamente un punto de datos de entrada

Como regla general, las personas adultas y profesionales en sus campos no "usan grandes palabras" para impresionar a nadie; los están utilizando para su propósito, para transmitir rápidamente lo que a menudo es un significado sutil, algo que se puede pasar por alto fácilmente.

En mi experiencia, los estilos de escritura aceptados tienden a fluctuar entre generaciones y profesiones. He sido criticado, en varias ocasiones, en ambos extremos del arco por ser "demasiado formal" y "demasiado personal", a pesar de que mi estilo personal no ha cambiado mucho a lo largo de los años.

Para su situación específica, el sentimiento, "Quiero que mis documentos publicados reflejen eso", solo funciona si usted es el único autor. Dado que está trabajando con un equipo, su escritura debe representar y ser aceptable para todo el equipo. Eso no significa que te rindas ante todas las críticas, pero sí significa que no tienes derecho a insistir en tu perspectiva por encima de todas las demás. Tendrás que ceder.

Como han señalado otros encuestados, el mejor enfoque para resolver las diferencias es una discusión franca. En lugar de usar un lenguaje de ataque, como "Debería ser tal y tal porque tal y tal", intente algo como "Veo que quiere que agregue tal y tal aquí. Me parece demasiado detallado. ¿Por qué te gusta más esta redacción?"

Tal discusión puede ser difícil de tener 'en el momento', especialmente si está recibiendo muchos comentarios a la vez. Al final de cualquier discusión de revisión, abra la puerta para una mayor discusión con algo como "Esto ha sido útil. ¿Tiene tiempo mañana para hacer un seguimiento si tengo más preguntas?" Esto le da un día para digerir y recuperarse. También le da la oportunidad de decidir qué compromisos está dispuesto a aceptar y por qué elementos está dispuesto a luchar.

Si tuviera que defender mi escritura

¿Por qué es esta una situación de confrontación? Su escritura no es una fortaleza asediada por un editor alborotado.

Suponiendo que su supervisor/editor sepa de lo que está hablando (lo cual no siempre es cierto), entonces no vea que esto es un ataque a su escritura. En cambio, véalo como sugerencias sobre cómo mejorarlo e intente tomar en cuenta ese consejo.

Tal vez no esté de acuerdo con los cambios específicos que se sugieren, pero dado que no proporcionó ninguno, no podemos comentar al respecto. Sin embargo, en lugar de rechazar los cambios, pregúntele por qué: intente comprender los motivos detrás de los cambios y qué problema están tratando de solucionar. Profundice para obtener razones específicas, por ejemplo, la razón difusa "que parece demasiado conversacional" podría significar en realidad "esta redacción es la forma habitual de describir X en este campo y la gente lo esperará, usar su redacción nos hará parecer como si fuéramos no estoy familiarizado con Y".

Volviendo a la analogía de la fortaleza, tu supervisor no es un ejército arrasador. Sin embargo, si mira los muros de tu castillo y piensa que algunos de ellos son demasiado bajos, deberías considerar seriamente su consejo antes de que lleguen las verdaderas hordas.

Lo siento, pero la versión de su supervisor es mucho mejor, al menos según sus criterios establecidos.

Tu versión:

Cuando la diferencia entre observaciones únicas fue superior al 10 % de cobertura de agua, o cuando los porcentajes de cobertura no alcanzaron el 100 %, se descartaron puntos.

¿Qué son los "puntos"? ¿Por qué estás descartando estos "puntos"? ¿Estás anotando las observaciones? Irónicamente, este es un ejemplo del "estilo de escritura académico impenetrable" que lamentaste. Sin el conocimiento de lo que está haciendo, o una comprensión de por qué está haciendo esto, los legos luchan por dar sentido a lo que está diciendo.

La versión de su supervisor:

Para reducir el sesgo de muestreo, los puntos de datos de entrada se eliminaron cuando la varianza era superior al 10 % entre observaciones independientes. Los puntos de datos de entrada también se eliminaron si la clase de porcentaje de cobertura no era igual al 100 %.

Aunque es más largo, en realidad es menos complejo y más fácil de entender. Note que no usó términos más técnicos que los suyos. Las palabras añadidas solo sirven para aclarar cuáles son estos "puntos" y por qué los descartaste. De hecho, redujo la complejidad de la oración al dividirla en dos mitades más simples.

Entonces, de hecho, esto es lo opuesto a "agregar palabras adicionales solo para sonar inteligente". Está agregando palabras simples para permitir que los legos entiendan de lo que está hablando sin más contexto.

En la raíz de esta pregunta, creo, hay una confusión sobre la relación entre complejidad y simplicidad.

Creo que a veces (¿siempre?), un lenguaje sencillo es lo mejor. . . El mayor número de palabras, las estructuras de oraciones más complejas y la falta de significado adicional en las revisiones fueron una señal clara (al menos para mí) de que estaba tomando las cosas en la dirección equivocada.

Más no es más complejo. La brevedad no es simplicidad. De hecho, suele ser exactamente lo contrario. Cuantas más ideas intente encajar en la misma longitud, más aumentará el grado de complejidad para acomodar la información.

Su versión es más corta, pero su oración es más larga que cada oración individual de la versión de su supervisor. Además, su oración también es más compleja: usó una oración compleja compuesta; usó dos oraciones complejas.

Escriba texto formateado , que no se pueda confundir con una conversación hablada.

En lugar de enumerar múltiples alternativas, ejemplos, reformulaciones y explicaciones adicionales en línea, escríbalo así:

• multiples alternativas
• ejemplos,
• reformulaciones y
• explicaciones adicionales.

Use muchas oraciones cortas que vayan al grano. En caso de duda, utilice un lenguaje sencillo. Cuando sea necesario, haga lo que sea necesario, pero intente obtener un estilo simple que sea bueno para los documentos técnicos.

Por ejemplo:

Cuando la diferencia entre observaciones únicas fue superior al 10 % de cobertura de agua, o cuando los porcentajes de cobertura no alcanzaron el 100 %, se descartaron puntos.

se convierte en:

NOTA: Cuando la diferencia entre la observación única inicial fue

• más del 10% de cobertura de agua; o cuando
• los porcentajes de cobertura no fueron iguales al 100%

descartamos los puntos.

¡Observe que sólo ha cambiado el formato! Además, dudo que alguien confunda este último con 'conversacional'. También creo que el texto no se vuelve menos legible.

¿Puedo intentar analizar los consejos de su sup?

Ustedes:

Cuando la diferencia entre observaciones únicas fue superior al 10 % de cobertura de agua, o cuando los porcentajes de cobertura no alcanzaron el 100 %, se descartaron puntos.

A él:

Para reducir el sesgo de muestreo, los puntos de datos de entrada se eliminaron cuando la varianza era superior al 10 % entre observaciones independientes. Los puntos de datos de entrada también se eliminaron si la clase de porcentaje de cobertura no era igual al 100 %.

Creo que estos cambios valen su peso. Aquí hay algunas puñaladas:

Para reducir el sesgo de muestreo (él, agregó)

...establece el propósito de la acción que tiene lugar en esta oración. La oración original requiere que el lector interprete el propósito de las estadísticas en función de las implicaciones del 10 % de cobertura de agua y que no es igual al 100 %... no hay una conexión clara en mi mente.

"Varianza... entre observaciones independientes" (él) vs. "diferencia entre observaciones únicas" (usted)

Este es un ejemplo del uso de términos bien definidos dentro de un léxico técnico/dominio de conocimiento dado (como varianza e independiente ) para servir a la navaja de Occam: ¿por qué introducir un nuevo término en el léxico cuando el término existente es igual de bueno?

"Diferencia... ... ... mayor al 10% de cobertura de agua" (usted) vs. "variación mayor al 10%" (él)

Ha llevado el > 10 % a una palabra de su modificador, mientras que en el suyo el > 10 % está a cuatro palabras de distancia. Encuentro los porcentajes terriblemente ambiguos, y siempre es bueno luchar contra eso.

"10 % de cobertura de agua" (tú) frente a "10 %" (él)

Esta es la apuesta de su sup que, para el propósito de esta oración, no es útil especificar cuál es el componente físico reflejado por la medición, y que es mejor concentrarse en los aspectos estadísticos.

"Porcentajes de cobertura" (usted) frente a "clase de cobertura" (él)

El uso de la expresión X porcentaje de Y% incluye una redundancia: "porcentaje" y el signo %. Al introducir la palabra "clase", su sup ha mejorado la especificidad de este valor sin aumentar la palabrería.

1 oración (tú) vs. 2 oraciones (él)

Usar una oración, como lo había hecho, para las dos cláusulas disminuye la especificidad de la cláusula mutua, "los puntos fueron descartados". También agrega opacidad porque el lector tiene que interpretar dos casos antes de escuchar sobre la acción. Con la versión de su sup, la acción se empareja con un caso más rápidamente, seguido de otro par similar de caso-acción. Esto es más fácil de entender.

¡Espero que este análisis te sea útil! Ciertamente no creo que estés equivocado en tu reacción, ¡pero espero que siempre busques la mejora continua en tu escritura!