Menú
Logo Internova

La gestión de contenidos técnicos como objetivo de negocio en la empresa industrial

Manuales técnicos

Se ha planteado vd. alguna vez estas preguntas:

  • ¿Tiene nuestra documentación técnica un nivel de calidad equiparable al que exigimos para nuestros productos?

  • ¿Qué es lo que los clientes esperan encontrar y qué valor aporta para ellos la documentación de nuestros productos?

  • ¿Qué costes ocultos se asumen al adquirir un producto con una documentación incompleta o deficiente?

  • ¿Porqué debemos considerar la documentación técnica como un componente más del propio producto?

  • ¿Cómo convertir nuestra documentación técnica en una eficaz herramienta de venta y elemento diferenciador frente a la competencia?

  • ¿Cómo transformar la documentación técnica en un activo rentable reutilizándola en otras áreas de la empresa?

Si considera que alguna de las preguntas anteriores es relevante para su negocio puede que le interese seguir leyendo. Si por el contrario, la documentación técnica no es un tema que le preocupe, le recomendamos que cierre la página; no queremos que pierda vd. el tiempo.

La documentación técnica en la industria

Tradicionalmente la documentación técnica ha ido a remolque del desarrollo del producto y se ha considerado como un centro de costes que hay que mantener lo más bajo posible; y se considera solo como coste porque no hay un método sencillo de cuantificar los beneficios y/o el ahorro de gastos que produce.

Hoy en día es difícil pensar en cualquier empresa industrial que se mantenga en el mercado y no tenga implementado ciertos procedimientos de control de calidad de sus productos. Sin embargo la documentación técnica, que forma parte del producto con los mismos derechos que cualquier otro componente mecánico, electrónico, software, etc. no suele estar sujeta a ningún control de calidad.

Se considera justificado devolver un producto defectuoso o que no funciona, pero se acepta que venga con una documentación incompleta y/o deficiente ignorando los costes ocultos que esta circunstancia lleva asociada. Para los clientes esto se traduce en mala utilización del producto, averías, bajo rendimiento, pérdida de tiempo en consultas al servicio técnico, etc. y para la empresa en una percepción negativa del producto y mala imagen además de un trabajo adicional para el soporte técnico.

A diferencia de los contenidos de márketing en los que se presupone una intención persuasiva, los contenidos técnicos tienen un objetivo claramente informativo y si son de calidad presentan las características y funcionalidad del producto de forma objetiva y por tanto tienen mucha más credibilidad para el cliente interesado en valorar estos detalles antes de comprar.

Poner a disposición del potencial cliente la documentación técnica del producto, o parte de ella, durante el proceso de evaluación antes de tomar la decisión de compra puede resultar la más convincente argumentación de venta.

Si estamos convencidos de la calidad de nuestro producto y de su documentación técnica, no tenemos que ocultarla sino aprovecharla en la labor comercial porque probablemente muchos de nuestros competidores no puedan hacer lo mismo.

Estrategia de contenidos estructurados para la gestión de la documentación técnica

Contenido estructurado

La estrategia de contenidos es un tipo de gestión que busca mejorar la eficiencia del negocio atacando en dos frentes: por un lado aumentando la rentabilidad generada por los contenidos técnicos y por el otro reduciendo los costes de su elaboración.

Aunque la documentación técnica no goza del prestigio de otras disciplinas en el ámbito tecnológico, esto no quiere decir que no haya avanzado mucho en los últimos años en la aplicación de nuevas técnicas y metodologías para su gestión. Hoy en día existe un consenso general en la industria acerca de las ventajas que supone la estructuración de contenidos en la creación y gestión de la documentación técnica.

El contenido estructurado es un tipo de segmentación que se aplica al contenido tradicional y que tiene las siguientes características:

  • Granularidad / Modularidad

El contenido estructurado está compuesto por pequeñas piezas de contenido que abarcan un único concepto o tema concreto, denominadas genéricamente topics, son independientes unas de otras, es decir, cada una cubre una pequeña parcela del conocimiento y no se solapan entre sí.

  • Etiquetado semántico

El topic no es un mero recorte que incluye una pequeña parte del contenido tal cual viene en origen sino que tiene una estructura interna determinada y que se representa mediante unas etiquetas (tags). Estas etiquetas asignan un significado específico (de ahí el término etiquetado semántico) a elementos de más bajo nivel como pueden ser palabras individuales, frases, párrafos, listas, tablas, etc.

  • Independencia del formato final

En la redacción de contenido estructurado se trabaja con contenido ‘puro’ que no lleva asociado ninguna información de estilo (tipo de letra, tamaños, interlineados, saltos de página, etc.) porque el objetivo es que el mismo contenido sirva para ser publicado en cualquier formato y soporte (PDF impreso, PDF electrónco, HTML, WebHelp, etc.) Esta adaptación al formato final de la publicación se realiza de forma automática en un proceso de transformación posterior.

Estos son algunos de los beneficios que se obtienen al trabajar con contenido estructurado:

  • Mayor productividad en la redacción al separar el contenido del formato.
  • Reutilización de contenidos automática sin necesidad de copiar y pegar manualmente.
  • Ahorro en traducciones y adaptaciones.
  • Contenidos de mayor calidad con un estilo de redacción uniforme y consistente.
  • Se facilita la indexación y búsqueda automática de contenidos con el uso de metadatos.

DITA XML, el estándar de la industria para el contenido estructurado

DITA XML

DITA es una arquitectura basada en lenguaje XML para la creación de contenidos estructurados y para la organización y gestión de documentación técnica; fue desarrollada originalmente por IBM para gestionar la elaboración de su propia documentación técnica y posteriormente cedida en 2005 a OASIS (Organización para el Avance de los Estándares de Información Estructurada) como estándar abierto, neutro e independiente de cualquier herramienta o sistema informático.

Conceptos básicos de la arquitectura DITA:

  • Topic: Es la unidad elemental en la que se fragmenta el contenido.
  • Mapa: Es la estructura que define los componentes y la jerarquía de topics que constituyen un determinado documento o publicación.
  • Procesado condicional: Son las reglas que especifican, a través de metadatos, los criterios de filtrado por los que se incluyen o excluyen determinados elementos de los topics en función del usuario final y del tipo de documento a publicar.
  • Transformación: Es el proceso realizado por una aplicación informática para generar de forma automática los documentos a partir del mapa o mapas, aplicando las reglas de procesado condicional y las hojas de estilo (stylesheets).

Esquema funcional DITA

Documentación técnica avanzada

Documentación técnica avanzada

Llamamos documentación técnica avanzada a un tipo específico de contenido técnico que se caracteriza por ofrecer la posibilidad de interaccionar dinámicamente con ese contenido facilitando así la compresión del concepto que se pretende transmitir al usuario.

Este tipo de contenido interactivo es un complemento de los contenidos convencionales y en la mayoría de los casos se construye a partir de modelos 3D del producto; también se pueden crear, mediante programación, documentos interactivos en formato PDF para, por ejemplo, sustituir contenidos tabulados por objetos dinámicos.

Por exigencias de la interactividad, este contenido es siempre digital y no es aplicable a la documentación impresa; puede ser distribuido tanto en versión online a través de la web como offline en formato PDF 3D.

El uso de la documentación interactiva no solo consigue una mayor eficacia en la transmisión de la información y del conocimiento sino que también aporta una percepción de calidad superior por parte del cliente y supone un factor diferencial frente a la competencia.

Ejemplos

¡ATENCIÓN! : El visor PDF del navegador no soporta modelos 3D ni interactividad. Para explorar los modelos 3D interactivamente descargar los ficheros PDF en disco (Guardar enlace como ...) y abrirlos con Adobe Reader.

Si es la primera vez que trabaja con un modelo 3D en PDF, lea antes las siguientes instrucciones para configurar Adobe Reader : Cómo explorar un modelo 3D en PDF (Exploración-PDF-3D.pdf)

Servicios de consultoría en contenidos técnicos

Servicios de consultoría

  • El mercado nos obliga a ciclos de desarrollo de producto cada vez más cortos.
  • Nuestra organización tiene dificultades para producir la documentación técnica al ritmo que demanda el mercado.
  • Debemos producir versiones en distintos idiomas o incluso adaptaciones a mercados y clientes específicos.
  • El cliente requiere acceder tanto offline como online a una documentación permanentemente actualizada.
  • Existe el temor de que nuestra documentación técnica no alcance el nivel de calidad exigido por el cliente y de que podamos ser penalizados por el mercado.

Si después de haber reflexionado sobre los puntos anteriores se siente identificado con alguno de ellos en su empresa y se ha convencido de que los contenidos técnicos tienen un impacto en el negocio mayor de lo que hasta ahora pensaba, seguramente también existe un amplio margen de mejora en este aspecto y por tanto ahora es el momento de tomar medidas para abordar y solucionar el problema.

¿Cuál es la mejor estrategia para lograr unos contenidos técnicos eficaces y de calidad?

Esta misma pregunta se la han planteado muchas organizaciones desde hace tiempo y aunque no existe una solución única válida para todos los casos, hay un consenso en la industria en que un enfoque de contenidos estructurados adaptado a cada situación particular es la solución que mejores resultados aporta.

Podemos asesorarle acerca del tipo de servicio que mejor se ajusta a sus necesidades.

  • Implementación de la estrategia de contenidos estructurados.
  • Auditoría de contenidos técnicos.
  • Evaluación de calidad de la documentación técnica.
  • Análisis del ciclo de vida de los contenidos técnicos.
  • Adopción del estándar DITA XML.
  • Organización y optimización de procesos.
  • Herramientas software CCMS e integración con otras plataformas.

Si está vd. interesado en mejorar la calidad y eficacia de sus contenidos técnicos, por favor póngase en contacto con nosotros.

Contacto

Internova Sistemas

C/ Pérez de Victoria, 6
28023-Madrid
(España)

Correo electrónico

info@internovasistemas.com

Teléfono

(34) 659 27 33 64