Si no puedes explicarlo de forma sencilla, es que no lo entiendes bien.

– Albert Einstein

El valor de la escritura técnica puede observarse en una serie de aplicaciones, incluidos los artículos de consumo y el entorno industrial. Los productos pueden resultar inútiles, en el mejor de los casos, y perjudiciales, en el peor, sin una redacción clara y precisa que especifique las especificaciones y recomendaciones de uso. En Keepler, la escritura técnica da contexto a nuestros productos y procesos, permitiendo que todos los miembros de la empresa los comprendan. Aunque no es imposible construir y utilizar equipos y procesos sin leer primero los manuales técnicos, la escritura técnica proporciona cierta garantía de que el producto se utiliza como está previsto. La idea es educar a tu comunidad y proporcionar un modo de autoservicio de ayuda y aprendizaje.

Se puede argumentar que «gustar de crear documentación» es un rasgo único, especialmente dada la reputación que ha adquirido como tarea. Esos tuits podrían resultar acertados, en cuyo caso los escritores técnicos deberían ser reconocidos como los raros tesoros que son. 

En el siguiente artículo, abordaré

  1. Cómo se puede utilizar la escritura técnica en toda la empresa; la documentación eficaz beneficia a todos.
  2. Además de escribir, los redactores técnicos suelen realizar otras actividades y ayudar en otros ámbitos.
  3. Una pequeña lista de algunas herramientas estupendas que puedes utilizar para el lado más práctico de tu escritura técnica.

Por supuesto, un redactor técnico debe ser capaz de expresar conceptos de forma sucinta y clara. Dado que su profesión implica transmitir conceptos sofisticados, el material debe ser sencillo de comprender. Para escribir algo útil para la gente, primero hay que comprender el producto y sus principios de funcionamiento.

La importancia de la escritura técnica en el ámbito tecnológico puede observarse en diversas aplicaciones, como el lanzamiento de nuevos productos o conceptos. Es necesario ser capaz de redactar documentos técnicos claros para los inversores y la dirección cuando se presenta un nuevo producto. El objetivo del producto, así como detalles como su arquitectura, la capacidad de ingesta de datos y las principales ventajas en comparación con sus competidores deben demostrarse claramente en la escritura técnica.

Los particulares pueden ahorrar tiempo y dinero accediendo a la escritura técnica, mientras que la economía también se beneficia. Los particulares y las empresas pueden dudar en invertir en nuevos productos y procesos si su escritura técnica es deficiente. Por tanto, el valor de la escritura técnica puede medirse no sólo por el dinero que genera, sino también por la comodidad y seguridad que proporciona a los lectores.

1. Una documentación eficaz beneficia a todos

La mayoría no es consciente de la importancia de la redacción técnica en su empresa. No se dan cuenta de que no se trata sólo de poner instrucciones y definiciones; al menos, no tiene por qué ser así (y probablemente no debería). Veamos algunas de las áreas importantes en las que la escritura técnica ayuda en Keepler.

Marketing

El marketing de contenidos es el proceso de crear contenidos con el objetivo de adquirir nuevos consumidores y conservar los que ya tienes. El objetivo del material destinado a promocionar un producto, servicio o marca es provocar algún tipo de respuesta de los espectadores del contenido, idealmente convirtiéndolos en clientes. Los blogs, las publicaciones en las redes sociales, el material del sitio web, los catálogos de productos y otros tipos de escritos entran en esta categoría. El objetivo final de estos contenidos es ganar dinero y/o establecer relaciones profesionales a largo plazo. El tono o la voz aquí también depende de la audiencia y puede variar mucho de un caso a otro. El viaje del usuario es otro lugar en el que no se puede pasar por alto el aspecto de marketing de la escritura. Los redactores técnicos deben asegurarse de que el camino de un usuario para interactuar con un contenido específico no sea excesivamente complicado, gratificante o beneficioso. No quieres dejar a tus usuarios atascados al final de su viaje. Aquí es donde la superposición de marketing puede ser realmente beneficiosa, ya que puedes guiar a la audiencia hacia un producto o servicio que pueda resolver sus preocupaciones. 

Aunque gran parte del contenido de preventa que he mencionado puede etiquetarse como «marketing», el marketing de contenidos es un nuevo tipo de contenido en el marketing. El marketing de información excluye el contenido con el único propósito de persuadirte para que compres un producto. El marketing de contenidos implica proporcionar a las personas información útil y cuentos que aborden sus problemas. El contenido no siempre habla de los productos de la empresa.

Ingeniería de ventas

Los ingenieros de ventas suelen hacer demostraciones de nuevos productos, capacidades y características menos conocidas. Tener una documentación detallada a mano cuando la necesitan puede facilitarles el trabajo y hacer que sus demostraciones sean más eficaces. Las personas de toda la organización deben estar capacitadas y apoyadas por una documentación de alta calidad.

Ventas

En el último año he oído hablar mucho de abordar todo el recorrido del cliente o de tener una estrategia unificada de experiencia del cliente. Las empresas deben tener un contenido coherente para todos los puntos de contacto con el cliente, desde el momento en que los clientes potenciales se convierten en clientes y más allá.

Los usuarios pueden asistir a un seminario web, ver un vídeo general, visitar un sitio de demostración, leer un artículo del blog, descargar un libro blanco, etc., mientras investigan una empresa.

Pueden interactuar con otras formas de material después de comprar el software, como una lección de iniciación, un artículo de soporte, correos electrónicos de agentes del servicio de atención al cliente, vídeos interactivos «muéstrame», publicaciones en foros, artículos de la base de datos, etc.

El contenido debe tener un aspecto y una sensación coherentes, con los mismos mensajes, palabras, tono y estilo. Los contenidos similares deben ser generados por la misma fuente. A pesar de que el material es creado por varios departamentos dentro de una empresa, el cliente interactúa con él como si fuera una sola entidad. El material también debe ser coherente.

Soporte

El valor de la escritura técnica puede ser evidente en el uso de artículos y procedimientos más tradicionales, además de la introducción de nuevos productos. Mientras que en un entorno tecnológico, los formadores pueden ayudar al personal a aprender diversas piezas de software, los manuales técnicos pueden ayudar cuando surgen escenarios únicos o actuar como una referencia exhaustiva en otras situaciones. Incluso si no hay alguien con más conocimientos o experiencia, esta información está fácilmente disponible. Los documentos de redacción técnica pueden ayudar a disminuir o eliminar el tiempo de inactividad.

La redacción técnica es un proceso continuo

«La escritura técnica es un proceso continuo de aprendizaje, que consiste en reunir, cribar, organizar y evaluar cuidadosamente, al tiempo que se intenta elaborar algo que tenga sentido para el usuario»

— Krista Van Laan

La escritura es uno de los medios de comunicación más antiguos y eficaces. La documentación técnica es cada vez más importante para las empresas. Con la expansión de los negocios, resulta difícil mantenerse al día con la documentación técnica si no se mantiene adecuadamente. Hoy en día, las empresas utilizan una serie de guías de estilo y normas para que su documentación sea más útil. Para que la documentación sea presentable, hay una serie de productos disponibles en el mercado.

La redacción técnica se está convirtiendo poco a poco en la columna vertebral de una empresa, y los redactores expertos están muy solicitados. Unas ventas elevadas, una mayor confianza de los clientes, un valor añadido del producto y una reducción del tiempo de soporte del mismo son las ventajas de una empresa que mantiene una documentación utilizable.

2. Otras actividades de technical writing

Soy lo que llamamos un technical writer accidental. Obtuve un máster en Historia en la universidad. Al cabo de un tiempo, tuve que reciclar mis conocimientos en materia de documentación e hice algunos cursos con la Universidad de California Irvine. Me llevó un tiempo, pero mis esfuerzos dieron resultado y con el tiempo pude encontrar trabajo en este campo. No sólo tenía que traducir textos, sino también editar algunos. Una vez me pidieron que revisara algunos temas de escritura técnica. Por supuesto, al principio fue un reto para mí porque no sabía mucho sobre el producto ni cómo editar correctamente esas frases.

En la comunidad, a menudo hablamos del Technical Writer Accidental: alguien que, al igual que yo, puede que no se haya propuesto ser Escritor Técnico, pero que ahora desempeña esa función (oficialmente o no, a tiempo completo o como responsabilidad secundaria en el trabajo). Lo mejor de aprender todo lo que quieras es que a veces puedes amar lo que estás aprendiendo.

Para ser sincero, como escritor técnico, probablemente puedas arreglártelas sin aprender demasiada información nueva. Hay escritores técnicos que no son expertos en ningún campo, pero que trabajan bien con expertos en la materia para crear una documentación excelente. Hay technical writers que no saben nada del software sobre el que escriben, pero la documentación no se nota porque se ha escrito en colaboración.

Desprecio escribir sobre temas de los que tengo poco conocimiento. Me da escalofríos. Creo que debería ser capaz de detectar incoherencias o inexactitudes en mi propia documentación. Cuando Keepler reconoció la necesidad de contar con un escritor técnico dedicado, aproveché la oportunidad de renovar la documentación y convertirla en algo más. Es posible que mi falta de formación «formal» en escritura técnica me haya llevado a abordar este proyecto de forma diferente a la de algunos miembros del sector. Actualmente estamos en plena renovación de la wiki interna, utilizando XWiki como producto y servicio desde el principio. Quiero una documentación que combine diferentes fuentes de contenido técnico y que sea quizás un poco más amigable y menos formal que la escritura técnica clásica.

He conocido a profesionales muy interesantes a través del grupo Write the Docs que trabajan en la escritura técnica, lo que implica mucho más que crear documentación (para su deleite o consternación, según la persona). Los escritores técnicos desarrollan intrincados esquemas, modifican fotos y hacen animaciones, utilizan sistemas de control de fuentes, componen películas tutoriales, mejoran la mensajería dentro del producto, agonizan con la terminología, y mucho más. Algunos escriben documentación sólo para desarrolladores, y ellos mismos deben tener una sólida formación en programación y capacidades pedagógicas.

Los technical writers son detectives de producto, rastreando la comunicación orgánica (por ejemplo, canales de Ryver, correos electrónicos, foros y redes sociales) en busca de preguntas formuladas para determinar si hay una laguna en la documentación, un área que necesita ser mejorada o una pieza de información del producto que no se encuentra fácilmente. Aprenden a hacer las preguntas adecuadas entrevistando a expertos en la materia (normalmente ingenieros, jefes de producto e ingenieros de ventas). Muchos de ellos (si no lo eran ya) se convierten en expertos en la materia. Son bibliotecarios de productos, y su trabajo consiste en organizar e intercambiar información.

Cualquier ocupación cultiva un conjunto específico de habilidades. Pero la escritura técnica es algo más que escribir; también implica relacionarse con la gente, investigar y resolver problemas

Para que la documentación sea útil, se necesitan habilidades de redacción y enseñanza (Según mi experiencia, cada vez más personas me encuentran en LinkedIn buscando las palabras clave «Technical Writer + Instructional Designer»). La información debe organizarse y presentarse de forma comprensible. Se necesita un talento considerable para expresar conceptos técnicos complicados en un lenguaje claro y desglosarlos en trozos fáciles de entender antes de conectarlos con otros temas. La información se presenta de forma que incluya gráficos, cuadros de notas, listas y otros enfoques para dividir un muro de texto en algo más atractivo visualmente y menos desalentador. Cuando se trata de papeleo, algunas personas pueden mezclar las habilidades de mecanografía con las de comunicación, pero las habilidades de escritura procesables son esenciales. La mayoría de empleadores buscan excelentes habilidades de escritura, mientras que las habilidades de escritura deficientes cuestan a las organizaciones miles de millones de dólares.

El ambiente de trabajo de un redactor técnico profesional intriga a muchos autores brillantes. Consideran que la paz y la tranquilidad del entorno son una verdadera ventaja laboral. Los introvertidos disfrutan de estar solos con sólo un ordenador para investigar y crear documentos durante el proceso de escritura técnica. Escritores de todo el mundo comparten su entusiasmo por un trabajo que puede ser más bien un pasatiempo.

A la hora de definir el technical writing, es necesario tener en cuenta la identidad del escritor técnico y sus rasgos de personalidad más destacados. Un profesional de este campo es, como es lógico, artístico e investigador. Son muy inquisitivos. Leonardo da Vinci es el escritor técnico más famoso de todos los tiempos, según la leyenda. Al parecer, elaboró «manuales de uso» para sus singulares inventos a lo largo del Renacimiento.

A medida que comprendas mejor la escritura técnica y adquieras más conocimientos técnicos, considera si se ajusta a tu tipo de personalidad. Al comenzar una nueva carrera profesional, es una buena idea completar una autoevaluación y pensar en tus habilidades y talentos únicos.

¿La gente lee la documentación?

Intentar escribir para todos los usuarios es uno de los errores más comunes que cometemos en la comunicación técnica. Sé que es un sacrilegio, pero tened paciencia. La mayoría de los usuarios no leen la documentación. No leen la documentación porque es horrible, o porque está escrita en un idioma que no entienden, o porque utiliza palabras grandes. No leen la documentación porque son el tipo de personas que no la leen. Está arraigado en su personalidad y en su actitud ante la vida, y nada de lo que puedas hacer con la documentación puede cambiar eso.

Por supuesto, no puedes obligar a un usuario que no lee la documentación a hacerlo, pero aunque pudieras, no la disfrutaría porque, para empezar, no es del tipo que la lee.

Seguro que están pensando en algo parecido. Verán vídeos en lugar de leer la documentación, por lo que deberíamos convertir todos nuestros manuales en vídeo. Sin embargo, aunque algunas personas prefieren aprender de un vídeo en lugar de un texto, los que se niegan a leer las instrucciones son generalmente los que no quieren que se les enseñe.

Si no inviertes tiempo y recursos en esta área de tu empresa, muchos equipos sufrirán y tendrán dificultades por ello. Por otro lado, la reducción de las llamadas de asistencia, el aumento de la productividad y el éxito de los equipos de toda tu organización y el marketing pasivo pueden compensar la documentación bien escrita.

Cuando observo que la gente evita la documentación, me acuerdo de un antiguo refrán sobre los caballos y el agua. Cuando tienes una documentación excelente, hasta los más reticentes verán su valor y se remitirán a ella antes de dedicar tiempo a intentar resolver un reto por sí mismos.

3. Algunas herramientas útiles

Por supuesto, necesitas la herramienta adecuada para la tarea adecuada. Seguro que te has encontrado con varias listas de herramientas de documentación técnica. Yo, desde luego, sí. 

Entonces, ¿qué aportará ésta? Por otra parte, las que he leído rara vez ofrecen algo nuevo. Y las herramientas de autoría están recibiendo mucha atención. Ya las conoces.

Este es un intento de recopilar una lista de valiosas herramientas de productividad para la escritura técnica, o herramientas periféricas, que pueden ayudarte a ser más productivo como escritor técnico de muchas maneras. Y posiblemente te enseñen algo que no sabías antes. ¡Que empiece la fiesta!

Google Meet y Zoom.

Puede que no pienses inmediatamente en Google Meet o Zoom como herramientas de documentación técnica. Sin embargo, para un redactor técnico, producir y construir el material final de la documentación es sólo un elemento del proceso. Y en tiempos como los actuales, en los que muchas organizaciones deben trabajar a distancia, ser capaz de comunicarse rápidamente con arquitectos, ingenieros y revisores es fundamental.

Tú, como yo, probablemente has luchado para que el software de reuniones funcione, con problemas de conectividad regulares, audio distorsionado y otros desafíos. Después de usar Google Meet por primera vez, no miré atras. Por fin tenía un método indoloro para comunicarme con compañeros de trabajo, clientes y para realizar entrevistas técnicas. Además, con Zoom, puedes grabar tus sesiones para no tener que depender de notas parciales o de la simple memoria.

Snagit

Snagit es uno de los favoritos de muchos technical writers, lo que no debería sorprender que aparezca en esta lista. Puede parecer un simple programa de captura de pantalla. Pero es mucho más práctico y potente que cualquier otro programa de capturas de pantalla que haya visto, con funciones interesantes como la Captura de Desplazamiento Panorámico, que te permite capturar algo más que lo que hay en la pantalla. Yo lo uso como una herramienta principal. Y sé que muchos escritores técnicos están de acuerdo, no sólo los que yo conozco, porque las formas, flechas y sellos de la biblioteca de Snagit se pueden encontrar en el material de ayuda por todas partes.

Las ayudas visuales son sencillas de hacer, e incluso puedes hacer cortometrajes de gifs animados para demostrar una característica o concepto en tu documentación. Si necesitas un poco más de potencia, Camtasia, de la misma empresa, es otro gran programa para hacer vídeos.

XWiki

Toda empresa desea una documentación detallada y actualizada. A pesar de ello, que la documentación esté siempre actualizada parece un sueño utópico. Tal vez la documentación de tu empresa solía ser un detallado manual del empleado, minuciosamente investigado, encuadernado en espiral y creado en la empresa. Pero estamos en el siglo XXI, y nadie quiere tener algo así.

Puedes intentar actualizar tu documentación convirtiéndola en digital. Puedes poner determinados documentos de Word en archivos compartidos para todos en tu lugar de trabajo. Eso, sin duda, te proporcionaría algunas funciones útiles. Es digital, se sincroniza en todos los ordenadores de tus empleados y es sencillo escribir y editar… siempre que todos tengan instalado Microsoft Word.

¿Pero qué pasa si necesitas consultar un documento en medio de una reunión y no tienes acceso a tu ordenador? Intenta buscar un determinado procedimiento o enfoque significativo en esos documentos de Word. Al fin y al cabo, documentar todo requeriría un montón de documentos de Word. Entonces sería demasiado fácil que alguien eliminara o modificara algo significativo por accidente, y la única opción para deshacer el error sería restaurar desde una copia de seguridad. Una wiki puede dar vida a tus sueños de documentación.

XWiki simplifica la gestión de datos semiestructurados, que son el núcleo del nexo de conocimiento de toda organización. Simplifica la gestión de datos organizados (como membresías y proyectos) y no estructurados en un único sistema.

XWiki proporciona una sólida API para desarrollar rápidamente aplicaciones empresariales que sean sencillas de mantener y que evolucionen de forma colaborativa. El sistema de skins y plantillas es increíblemente versátil y potente. Aunque los componentes esenciales para transformar XWiki en un sistema semántico avanzado ya existen, se podrían poner a disposición del usuario varias capacidades para facilitar el uso de enlaces, dando paso a una nueva era de intercambio de información colaborativa.

Deepl (para traducir)

¿Es necesario traducir tus documentos? Deepl es un fantástico servicio de “translation memory” basado en nube. Un sistema de memoria de traducción «recuerda» todas las traducciones anteriores y puede cotejar cualquier texto nuevo con esa memoria, mostrando coincidencias completas para su reutilización o coincidencias «difusas» para su rápida edición.

Necesitas una suscripción para aprovechar todo su potencial, pero también hay una versión gratuita si sólo necesitas crear traducciones breves y rápidas, comprobar el recuento de palabras, hacer un análisis de contenido para la traducción, o algo similar

Ryver

Ryver es una fantástica alternativa más económica que Slack. Es una aplicación de mensajería para la gestión de tareas y proyectos. Puedes mantener conversaciones individuales o en grupo… Para mí es una herramienta valiosa porque me permite revisar mis tareas con mi equipo y discutir cualquier aspecto de la tarea que sea difícil de completar. 

Si necesitas organizar tus tareas, Ryver puede ayudarte enormemente. Hace que la creación de listas, la asignación de tareas y el seguimiento de los plazos sea un juego de niños. Es una herramienta excelente. Es bastante práctico poder crear tareas y asignarlas a personas. La interfaz de usuario también es bastante sutil. La experiencia general es fantástica; simplifica la comunicación entre nuestros sitios y fomenta la interacción. Tienes la oportunidad de discutir detalles críticos sobre un trabajo o proyecto, asignar tareas y comprobar si se han completado, lo que fomenta la responsabilidad.

Imagen: Unplash | @tofi

Author

  • Technical Writer at Keepler. "I've been a technical writer and instructional designer for different industries for a decade now and I still haven't stopped learning. When I'm not reading and writing about new methodologies you can find me writing science fiction."