¿Es adecuada para mi empresa la estrategia de contenidos estructurados?

El término documentación técnica entendido en sentido amplio no solo se refiere al ámbito industrial; por ejemplo, la producción de software es un sector con una alta demanda de documentación especializada; el sector farmacéutico, el sector aeronáutico/aeroespacial (en actividades no necesariamente relacionadas con la fabricación) y otros muchos son igualmente demandantes de un gran volumen de documentación técnica.

Un entorno económico cada vez más complejo e interrelacionado exige unos procesos de intercambio de información más eficientes, no solo en el aspecto “mecánico” de la comunicación sino sobre todo en la estructuración de los contenidos. Esta tendencia ha llevado al desarrollo en los últimos años de varios estándares de contenidos estructurados tanto genéricos (DocBook, DITA, etc.) como sectoriales (S1000D aeroespacial, SPL farmacéutico, etc.)

Incluso en aquellos casos en los que la empresa no pertenezca a ninguno de los sectores anteriores pero genere documentación técnica tanto de uso interno como externo (clientes, distribuidores, etc.) puede ser candidata a la implementación de contenidos estructurados si se dan alguna de las siguientes condiciones :

  • producir y gestionar un volumen relevante de documentación técnica
  • producir documentación en varios idiomas
  • documentación en distintos formatos a partir de un mismo contenido
  • la documentación debe aportar una valor añadido significativo al producto/servicio

Beneficios y riesgos

La decisión de adoptar una estrategia de contenidos estructurados en la gestión de la documentación técnica supone un cambio significativo de paradigma en la creación de contenidos. Esta metodología promueve la organización jerárquica y estructuración modular del contenido que junto con la incorporación de metadatos, la separación contenido - formato (estilo) facilita la reutilización, facilita la creación de contenidos consistentes y de calidad y facilita la producción automática de documentos con una variedad de formatos.

Pero como en toda decisión empresarial que comporta un riesgo, estas ventajas y los beneficios que aportan llevan consigo un coste que hay que valorar correctamente y por tanto se necesita diseñar un plan de acción detallado que garantice que los objetivos planteados son alcanzables y que el cambio merece la pena.

Aspectos a considerar en el proyecto

Gestión del cambio de paradigma en la documentación

  • La Gerencia debe respaldar e incentivar el proyecto
  • Los redactores de contenidos deben habituarse a la nueva metodología
  • El departamento de Informática debe dar soporte a las herramientas
  • Participación activa de desarrollo de Producto (SME 'Subject Matter Experts', redactores) como creadores y revisores de contenidos
  • Respuesta de usuarios / consumidores de contenidos

Diseño del modelo de contenidos

  • Mapear los tipos de contenidos actuales con elementos DITA
  • Diseñar los metadatos y su aplicación en la gestión de contenidos
  • Diseñar los atributos para filtrado de contenidos
  • Diseño de mapas (documentos producidos)
  • ¿Se necesita diseñar una Especialización o el modelo estándar DITA es suficiente?

Evaluación de herramientas y provedores

  • Editor XML
  • Gestor de contenidos
  • Procesador de transformaciones
  • Diseño de mapas (documentos producidos)
  • Especificar la funcionalidad requerida y analizar el rendimiento con cada herramienta

Especificación de formatos de producción (transformaciones)

  • Diseño a medida de plantillas y hojas de estilo
  • Presupuestar el coste de las transformaciones

Planificación del proceso de conversión

  • Para los contenidos existentes, decidir la combinación óptima entre convertir y reescribir
  • Definir una guía de estilo y recomendaciones de buenas prácticas
  • Crear prototipos de contenidos y probar las transformaciones

Fases en la implementación del proceso

Una vez analizada la viabilidad y rentabilidad económica del proyecto, corroborado todo ello con los resultados de una fase piloto, arranca el proyecto con las siguientes etapas :

  • Análisis de contenidos y definición de estructuras
  • Definición de los perfiles requeridos para cada función
  • Diseño del nuevo proceso de publicación de contenidos
  • Formación de usuarios en la nueva metodología y herramientas
  • Puesta en marcha del nuevo flujo de trabajo
  • Definición de procedimientos de actualización y mantenimiento del proceso

¿Quiere conocer más sobre el contenido estructurado como base para la Documentación técnica? Contacte con nosotros hoy mismo.