¿Es posible tener un sistema de redacción estructurada en una PYME ibérica?

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.