Para responder esta pregunta, en primer lugar, podríamos empezar definiendo qué es un technical writer. Luego de haber leído varias definiciones, podríamos decir que un technical writer es un profesional de la comunicación que tiene como objetivo transformar información compleja (en especial, dentro del campo de IT), en una versión simple y así, transmitirla de manera que sea fácil de entender. Para ello, se necesita investigar sobre el tema a escribir y es esencial poder tener reuniones con los expertos, más conocidos como SMEs, para que nos ayuden a comprender los distintos aspectos técnicos.
La escritura técnica también se define como el hecho de simplificar lo complejo. Por tal motivo, es importante que en nuestro equipo de trabajo se puedan documentar procesos complejos, siendo fácilmente comprendidos por distintos públicos. Además, esto ayuda a que los expertos se focalicen en sus tareas técnicas, en lugar de tener que estar escribiendo documentación, que les puede resultar tedioso y aburrido. A su vez, el hecho de tener una buena documentación, repositorio y contenidos claros ayudará a tu organización a adquirir nuevos consumidores y conservar los que ya se tiene.
¡Buenas noticas! Cualquier persona que le guste escribir, documentar y que tenga ciertas aptitudes relacionadas con la escritura y la comunicación puede convertirse en un technical writer.
Además de tener facilidad para escribir, los idiomas y la investigación, hay algunas habilidades o skills que ayudan a obtener mejores resultados cuando trabajamos en el área de technical writing. Algunas de ellas se pueden enumerar en la siguiente lista:
- Análisis de negocio
- Computer scripting
- Gestión de contenido
- Diseño de contenido
- Diseño gráfico/Ilustración
- Arquitectura de la información
- Diseño de la información
- Conceptos Cloud (AWS/Azure)
- Traducción técnica
- UX/UI – UX writing
- Diseño/Gestión Web
- Lenguajes de programación/Markup languages (conocimiento básico): Python, SQL, HTML, XML, Markdown
Dentro de la comunidad del technical writing, surgió el concepto de DocOps. Al igual que tenemos el proceso de DevOps, se denomina proceso de DocOps a los pasos a seguir cuando escribimos documentación técnica, dividido en diferentes etapas: Creación, Gestión y Release. Esto sería darle un marco teórico a nuestro proceso de escritura. En la siguiente imagen, podemos observar los pasos que integran el proceso de DocOps:
Los entregables son los distintos documentos que un technical writer suele escribir, como, por ejemplo:
- White papers
- Release notes
- Manuales de procedimiento
- Tutoriales
- Open API specs
- Conocer al público lector. Antes de comenzar a escribir cualquier borrador, es muy importante saber a quiénes o quién será dirigido el documento que estás escribiendo. Por ejemplo, no es lo mismo dar por sentado algunas siglas, que tener que incluir el detalle. Cuando tenemos más de un público (por ejemplo, usuarios en general vs. expertos) es necesario incluir títulos donde separen la información más técnica de la más general para que el lector elija qué parte leer.
- Investigar. La recolección de información de diferentes fuentes confiables siempre es un must en esta profesión. Luego, se necesita analizarla para después entender más fácilmente cómo escribiremos nuestro documento.
- Utilizar estilo impersonal. Para poder ser lo más objetivo posible, es importante escribir en tercera persona, como cuando se dan instrucciones en un procedimiento.
- Escribir de manera sencilla. Mientras más simple sea nuestro estilo, la documentación será más fácil leer para la comprensión de nuestro público. Evitar oraciones largas es una buena práctica; siempre focalizarse en el objetivo del documento y nunca incluir ideas abstractas.
- Incluir elementos que permitan “escanear” el documento. Es de público conocimiento que las personas no suelen leer todo el documento entero. Por ello, necesitamos incluir elementos como palabras destacadas en negrita, títulos, hipervínculos, diagramas, imágenes que nos permitan poder hacer una lectura rápida de dicho documento, es decir poder “escanearlo”.
Para finalizar el artículo y a modo de resumen sobre la profesión y la importancia del technical writer, quisiera hacer mención a la siguiente frase: “Si no puedes explicarlo de forma sencilla, es que no lo entiendes bien.”
– Albert Einstein