| “The fundamental purpose of scientific discourse is not the mere presentation of information and thought but rather its actual communication. It does not matter how pleased an author might be to have converted all the right data into sentences and paragraphs; it matters only whether a large majority of the reading audience accurately perceives what the author had in mind.” – George Gopen and Judith Swan The Science of Scientific Writing
Good Tech Writers Practice
- Planning
- Clarity
- Brevity
- Simplicity
- Word choice
- Active voice
- Committing to writing as a process
Planning/ Rethinking, Writing, Revising
Planning
Before you begin identify your audience and their expectations.
Know your purpose.
Know your material.
Understand the writing task at hand. Organize your thoughts and materials.
Budget adequate time to write, review, revise and edit.
Clarity: Avoid Jargon
• Jargon: a vocabulary particular to a place of work (abbreviations, slang)
• Audience familiarity with the topic determines appropriate use of jargon
x Ex. 1: For the first year, the links with SDPC and the HAC were not connected, and all required OCS input data were artificially loaded. Thus CATCH22 and MERWIN were not available.
√ Ex. 2: Because some of the links in the computer system were not connected the first year, we could not run all the software codes.
Clarity: Define the Unfamiliar
• If you must abbreviate, define the term in its first occurrence, and put abbreviations in parentheses
Ex: Edgartown Great Pond (EGP) is a vital body of water. Unfortunately, due to an unpredictable influx of saltwater, the delicate ecosystem is in danger of destabilizing.
• Italicize first occurrence of unfamiliar terms and define them right away
Ex: The retina is a light-sensitive tissue, found at the back of the eye, that converts light impulses to nerve impulses.
Brevity: Use Words Efficiently
• Never use two words when one word will do.
x Ex. 1: The relationship between the nature of salt water to fresh water in the Edgartown Great Pond that fluctuates often is extremely important to everyone including scientists, residents, and environmentalists on Martha’s Vineyard.
√ Ex. 2: The fluctuating salinity of EGP concerns many environmentalists, scientists, and residents.
Brevity: Less Is More
• Pare your language down to the essential message you want to get across to your readers:
Ex: Earthquakes can occur at predictable intervals along a given fault segment. Depending on the length and slip in each main shock, the exact interval can vary by a factor of two. The southern segment of the San Andreas fault has an interval of 145 years, plus or minus a few decades.
Brevity: Most Important First
• Place key information in the main clause Ex. x Ex. 1: Despite winning the game, the Patriots made several errors in the first half.
x Ex. 2: Despite making several errors in the first half, the Patriots won the game.
√ Ex. 3: The Patriots won the game, despite making several errors in the first half.
Brevity: Remove Redundancy
• Combine overlapping sentences when possible
x Ex. 1: Water quality in Hawk River declined in March. This decline occurred because of the heavy rainfall that month. All the extra water overloaded Tomlin county’s water treatment plant.
√ Ex. 2: Water quality in Hawk River declined in March because heavy rainfalls overloaded Tomlin County water treatment plant.
Simplicity: Use Details Wisely
• Specific details are desirable, but be careful to balance detail with audience needs for clarity—significance is more important.
x Ex. 1: The average house in the area has a radon level of 0.4 picocuries per litre.
√ Ex. 2: The average house in the area has a radon level of 0.4 picocuries per litre, which is considered low by the EPA [Lafavore, 1987]. Levels between 20 and 200 picocuries per liter are considered high, and levels above 200 picocuries per liter are considered dangerous. For reference, the average radon level in outdoor air is about 0.2 picocuries per litre.
Simplicity: Use Details Wisely
• Many engineers want to provide as much specific detail as possible, but this can come at the expense of readers understanding and their main point.
x Ex. 1: The number of particular hydrocarbon combinations in our study is enormous. For example, the number of possible C20 H42 is 366,319 and the number of C40 H82 is 62,491,178,805,831.
√ Ex. 2: The number of hydrocarbon combinations in our study is enormous. For example, the number of possible C40 H 82 is over 60 trillion.
Language: Needless Complexity
| Category |
Example |
Substitute |
| Nouns |
utilization |
use |
| functionality |
feature |
| Verbs |
facilitate |
cause |
| finalize |
end |
| Adjectives |
aforementioned |
mentioned |
| individualized |
individual |
| Adverbs |
firstly |
first |
| secondly |
second |
| heretofore |
previous |
• Avoid too many abstract nouns
x Ex. 1: The existing nature of Mount St. Helens’ volcanic ash spewage was handled through the applied use of computer modeling capabilities.
√ Ex. 2: With Cray computers, we modeled how much ash spewed from Mount St. Helens.
Language: Needless Words
| already existing |
never before |
| at the present time |
none at all |
| basic fundamentals |
now at this time |
| completely eliminate |
period of time |
| continue to remain |
mix together |
| currently being |
separate entities |
| currently underway |
start out |
| (empty) space |
write out |
| had done previously |
still persists |
| introduced a new |
|
Language: Ambiguity
• Choose words whose meanings are clear
x Ex. 1: T cells, rather than B cells, appeared as the lymphocytes migrated to the thymus gland.
√ Ex. 2: T cells, rather than B cells, appeared because the lymphocytes migrated to the thymus gland.
Language: Ambiguity
• Do not overuse pronouns—particularly “it” and “this”—because it is often difficult to identify the antecedent
Ex: Because the receiver presented the radiometer with a high-flux environment, it was mounted in a silver-plated stainless steel container.
Which is it?
Language: Weak vs. Strong
• Avoid too many “to be” verbs:
“is” “was” “were” “has been” “have been”
• Avoid excess words, which slow comprehension of the main point:
| made arrangements for |
arranged |
| made the decision |
decided |
| made the measurement of |
measured |
| performed the development of |
developed |
| is working as expected |
works as expected
|
Active Voice: Strong Verbs
• Technical writers want to communicate as efficiently as possible, and active voice is more straightforward and is stronger than passive voice
x Ex 1: The feedthrough was composed of a sapphire optical fiber, which was pressed against the pyrotechnic that was used to confine the charge.
√ Ex 2: The feedthrough contained a sapphire optical fiber, which pressed against the pyrotechnic that contained the charge.
Active Voice: Natural Sound
• When in doubt, read passages out loud to determine the natural sound*
x Ex 1: A new process for eliminating nitrogen oxides from diesel exhaust engines is presented. Flow tube experiments to test this process are discussed. A chemical reaction scheme to account for this process is proposed.
√ Ex 2: We presented a new process for eliminating nitrogen oxides from the exhaust of diesel engines. To test this process, we performed experiments in flow tubes. To explain this process, we developed a scheme of chemical reactions.
*always defer to your professor, your journal, or your company style guide for use of “I” and “we” in technical papers.
Writing Is a Process
• Good writing doesn’t happen overnight; it requires planning, drafting, rereading, revising, and editing.
• Learning and improvement requires self-review, peer review, subject-matter expert feedback, and practice.
• There are no shortcuts; practice makes perfect!
First Draft
Revised Draft
Final Draft
To summarize
• Plan your project before you begin drafting.
• Understand basic qualities of good technical writing; use the examples presented to guide you in your writing and revising process.
• Good writing is a habit that takes time to develop; practice makes perfect.
Questions?
• MIT Writing Center http://web.mit.edu/writing/
• CI Instructor, Nicole Kelley, Mary Caulfield, Lydia Volaitis, Thalia Rubio Stata Center 32-083 x33039 Make an appt., email, or call directly. nkelley@mit.edu, lydiav@mit.edu, trubio@mit.edu, mcaulf@mit.edu (email preferred) |
“El propósito fundamental del discurso científico no es la mera presentación de información y pensamiento, sino más que todo su buena comunicación. No importa qué tan a gusto esté el autor con el haber convertido todo los datos correctos a oraciones y párrafos; importa solamente si la mayoría del público lector puede captar con precisión la intención de este autor”. – George Gopen y Judith Swan, La Ciencia de la Escritura Científica.
Las buenas prácticas del escritor técnico
- Planificación
- Claridad
- Brevedad
- Simplicidad
- Selección de palabras
- Voz activa
- Cometerse a la escritura como proceso
Planificación/redacción, escritura, revisión
Planificación:
Antes de empezar, considere quien es su audiencia y las expectativas de esta.
Sepa su propio propósito.
Conosca la materia.
Entienda cual es el trabajo que le espera. Organize sus ideas y materiales.
Reserve suficiente tiempo para escribir, redactar, corregir y editar.
Claridad: Evite el argot
• Argot: vocabulario particular a un sitio de trabajo o lugar (abreviaciones, jerga)
• La familiaridad de la audiencia/lector con el tema determina el uso apropiado del argot.
x Ej. 1: Durante el primer año, los enlaces con SDPC y la HAC no estaban conectados, y todos los datos que requerían ser entrados en el OCS fueron entrados artificialmente. De tal manera, CATCH22 and MERWIN no estaban disponibles.
√ Ej. 2: Porque algunos de los enlaces en el sistema computarizado no estaban conectados durante el primer año, no pudimos implementar todos los códigos del ‘software’.
Claridad: Defina lo no familiar
• Si tiene que abreviar, defina el término en su primera instancia, poniendo las abreviaciones en paréntesis
Ej: La Gran Laguna de Edgartown (GLE) es un cuerpo de agua vital. Desafortunadamente por el flujo impredecible de agua salada, el delicado ecosistema está en peligro de desestabilizarse.
• Italize la primera instancia de términos no familiares y defínala en ese momento.
Ej: La retina es un tejido sensible a la luz, que se encuentra en el posterior del ojo, y que convierte impulsos de luz a impulsos de nervios.
Brevedad: Use las palabras con eficiencia
• Nunca use dos palabras cuando una servirá.
x Ej. 1: La relación entre la naturaleza del agua salada hacia el agua dulce en la gran laguna de Edgarton, la cual fluctúa con frecuencia, es extremadamente importante para todos en las Viñas de Martha, incluyendo ecólogos, científicos, y residentes.
√ Ej. 2: La salinidad fluctuante de EGP preocupa a muchos ecólogos, científicos, y residentes.
Brevedad: Menos es mas
• Mantenga su language centrado en el mensaje esencial que le quiere transmitir a sus lectores:
Ej: Los terremotos pueden ocurrir en intervalos previsibles a lo largo de una porción de la falla sísmica. Dependiendo de la longitud y el deslice en cada choque, el intervalo preciso puede variar por un factor de dos. La porción sur de la falla de San Andreas tiene un intervalo de 145 años, sumando o restando algunas décadas.
Brevedad: Lo más importante primero
• Coloque información clave en la cláusula principal.
x Ej. 1: Aunque ganaron la partida, los Patriotas cometieron varios errores en la primera mitad.
x Ej. 2: A pesar de cometer varios errores en la primera mitad, los Patriotas ganaron la partida.
√ Ej. 3: Los Patriotas ganaron la partida, a pesar de haber cometido varios errores en la primera mitad.
Brevedad: Remueva la Redundancia
• Combine, si es posible, oraciones que incluyan la misma información.
x Ej. 1: La calidad de agua en el Rio Hawk declinó en marzo. Este declive ocurrió por la alta cantidad pluvial ese mes. Toda el agua adicional sobrecargó la planta de tratamiento de agua en el condado de Tomlin.
√ Ej. 2: La calidad de agua en el Rio Hawk declinó en marzo por la alta cantidad pluvial que sobrecargó la planta de tratamiento de agua en el condado de Tomlin.
Simplicidad: Use detalles con prudencia
• Detalles específicos son deseables, pero tenga cuidado de balancear detalle con la necesidad hacia la claridad para su audiencia – significado es más importante.
x Ej. 1: La casa promedio en la zona tiene niveles de radón de 0.4 picocurios por litro.
√ Ej. 2: La casa promedio en la zona tiene niveles de radón de 0.4 picocurios por litro, lo cual la EPA considera bajo [Lafavore, 1987]. Niveles entre 20 y 200 picocurios por litro son considerados altos, y niveles encima de 200 picocurios por litro son considerados peligrosos. Para referencia, el nivel promedio de radón en el aire libre es más o menos 0.2 picocurios por litro.
Simplicidad: Use detalles con prudencia
• Muchos ingenieros quieren proveer la mayor cantidad de detalles específicos que les sea posible, pero esto puede suceder al costo del entendimiento para la audiencia y de su punto principal.
x Ej. 1: El número de combinaciones particulares de hidrocarburo en nuestro estudio es enorme. Por ejemplo, el número de posibilidades para C20 H42 es 366,319 y el número de C40 H82 es 62.491.178.805.831.
√ Ej. 2: El número de combinaciones de hidrocarburo en nuestro estudio es enorme. Por ejemplo, el número de posibilidades para C40 H 82 es más de 60 trillones.
El lenguaje: la complejidad innecesaria
| Categoría |
Ejemplo |
Sustituir |
| Sustantivos |
utilización |
uso |
| funcionalidad |
función |
| Verbos |
facilita |
causa |
| finaliza |
termina |
| Adjectivos |
antes mencionado |
mencionado |
| individualizado |
individual |
| Adverbios |
en primer lugar |
primero |
| en segundo lugar |
segundo |
| hasta ahora |
previo |
El lenguaje: abstracción
• Evite demasiadas abstracciones.
x Ej. 1: La naturaleza actual de la ceniza arrojada por el volcán Santa Helena fue manejada por medio del uso aplicado de capacidades computarizadas para modelar.
√ Ex. 2: Con computadoras Cray, modelamos la ceniza que fue arrojada por el volcán Santa Helena.
El lenguaje: palabras innecesarias
| ya existentes |
antes nunca |
| en el presente momento |
absolutamente ninguno |
| fundamentos básicos |
ahora en este momento |
| elimina completamente |
período de tiempo |
| queda continua |
mescle juntos |
| ahora es |
entidades separadas |
| actualmente en progreso |
|
| espacio vacío |
|
| previamente había hecho |
persiste todavía |
| introdujo un nuevo |
|
El lenguaje: ambigüedad
• Escoja palabras cuyos significados sean claros.
Ej. 1: Células T, en vez de células B, aparecieron al mismo tiempo en que los linfocitos migraron a la glándula del timo.
√ Ex. 2: Células T, en vez de células B, aparecieron porque los linfocitos migraron a la glándula timo.
El lenguaje: ambigüedad
• No sobreuse pronombres—en particular “el” y “esto”— porque es usualmente difícil identificar el antecedente.
Ej: Porque el receptor presentaba al radiómetro con un ambiente de alto flujo, éste estaba montado en un envase de acero inoxidable con revestimiento de plata.
¿Cual es éste?
El lenguaje: débil vs. fuerte
• Evite demasiados verbos “ser”:
“es” “era” “eran” “habían sido” “han sido”
• • Evite el exceso de palabras, atrasando comprensión del punto principal:
| hizo arreglos para |
arregló |
| hizo la decisión |
decidió |
| tomó las medidas de |
midió |
| produjo el desarrollo de |
desarrolló |
| está trabajando como esperado |
trabaja como esperado |
Voz activa: verbos fuertes
• Los escritores técnicos quieren comunicarse de la manera más eficiente, y voz activa es más directa y más fuerte que voz pasiva.
x Ej 1: El paso de cables estaba compuesto de una fibra óptica de zafiro la cual estaba presionada contra la pirotécnica que estaba siendo usada para confinar la carga.
√ Ej 2: El paso de cables contenía una fibra óptica de zafiro, que presionaba en contra de la pirotécnica que contenía la carga.
Voz Activa: Sonido Natural
• Cuando en duda, lea los pasajes en voz alta para determinar el sonido natural*
x Ex 1: Un nuevo proceso para la eliminación de óxidos de nitrógeno por los escapes de motores de diésel es presentado. Experimentos con tubos de flujo para examinar este proceso son discutidos. Un esquema de la reacción química para explicar este proceso es propuesto.
√ Ex 2: Presentamos un nuevo proceso de eliminación de los óxidos de nitrógeno por los escapes de los motores de diésel. Para examinar este proceso, realizamos experimentos en tubos de flujo. Para explicar este proceso, desarrollamos un esquema de las reacciones químicas.
* Siempre base su práctica en las guías de su profesor, libro de estudios, o guía de estilo de su compañía para el uso correcto del “yo” y “nosotros” en papeles técnicos.
Escribir es un proceso
• La buena escritura no ocurre de la noche a la mañana; se requiere planear, hacer bosquejos, releer, revisar, y editar.
• El aprendizaje y mejoramiento requiere auto-revisión, revisión y crítica del contenido por colegas y expertos y práctica.
• No hay atajos; ¡Con la práctica se hace el perfecto!
Primera versión
Segunda versión
Versión final
En suma
• Planifique su proyecto antes de empezar con los bosquejos.
• Entienda las cualidades básicas de la buena escritura técnica; use los ejemplos presentados aquí como guía en su escritura y proceso de redacción.
• La buena escritura es una costumbre que toma tiempo en desarrollarse: la práctica hace lol perfecto.
¿Preguntas?
• El Centro de Escritura de MIT (MIT Writing Center) http://web.mit.edu/writing/
• Instructores de CI, Nicole Kelley, Mary Caulfield, Lydia Volaitis, Thalia Rubio.
Stata Center 32-083 x33039 Haga una cita o escriba, o llame directamente. nkelley@mit.edu, lydiav@mit.edu, trubio@mit.edu, mcaulf@mit.edu (se prefiere el correo electrónico). |
