La versión original de este post se puede encontrar en HeinrichHartmann.com (inglés).

La escritura es clave para tener impacto en las grandes organizaciones. Como ingeniero/a de software, escribir probablemente es la habilidad más importante que tenés que adquirir para aumentar tu alcance más allá de tu equipo y avanzar en tu carrera.

Escribir es difícil. Muchos/as ingenieros/as de software luchan con la escritura. Personalmente, nunca tuve un interés intrínseco por la literatura, por lo que la escritura tampoco me resultó natural. He pasado días y semanas agonizando y postergando tareas de escritura grandes. Y hasta el día de hoy, tener la presión de producir documentos de alta calidad con una fecha límite me da pesadillas.

Este artículo contiene algunas enseñanzas que me han ayudado a mí (ya otras personas) a ser mejor y más productivo como escritor durante los últimos 15 años. Los comparto con la esperanza de que te puedan ser de utilidad. Sin embargo, no creas que siempre puedo seguir este consejo yo mismo 😅. Todavía tengo mucho que aprender.

Antes de empezar

Tenés que tener algo para decir

Esta afirmación parece obvia, pero sorprendentemente suele ser un problema muy frecuente. El objetivo de la escritura es entregar un mensaje de una manera efectiva a una audiencia. Si no tenés un buen mensaje, se te va a complicar para escribir algo útil.

Durante mi tiempo en la universidad, me encargaron varias veces la redacción de extensos informes para proyectos de la UE. Fue una experiencia terrible, porque el objetivo principal era que se viera bien y llenar páginas. En general, tenía una buena idea del área, pero no tenía un mensaje claro ni la profundidad suficiente. Para mí, esto mismo hacía que fuera increíblemente difícil escribir algo. Pensandolo ahora, creo que GPT-3 sería muy bueno para escribir informes de proyectos de la UE.

Uno de mis posts de blog (en inglés) más leídos (que dio lugar a una serie de charlas sobre el tema) se escribió en el transcurso de 3 horas en una habitación de hotel y se publicó al día siguiente. Fue una continuación de una discusión que tuve ese mismo día con algunos SRE de Google en la SRECon EMEA 2018. Sabía lo que quería decir. Sabía a quién quería llegar. Eso hizo que escribir el post fuera muy fácil.

Si no tenés un mensaje claro en tu cabeza, todavía no estás listo/a para comenzar a escribir una narrativa. Tenés que hacer otras cosas primero: investigá el tema y encontrá tu mensaje. Es importante darse cuenta de que estas son dos tareas diferentes. Pueden implicar la escritura en forma de toma de notas o de un diario, pero este no es material que usarías directamente en el documento final.

No confundas la escritura con el aprendizaje

Darte cuenta de que no tenés el mensaje completo en tu cabeza, por lo general se va a hacer más evidente mientras estás escribiendo. Esto surge cuando no podés encontrar un buen chiste o no ves forma de expresarte con claridad. De hecho, escribir es una buena prueba para ver si realmente tenés un buen entendimiento de un tema y si tenés una comprensión firme del vocabulario del área. Hay un dicho que dice:

Escribir es la forma en que Dios te muestra cuán imperfectos son tus pensamientos.

Y de manera similar:

Un argumento es solo la mitad de bueno una vez que lo estás diciendo.

Si te chocás con este problema, significa que estás aprendiendo cosas. Escribir es generalmente una buena manera de aprender, pero uno/a tiene que darse cuenta de que lo está haciendo. El aprendizaje es un proceso lento y requiere paciencia. No ayuda mucho agonizar frente a una pantalla, tratando de exprimir otra oración. Investigar más sobre el tema leyendo un libro, blog o artículo y tomando notas puede ser una mejor inversión de tiempo.

Conocé a tu audiencia

Cuanto mejor conozcas y entiendas a tu audiencia, más fácil va a ser alcanzar el objetivo de hacerles llegar un mensaje. El público objetivo del texto influye en la terminología que podés usar, el contexto que podés asumir y el estilo de escritura (casual/formal).

Cuando escribo un artículo, generalmente visualizo a una persona concreta como representante de la audiencia a la que estoy dirigiendo ese texto. Además, también va a ser la primera persona que va a recibir un borrador para leer. En general, es mucho más fácil contarle una historia “a alguien” en vez de hablarle al vacío.

La mayoría de mis publicaciones de #math (en inglés) en ,mi blog en realidad no tienen una buena audiencia. Solo son legibles para personas que dominan las matemáticas abstractas, pero solo son interesantes para las personas que trabajan en software. La intersección de ambos grupos es minúscula. Por lo tanto, no espero mucha resonancia o impacto con esos artículos. Están documentando cosas que yo mismo quería aprender.

Respetá tu estado de ánimo

Escribir requiere concentración intensa durante largos períodos de tiempo. Lo ideal es entrar en un estado de concentración donde puedas trabajar sobre el texto durante horas y horas. Esta es, por lejos, la forma más eficiente de escribir una narración o una publicación de un blog, al menos para mí.

Preparate para una tarea de escritura como lo harías para una caminata. Vas a entrar en un ritmo de tareas repetitivas y de iteración. Buscá un espacio cómodo para sentarte. Hacete tu bebida de preferencia. Lo más importante es asegurarte que hayas descansado y que puedas concentrarte. No empieces a escribir cuando ya estés en un estado de cansancio. No hay forma de que logres escribir algo útil.

Además, evitá las distracciones lo más que puedas. Lo más importante: silenciá el chat. Reservá al menos 3 horas en tu calendario para una sesión de escritura. Si tengo que escribir documentos más largos para el trabajo, por lo general trato de reservarme una tarde completa. Para mí, las sesiones de escritura más efectivas son los fines de semana o durante vacaciones en las que no tengo ninguna reunión.

Usá la plancha mientras esté caliente

Al igual que para programar, escribir requiere mucho contexto de tu memoria a corto plazo. Tenés que acordarte de muchos detalles del tema sobre el que estás escribiendo, así como de meter chistes y del estado actual del documento. Todo ese estado tarda en cargar en memoria, y se pierde muy fácil por distracciones o cambios de contexto.

Si en algún momento cargás mucho contexto útil en tu cerebro, usalo para hacer algo útil. Tratá de aprovechar ese momento y buscá el espacio cuando te des cuenta de que estás en condiciones de escribir de manera efectiva sobre el tema.

Calentá la plancha antes de usarla

Por el contrario, si no tenés el contexto en tu cerebro, tenés dos opciones (1) no escribir o (2) empezar a cargar el contexto en tu cerebro.

La falta de contexto es una fuente frecuente de agonía y procrastinación. No esperes agarrar una tarea como “Escribir charla para conferencia” de una lista y empezar a trabajar inmediatamente. Tenés que invertir tiempo en cargar el contexto antes de escribir incluso una sola línea.

Estas son buenas formas de cargar algo de contexto:

  1. Revisá las notas que tomaste sobre el tema.
  2. Discutí el tema con un/a compañero/a de trabajo, un/a desconocido/a o alguien de tu familia.
  3. Leé algún libro/blog/artículo sobre el tema.

Las malas formas de cargar el contexto son navegar por HackerNews o YouTube.

Mientras escribís

Empezá por lo más importante, no por el principio

Este es, lejos, el error más común y perjudicial que veo que comete la gente. Empiezan escribiendo por el principio de la narración:

“Érase una vez, en una galaxia muy, muy lejana…”

¿De verdad pensás que esas fueron las primeras palabras que George Lucas escribió en un papel al hacer la trilogía original de Star Wars?

Para los documentos que tengan más de una página, tenés que usar un enfoque de arriba hacia abajo y empezar con un esquema. Un esquema es una lista de secciones junto con notas preliminares, por lo general en forma de viñetas. Para este documento, el primer esquema era así:

# ¿Cómo escribir?

- Audiencia: Ingenier@s de software senior+
- Objetivo: Mejorar y desbloquear la escritura

### Tenés que tener algo para decir

- Objetivo: Entregar el mensaje a la audiencia.
- Sin un mensaje escribir es una agonía: Sacarle agua a una piedra.

## Conocé a tu audiencia

## Usá la plancha mientras está caliente

- Tenés que ser consciente de tu contexto cerebral
- Empezá/mantenete en una tarea si tenés el contexto correcto
- Cargá el contexto antes de empezar

## Separá la edición, de la publicación y de la redacción

- Si estás jugando con Git/Emacs antes de empezar a escribir, estás haciendo algo mal.
  
...

Tené en cuenta que los títulos de las secciones no son solamente una estructura genérica (por ejemplo, “Introducción” / “Cuerpo” / “Conclusión”), sino que tienen que contar toda la historia.

Tené en claro la línea argumental antes de empezar a escribir

Al construir una casa, se termina la mampostería antes de pintar. Al escribir, la idea es tener una buena línea argumental para tu documento, antes de empezar a desarrollar y pulir el texto. Un esquema debe ser el primer paso para cualquier documento grande que estés escribiendo. El esquema debe transmitir el mensaje principal y proporcionar un “hilo rojo” claro que guíe al lector o lectora a través de la trama.

Cuando trabajaba para una consultora, veía a mis colegas senior pasar mucho tiempo puliendo e iterando la estructura de sus diapositivas antes de trabajar en los detalles. Imprimían la presentación en papel, clavaban las diapositivas en la pared y las reorganizaban hasta que estaban conformes con la línea argumental. Las presentaciones se quedaban en la pared y estaban sujetas a reorganización hasta que se finalizara la presentación.

Arreglar la línea argumental de un documento se vuelve MUCHO más difícil una vez que ya escribiste los párrafos. Inclusive en algunos casos, lo mejor que podés hacer es descartar todo el contenido y volver a un esquema antes de volver a construir el documento.

Terminá el contenido antes de empezar a pulirlo

Una trampa en la que he caído demasiadas veces es distraerme con tareas adyacentes que no son necesarias para producir una narrativa. Esas tareas incluyen:

  1. Edición. Correcciones ortográficas, cambios de redacción o reestructuración de párrafos.
  2. Publicación. Jugar con el formato, ajustar WordPress, automatizar tu despliegue de Git+Hugo+Heroku.
  3. Producción de gráficos. Dibujar gráficos en papel o navegar por la web en busca de imágenes que puedas usar en tu presentación.

Acordate: el primer paso de tu documento es tener un esquema. Todo lo que no contribuya directamente con este objetivo es una distracción.

Cuando estés conforme con el esquema, el segundo paso es un texto completo, donde todas tus notas se hayan convertido en párrafos. El texto debería cubrir el contenido planificado, pero no es necesario que esté pulido o bien escrito.

Una vez que llegues a este punto, empezá a preocuparte por pulir: corregir errores ortográficos, mejorar la redacción, reestructurar párrafos. También el trabajo de gráficos y de publicación en general se puede retrasar hasta este punto sin ningún problema.

Hacé que tu texto sea hojeable

Según alguien en internet (en inglés):

Ocho segundos. La capacidad de atención de un usuario en un sitio web es de alrededor de ocho segundos.

En estos ocho segundos, tu documento tiene que revelar suficiente valor al usuario, para que él o ella esté dispuesto/a a invertir más tiempo en leer el resto del documento.

Si querés que se escuche tu voz (y también mejorar la usabilidad de tu texto), tenés que diseñar tu documento para que sea “hojeable”. Para eso, brindale al usuario puntos de apoyo que permitan evaluar el contenido sin realmente leerlo. Idealmente el esquema y los argumentos principales tienen que seguir destacandose en la versión final del documento.

Los encabezados de las secciones y las listas son los puntos de apoyo claves que tenés que usar para lograr este objetivo. También los gráficos, las citas y las partes resaltadas son características que se destacan y llaman la atención mientras se hojea rápidamente el documento.

Si estás escribiendo un conjunto de diapositivas, una buena forma de lograr que sea hojeable es el uso de títulos de acción. Los títulos de acción son títulos de diapositivas que resumen el contenido de una diapositiva en una oración completa. Al hacer esto, le permite al lector tener una idea del documento solamente leyendo los títulos. Este tipo molesto de Internet hace un buen trabajo al explicar el concepto y las ideas generales acá (en inglés).

Armá secciones de resumen

Las secciones de resumen se usan comúnmente en plantillas de documentos y en la escritura académica. Son herramientas de usabilidad que otorgan una visión general sobre el contenido para las personas que estén apurados/as. Es de esperar que una gran parte de tu audiencia solo lea un resumen.

  • Resumen / Resumen ejecutivo / TL;DR. Esta sección resume el contenido del documento, duplicando intencionalmente la información. Por lo general, es la primera sección del documento y está destinada a un lector que aún no ha leído el documento. Un buen resumen describe el contexto, motiva el problema, resume los hallazgos pero también deja algo en suspenso para motivar la lectura de todo el texto.

  • Conclusión. Esta sección también resume el contenido y, por lo tanto, es muy similar a un resumen. La diferencia es que la conclusión es la última sección del documento, se enfoca en los resultados y hace referencias al contenido. La idea básica es que se haya leído el documento antes de llegar a la conclusión, aunque en la práctica casi nunca pasa.

Es importante tener en cuenta que estas secciones de resumen son independientes de la línea argumental principal y, por lo tanto, son una herramienta que se puede preparar de forma independiente. En general, te recomendaría empezar a trabajar en las secciones de resumen (como Resumen/Conclusión) al final, ya que recién ahí vas a tener la seguridad de lo que realmente va a terminar en la versión final.

La práctica de escribir

Seguí escribiendo

La única forma de mejorar la escritura es escribiendo. Como pasa con la práctica en general, valorar la cantidad por sobre la calidad suele ser una buena idea. Desarrollar un músculo de escritura y escribir documentos relativamente cortos de calidad media todas las semanas te va a convertir en un/a escritor/a mucho mejor que escribir documentos muy pulidos una vez al año.

Mi profesor de literatura en la escuela solía decir: “Escribir. Sólo escribir trae bendiciones”. No pensé mucho en este eslogan, pero fue lo suficientemente pegadizo como para quedarse en mi cabeza. Ahora lo considero una verdad absoluta y lo mantengo en la parte superior de mi blog, como recordatorio.

Aprovechá las pequeñas tareas de escritura como ejercicio

La mayoría de las reglas que se aplican a la redacción de documentos extensos, como narrativas tecnológicas, publicaciones de blog o papers, son las mismas para la redacción de documentos breves como correos electrónicos o tickets. Usá estos documentos para practicar tus habilidades de escritura, haciendolos bien estructurados, usables y pulidos.

Pedí comentarios sobre tu esquema al principio

Una vez que tengas un esquema y pulido la línea argumental, es un buen momento para obtener comentarios iniciales sobre el documento. Esto te va a permitir encontrar fallas en la historia desde el principio y asegurarte de que lográs el objetivo con el contenido. Además, leer un esquema es algo muy rápido, por lo que la persona que lo revise no va a necesitar mucho esfuerzo para leer el texto.

Esto es especialmente importante para los documentos largos que estés haciendo a pedido de una parte interesada (como un/a gerente).

Hacé circular borradores del texto a una audiencia selecta

Una vez que hayas desarrollado el contenido y hayas hecho una primera pasada de edición eliminando los errores gramaticales y ortográficos más evidentes, es un buen punto para mandarle el documento a personas seleccionadas de la audiencia a la que está dirigida el texto.

Esto tiene tres beneficios:

  1. Te van a prestar un par de ojos nuevos que, como mínimo, van a detectar algunos detalles gramaticales que hayan quedado en el texto.
  2. Te tomás un descanso de trabajar en el texto, hasta que te llegan los comentarios, lo que te permite revisar lo que escribiste desde una nueva perspectiva.
  3. Tenés una excusa para acercarte a amigos/as que habías colgado durante mucho tiempo.

Sugerencia: no te olvides agradecer a tus revisores/as en una sección de “Agradecimientos”.