Ir al contenido principal

Escritura técnica

Esta es la primera publicación sobre redacción técnica * de una serie que crearé durante el transcurso de este año. La escritura técnica es algo con lo que la mayoría de nosotros tenemos que lidiar en diferentes contextos. Por ejemplo, en cursos universitarios, publicaciones de investigación, documentación de software. La idea principal de la serie es mencionar algunos de los trucos que he aprendido a lo largo de los años y algunas herramientas que pueden ser útiles.

Las publicaciones futuras serán (probablemente) sobre:

  • Uso de ecuaciones;

  • Uso de figuras;

  • Uso de tablas; y

  • Gestión de referencias bibliográficas.

Esta publicación

Como se mencionó anteriormente, la escritura técnica es algo con lo que muchas personas tienen que lidiar. Esta es una habilidad que a veces se pasa por alto, pero no debería. De acuerdo con la U.S. Bureau of Labor Statistics

Los redactores técnicos preparan manuales, guías prácticas, artículos de revistas y otros documentos de respaldo para comunicar información compleja y técnica con mayor facilidad.

Y es una habilidad deseada en el lugar de trabajo. Se espera que su demanda crezca alrededor del 10% en la década actual.

Tipografía

Lo primero que debo mencionar es que escribir documentos es tipografía ya que estamos diseñando con texto (Butterick, 2019). Por lo tanto, deberíamos considerarnos tipógrafos, ya que constantemente diseñamos documentos.

Sugeriría echar un vistazo a "Butterick's Practical Typography" ya que es un libro muy bueno sobre el tema y es fácil de leer. Voy a mencionar algunos puntos importantes de acuerdo con la sección "Tipografía en diez minutos":

  1. La selección tipográfica más importante está en el cuerpo del texto. Esto se debe al hecho de que es la mayor parte del documento.

  2. Elija un tamaño de punto entre 10-12 puntos para documentos impresos y 15-25 píxeles para documentos digitales.

  3. El espacio entre líneas debe estar entre 120-145% del tamaño de la letra.

  4. La longitud de la línea debe tener entre 45 y 90 caracteres. Esto es aproximadamente 2 o 3 alfabetos en minúsculas:

    abcdefghijklmnñopqrstuvwxyzabcdefghijklmnñopqrstuvwxyzabcd

  5. Cuidado con la selección de su fuente. Intente evitar las fuentes predeterminadas como Arial, Calibri o Times New Roman.

Editores

Otro punto que quiero tocar en esta publicación es el de los editores. La primera pregunta que surge es "¿qué editor debo usar?". La respuesta corta es: usa lo que tus colegas estén usando. Ese es mi mejor consejo; de esa manera tu tienes personas con quienes hablar sobre tus dudas.

La respuesta larga ... es que cada editor tiene sus puntos débiles y fuertes. Yo ha escrito artículos científicos en LaTeX, LibreOffice Writer y MS Word; todos se ven profesionales. Entonces, al final, puedes escribir tu documentos de varias maneras y lograr un resultado similar. Prefiero usar LaTeX para documentos largos, ya que se centra en la estructura de la documento en lugar de la apariencia y esta es la forma en que uno debe administrar un documento largo como una disertación, en mi opinión.

Si solo quieres que elija un editor y te lo sugiera, diría que LibreOffice. Una buena referencia para es "Designing with LibreOffice". Una vez que aprendas cómo usar estilos, preguntarás cómo has estado escribiendo todos los documentos hasta ahora.

Hay dos grupos de editores que voy a discutir: WYSIWYG (siglas en inglés para "Lo que ves es lo que obtienes") y editores basados en marcado.

  • WYSIWYG. Esta categoría es la que la mayoría de la gente conoce. Dos ejemplos son:

    • LibreOffice writer; y

    • Microsoft Word.

  • Los editores basados en marcado dependen de las marcas en el "texto" para diferenciar secciones y estilos. En este caso, su texto parece código, como se ve en la siguiente imagen

    /images/rst_code.png

    Algunos ejemplos son:

Independientemente de cuál sea tu editor principal, sugiero utilizar Pandoc. Te permite convertir entre varios formatos, haciendo el proceso un poco más fácil. Incluso hay un editor basado completamente en él llamado Panwriter.

References

  1. Matthew Butterick (2019). Butterick's Practical Typography. Segunda edición, Matthew Butterick.

  2. Wikibooks contributors. (2020). LaTeX. Wikibooks, The Free Textbook Project.

  3. Bruce Byfield (2016). Designing with LibreOffice. Friends of OpenDocument, Inc.

  4. Deville, S. (2015). Writing academic papers in plain text with Markdown and Jupyter notebook. Sylvain Deville.

*

Esta publicación está (algo) relacionada con una publicación anterior donde discutí sobre algunas herramientas de investigación que la mayoría de nosotros necesitamos pero que comúnmente no se enseñan de manera formal.

Comentarios

Comments powered by Disqus