¿ Cómo funciona DITA ?

La redacción de contenidos estructurados es el proceso por el cual se definen y aplican una serie de criterios de forma consistente para la identificación y segmentación de la información.

Los elementos definidos en DITA tienen una jerarquía preestablecida; para cada elemento se especifica qué elementos puede contener y en cuáles puede estar contenido, igualmente se indica si el elemento es opcional u obligatorio y el orden en el que deben aparecer.

Artículo (Topic)

La unidad básica de contenido estructurado es el artículo (topic) que puede ser utilizado de forma genérica o si se desea identificar con mayor precisión ciertos contenidos se pueden usar versiones especializadas de artículos : Concept, Task, Reference, Glossary Entry :

  • Concept – contiene información conceptual, responde a la pregunta ¿porqué?
  • Task – describe paso a paso un procedimiento, responde a la pregunta ¿cómo?
  • Reference – contiene información de referencia, responde a la pregunta ¿qué?
  • Glossentry – define un término único, responde a la pregunta ¿qué significa ésto?

Para conseguir que los artículos sean fácilmente reutilizables, a la hora de su creación deben aplicarse los siguientes criterios :

  • el artículo debe abarcar un concepto o idea única y responder a una sola pregunta
  • debe ser autocontenido y conciso, debe ser completo en sí mismo
  • no debe dar por supuesto ningún contexto en particular
  • debe ser almacenado como fichero independiente

En principio no existe ninguna limitación en cuanto a la extensión del artículo, que viene definida por la naturaleza de su contenido.

Mapas

El mapa es una estructura utilizada para compilar, organizar y definir las jerarquías entre artículos. Aunque un mapa puede contener un único artículo, lo habitual es que sean varios, dando cuerpo a un documento completo.

El uso del mecanismo de mapas dentro del proceso de elaboración de documentación ofrece flexibilidad y facilita la reutilización de artículos; por ejemplo, si un cierto contenido es común a una familia de productos, se redacta el artículo una sola vez y se reutiliza en todos los documentos referidos a cada uno de los productos.

Los mapas pueden también contener metadatos, tales como: fecha de publicación, propiedad intelectual, versión de producto, etc. Estos metadatos en los mapas ayudan a la Organización a gestionar y distribuir los contenidos de forma más eficiente y a los usuarios a aplicar criterios de búsqueda para seleccionar la información deseada en cada momento.

Producción

La producción del documento es la fase final del proceso y se realiza aplicando una transformación que convierte el contenido DITA, escrito en lenguaje XML, en el formato de salida elegido : PDF, HTML5, WebHelp, EPUB, etc.

Este mecanismo permite una publicación eficiente al :

  • Independizar el contenido del estilo

    En un entorno convencional el autor crea un fichero distinto para cada salida; por ejemplo, una versión para impresión y otra para publicación electrónica. El contenido se crea y formatea al mismo tiempo utilizando un procesador de textos u otra herramienta especializada.

    Con DITA, el autor crea un único conjunto de ficheros con contenidos sin formato y el estilo se decide posteriormente una vez elegido el formato deseado para el documento.

  • Automatizar la aplicación de formato

    Dado que DITA es independiente del estilo, éste se aplica automáticamente mediante hojas de estilo en el proceso de publicación en lugar de manualmente por el autor. De esta forma el autor se concentra exclusivamente en el contenido y no en el aspecto final que tendrá el documento.

Esquema funcional de DITA

Porto

¿Quiere conocer más sobre DITA y su aplicación en la Documentación técnica? Contacte con nosotros hoy mismo.