La redacción estructurada es un paradigma de trabajo que tanto atrae como intimida a muchos profesionales del sector de la redacción y comunicación técnica. Es también uno de los temas que más interés ha generado tras el primer encuentro online de MeetContent Iberia, según la encuesta que realizamos entre los participantes.

Es por ello que la redacción estructurada es el tema que hemos elegido para nuestro segundo evento, el 23 de Noviembre a las 18:00. ¡Apúntate!

¿Qué entendemos por redacción estructurada?​

La redacción estructurada es una forma de escritura técnica en la que la documentación es generada a partir de archivos escritos en lenguajes de marcado (markup), como por ejemplo el XML. En general se entiende que el marcado es de carácter semántico, lo cual diferencia a la redacción estructurada de la gran mayoría de formas de redacción digital en las que el marcado indica información de presentación o formato.

Aunque existen multiples implementaciones de los conceptos de redacción escructurada, en el mundo de la redacción y comunicación técnica el estándar más difundido es el Darwin Information Typing Architecture, DITA, una especialización del lenguage XML que suele ser tomada como sinónimo de la redacción estructurada. De esta manera "trabajar en DITA" se opone a formas de redactar contenidos que priman la presentación y el formato, como los procesadores de texto o las herramientas de maquetación.

A grandes rasgos, la redacción estructurada conlleva:

• Separación entre contenido fuente y contenido publicado, lo que permite publicar en multiples formatos a partir del mismo contenido fuente.
• Granularidad/Modularidad del contenido fuente, que puede ser configurado en multiples estructuras, y que permite reutilizar contenidos con relativa facilidad (sin necesidad de cortar y pegar de manera manual).
• Preparar el contenido fuente para poder ser procesados y transformados por herramientas como sistemas de gestión de contenidos o sistemas de traducción/localización.

Internova Sistemas ha publicado un buen resumen de la gestión de contenidos a través de la redacción estructurada en su página web — y además, ¡en el idioma de Cervantes!

¿Por qué me puede interesar la redacción estructurada?​

Existen muchas razones por las que grandes y pequeñas empresas pueden beneficiarse de la redacción estructurada — o, dicho de otro modo, de redactar contenidos en DITA:

• Reutilización de contenido: DITA permite crear contenido modular y estructurado, lo que facilita la reutilización de fragmentos de contenido en diferentes documentos. Esto ahorra tiempo y recursos, ya que no es necesario volver a escribir información similar en múltiples lugares.
• Consistencia: DITA garantiza una estructura y estilo de documentación coherentes en toda la organización. Esto es crucial para mantener una imagen de marca uniforme y una comunicación técnica clara.
• Actualización eficiente: Cuando se necesita actualizar información, DITA simplifica el proceso. Los cambios realizados en un módulo se reflejan automáticamente en todos los documentos que utilizan ese módulo.
• Traducción más sencilla: DITA facilita la traducción de contenido a múltiples idiomas, ya que el contenido está estructurado en unidades independientes que los traductores pueden manejar de manera más eficiente.
• Gestión de versiones: DITA permite un control de versiones más eficaz, lo que es fundamental para documentación técnica y de cumplimiento normativo.
• Búsqueda y recuperación de información: La estructura de DITA hace que sea más fácil buscar y encontrar información en la documentación, lo que mejora la eficiencia en la recuperación de datos.
• Adaptación a múltiples formatos de salida: DITA es compatible con varios formatos de salida, como HTML, PDF, XML, etc., lo que facilita la creación de documentos para diferentes canales y dispositivos.
• Cumplimiento normativo: Para empresas en sectores regulados, DITA puede ayudar a cumplir con requisitos de documentación específicos al facilitar la creación y gestión de contenido estructurado.
• Ahorro de costos a largo plazo: Aunque la implementación inicial de DITA puede requerir inversión en capacitación y herramientas, a largo plazo, suele resultar en un ahorro significativo en tiempo y recursos.

¿Qué es necesario para pasarse a la redacción estructurada?​

La adopción de la redacción estructurada en una empresa es un proceso que requiere planificación y consideración cuidadosa.

• Evaluación de necesidades y objetivos
• Selección de herramientas y software
• Diseño de estructuras de información
• Creación de directrices y estándares
• Capacitación y preparación de las personas involucradas en el projecto
• Conversión/Migración del contenido existente al sistema de redacción estructurada

Cualquier empresa que considera adoptar redacción estructurada con DITA requiere un enfoque estratégico y una inversión en tiempo y recursos, pero esa inversión puede resultar en grandes beneficios a largo plazo en términos de eficiencia y calidad de la documentación.

¿Algún ejemplo?​

Lamentablemente la mayoría de projectos de redacción estructurada forman parte de la propiedad intelectual de diversas empresas y no son accesible al público general. Por suerte existen numerosos projectos no empresariales cuyo código fuente si es accesible.

La documentación del DITA Open Toolkit está creada en DITA, siguiendo el paradigma de redacción estructurada, y su código fuente está disponible en github. Sin embargo, este ejemplo puede ser un tanto abrumador, al tratarse de un projecto real de cara al público con varios años de historia a sus espaldas.

Existen ejemplos más sencillos y fáciles de abarcar, como el Startup DITA Project que mantiene el equipo de SyncRoSoft (autores del editor OxygenXML).

Otro ejemplo cercano al equipo de Meetcontent es el projecto Kawonator, originalmente creado como parte de un curso de postgrado en comunicación técnica impartido por la Academia Vistula en Varsovia. El código fuente fue creado en colaboración con los estudiantes del curso 2021-2022.

¿Dónde puedo aprender más?​

El estándar DITA está disponible online a través de las páginas de OASIS. Es un excelente documento de referencia, pero se trata de un documento técnico que comprensiblemente puede intimidar a principiantes.

Un título clásico en el mundo de la redacción estructurada con DITA es The DITA Style Guide: Best Practices for Authors, publicado originalmente por Tony Self, disponible de manera gratuita en linea gracias a un acuerdo entre el autor y SyncRoSoft.

Pero si estas leyendo esto, puede que lo que más te interese sea ponerte en contacto con otros profesionales en el ámbito Ibérico para ahondar más en el tema — si es así, te esperamos en nuestro evento del día 23 de Noviembre.

Si tienes algo que quieras compartir o alguna idea que quieres que tratemos en MeetContent Iberia, haznoslo saber a través de nuestra encuesta. Y si quieres contactar con cualquiera de los miembros de la comunidad MeetContent, puedes unirte a nuestros canales de Slack.

La semana pasada publicamos un artículo sobre qué es la Redacción Técnica y cómo surgió en la península ibérica. Esta semana, queremos dar respuesta a una de las mayores preguntas que surgen cuando empezamos a indagar en este campo: ¿es lo mismo la Redacción Técnica que la Comunicación Técnica? Si quieres saber cuáles son sus principales diferencias, pero también similitudes, sigue leyendo.

¿Cuáles son las principales diferencias entre Redacción y Comunicación Técnica?​

Sabemos que la Redacción Técnica se refiere específicamente al proceso de escribir documentos técnicos o textos que contienen información técnica y, además, hacerlo de una manera clara y precisa. Es muy probable que hayas visto referirse a las personas que se dedican a la Redacción Técnica como Technical Writers o Technical Authors y cada vez más común como UX Writers.

Por otro lado, la Comunicación Técnica abarca desde el análisis del contexto, la planificación, el desarrollo, la revisión, la Redacción Técnica, la visualización hasta la publicación y distribución del mismo. Así que sí, cuando escribimos en cualquier plataforma, no solo hablaremos de Redacción Técnica, sino que también hablaremos de Comunicación Técnica.

La solución (por lo menos a este problema)​

Desde MeetContent Iberia pensamos que es una buena idea crear un glosario en el que puedas resolver tus dudas con algunos de los términos que más confusión causan. De momento, solo hemos incluido estos dos, ¡pero guárdalo porque iremos añadiendo muchos más!, y si tienes alguna idea o algún término que creas que puede incluirse, háznoslo saber a través de encuesta o ponte en contacto directamente con nosotros a través de Slack.

Si quieres conocer más sobre la Comunicación Técnica, puedes aprovechar el curso que comienza el próximo 31 de octubre en ISTEN-ct, en el que conocerás las claves para entender y mejorar la Comunicación Técnica.

Por último, ¡no olvides apuntarte a nuestro boletín de correo y síguenos en LinkedIn para conocer las siguientes novedades de MeetContent Iberia! Estamos preparando el siguiente evento para noviembre, así que apúntate para no perderte los detalles.

¿Es la Redacción Técnica realmente una profesión reciente en la península ibérica? Hoy te venimos a contar un poco más sobre cómo surge esta profesión en la península, concretamente en España, y cómo evolucionó hasta convertirse en lo que conocemos hoy en día. En este artículo, vamos a contarte cómo surge la necesidad de empezar a redactar documentos técnicos, cuál es considerado el primer manual técnico de la península y, además, te contamos cómo puedes formar parte de este mundo.

¿Cómo surge en España?​

La Redacción Técnica en España tiene sus raíces en la comunicación escrita en el ámbito científico y técnico que se desarrolló a lo largo de la historia del territorio. Es verdad que no tenemos una fecha exacta que marque el comienzo de la Redacción Técnica en España, pero sí que podemos rastrear su evolución a lo largo de los siglos ¡vamos a ello!

Retomemos unos cuantos siglos atrás, situándonos en la Edad Media. Durante la Edad Media se produjeron numerosos manuscritos científicos y técnicos en áreas como la medicina, la astronomía y la ingeniería y la Escuela de Traductores de Toledo, por ejemplo, desempeñó un papel importante en la traducción y difusión de obras científicas y técnicas en Europa durante los siglos XII y XIII y se hizo así cargo de la Redacción y la Comunicación Técnica en España. Aquí puedes encontrar un video sobre cómo se llegó a formar la escuela de Traductores de Toledo y qué relevancia tuvo para la Comunicación y la Redacción Técnica en España.

El Renacimiento también fue un período crucial para el desarrollo, ya que marcó un resurgimiento en el interés por la ciencia y la tecnología. En esta época, se tradujeron y se escribieron numerosas obras científicas y técnicas en español. Sin embargo, la Redacción Técnica moderna, tal como la conocemos hoy en día, se ha desarrollado principalmente en el contexto de la industrialización y la expansión de la educación técnica y científica en el siglo XIX y principios del siglo XX.

¿Cómo surge el término Redacción Técnica y cuándo se empieza a considerar profesión?​

El término de la Redacción Técnica comienza a utilizarse de una manera más frecuente durante y después de la Segunda Guerra Mundial, esto no es algo casual, pues la Segunda Guerra Mundial fue un auge de tecnología y ciencia que desempeñó un papel muy importante durante la guerra y la posguerra. Durante estos periodos es cuando se establecen los roles formales de la profesión como Redactor Técnico en organizaciones gubernamentales, militares e industriales para crear los manuales de instrucciones, informes técnicos y documentación relacionada con proyectos técnicos y científicos.

¿Cúal fue el primer manual técnico?​

Uno de los documentos técnicos más antiguos conocidos en España es el "Libro de los Ingenios y Máquinas" (Libro de los inventos necesarios y de los ingenios y máquinas que figuran en ellas), tradicionalmente atribuído al ingeniero e inventor hispano-milanés Juanelo Turriano (c. 1500-1585). El libro describe una variedad de máquinas y dispositivos mecánicos, incluyendo relojes, molinos, bombas de agua y puentes levadizos. Incluye ilustraciones detalladas y explicaciones técnicas de estos dispositivos, por lo que podría ser considerado uno de los primeros manuales técnicos de la península.

¿Puede cualquier persona dedicarse a la Redacción Técnica?​

La mayoría de las personas que encontramos en el mundo de la Redacción Técnica son personas formadas en ingeniería, sin embargo, no es un requisito tener que haberse formado en ese ámbito, pero sí tener un interés en el producto sobre el que vayas a escribir. Hay muchos otros profesionales que se decican a esto y que vienen del mundo de la mundo de la traducción, periodismo o incluso el marketing.

Si realmente te interesa, te recomendamos que veas este breve video de ISTEN-ct sobre cómo ser un Redactor Técnico de la mano de nuestro compañero Pablo de Eguileor. Pero te adelantamos algo, si quieres dedicarte al mundo de la Comunicación y de la Redacción Técnica lo único realmente necesario es que tengas habilidades de comunicación y un gran interés por aquello que vayas a comunicar.

Me interesa, ¿qué puedo hacer ahora?​

Dedicarse al mundo de la Comunicación y de la Redacción Técnica implica tener algo que decir y aprender a decirlo de una manera simple y sencilla. No es tarea fácil, ¡pero no te preocupes! Si te interesa y quieres aprender más existen formaciones en España que te pueden ayudar, por ejemplo, en ISTEN-ct encontrarás un montón de recursos y cursos para Redactores Técnicos con los que podrás aprender a comunicar de una manera más efectiva.

También puedes unirte a nuestra comunidad en la que realizamos eventos para aprender y compartir experiencias con otras personas interesadas. Apúntate a nuestro boletín de correo y síguenos en LinkedIn para enterarte de cuándo sucederán. Ya estamos preparando el próximo que será en noviembre, así que ¡date prisa!

Además, si tienes algo que quieras compartir o alguna idea que quieres que tratemos en MeetContent Iberia, haznoslo saber a través de esta encuesta. Y si quieres contactar con cualquiera de los miembros de la comunidad MeetContent, puedes unirte a nuestros canales de Slack.

¿Estás listo para la aventura? ¡Te esperamos con los brazos abiertos!

Todos sabemos la importancia del aprendizaje y el crecimiento constante en el mundo profesional. Pero a veces nuestra carrera se desarrolla dentro de un espacio nicho, como la Redacción y la Comunicación Técnica. ¿Qué hacer entonces para ampliar tus horizontes? Puedes encontrar recursos en otras lenguas que se aplican al mercado global, pero si desarrollas tu actividad profesional en la península ibérica, ¿qué recursos tienes a tu alcance?

Cuando Sara, Pablo y Daniel nos conocimos, nos dimos cuenta de que echábamos en falta una comunidad de práctica como las que habíamos visto en Europa o Estados Unidos. Por eso nos decidimos a poner en marcha MeetContent Iberia.

¿Qué es una Comunidad de Práctica?​

Una comunidad de práctica es un grupo de personas que comparten un interés o una profesión común y comparten información y recursos para aprender y mejorar en su área de especialización. En MeetContent Iberia nos enfocamos en la Redacción Técnica y la Comunicación Técnica en España y Portugal. Nuestra comunidad está inspirada en el modelo de comunidades similares en Polonia, MeetContent Krakow y MeetContent Wroclaw, en funcionamiento desde 2017. MeetContent a su vez está basada en el modelo de comunidades más veteranas como Write the Docs.

¿En qué consiste participar en MeetContent?​

Nuestra comunidad está abierta tanto para quienes desarrollan su actividad profesional en el ámbito de la Comunicación Técnica, como para todas aquellas personas interesadas, tengan o no experiencia práctica. La única inversión que necesitas es tu tiempo y tu voluntad de ponerte en contacto con otras personas interesadas en los mismos temas que tú.

• Aprender de otros profesionales: queremos que MeetContent Iberia facilite la oportunidad de conocer a expertos en Redacción Técnica y Comunicación Técnica de diversas empresas en España y Portugal para compartir información y experiencias que nos ayuden a mejorar nuestras habilidades y conocimientos.

• Explorar nuevas herramientas y enfoques: como cualquier ámbito profesional, la Comunicación Técnica está en constante evolución. Una comunidad de práctica facilita mantenerse al día con las últimas herramientas y métodos de trabajo, obtener inspiración y descubrir nuevas formas de abordar los desafíos de nuestro campo.

• Establecer conexiones profesionales, o lo que es lo mismo, networking. Una comunidad de práctica es una de las mejores maneras de establecer conexiones que pueden abrir puertas a oportunidades profesionales y otros projectos.

¿Qué actividades realiza MeetContent?​

La razón de ser de MeetContent es el intercambio de experiencias y la creación de conexiones. Creemos que la mejor manera de llevarlo a cabo son los eventos presenciales — los Meetups. Queremos que nuestra comunidad crezca y que podamos organizar eventos presenciales lo antes posible.

También queremos establecer un espacio para publicar artículos y compartir contenidos de interés. Para mantenerte al tanto de todo lo que hacemos, puedes unirte a nuestro boletín de correo y seguirnos en LinkedIn.

Y si quieres contactar con cualquiera de los miembros de la comunidad MeetContent, puedes unirte a nuestros canales de Slack.

¿Estás listo para conocernos? Apúntate a nuestro primer evento online el 19 de Octubre a las 18:00. Te esperamos con los brazos abiertos.