Actividades de gestión documental
para la metodología MÉTRICAEl papel de los documentalistas
en el desarrollo
de Sistemas de Información
José R. HILERA, León A. GONZÁLEZ, José
M. MARTÍNEZ, José A. GUTIÉRREZ de Mesa
Departamento de Ciencias de la
Computación
Escuela Politécnica / Facultad de Ciencias de
la Documentación
Departamento de
Ciencias de la Computación
Universidad
de Alcalá
Alcalá de
Henares (Spain)
E-mail:
ccjrhg, leon.gonzalez,
ccjmms, ccjagm@cc.alcala.es
Web: www.cc.alcala.es
Resumen:
Se propone, en los proyectos de desarrollo de software basados
en la metodología MÉTRICA, la realización de actividades relacionadas con la
gestión de los documentos que han de generarse, para conseguir un marco metodológico global de desarrollo documentado del software que facilite su
mantenimiento y reingeniería. Se establecen actividades relacionadas con la planificación, diseño, producción, indización, explotación y mantenimiento de la documentación. Se
descompone cada una de estas actividades en una serie de tareas para un
completo tratamiento de los diferentes aspectos de la gestión de los documentos
implicados en un proyecto de software.
Se presenta también un
conjunto de técnicas para el modelado de la estructura estática y comportamiento dinámico de los documentos, para el modelado de su
presentación ante la audiencia, y y para
su indización, y futura
localización y recuperación durante el desarrollo de los proyectos. Se sugiere la integración, en las
herramientas CASE, de la tecnología que debe dar soporte a las actividades
documentales propuestas, para conseguir entornos integrados de desarrollo
documentado del softwareSe
propone la incorporación de especialistas en
gestión documental en los proyectos de desarrollo de Sistemas de Información,
con la misión de realizar actividades relacionadas con la planificación,
diseño, indización, recuperación y distribución de los documentos. Se define el
término Ingeniero Documental para hacer
referencia a esta nueva figura.
Palabras clave: Ingeniería del Software, Gestión Ingeniería Documental,
Documentación del Software, CASE, Metodología MÉTRICA.Sistema de Información, Documentación del Software.
1. El tratamiento documental en MÉTRICAIntroducción
CoLmo ocurre con la mayor parte de las metodologías de desarrollo de software, MÉTRICA no establece ningún método para la
gestión de los documentos que se deben generar durante las fases del ciclo de vida de los proyectos de software, limitándose, básicamente, a proponer su título y la estructuración de su contenido [1]. Estos documentos, que coinciden en gran medida con los establecidos por la Subdirección General de Coordinación
Informática del Ministerio para las Administraciones Públicas en el “Plan
General de Garantía de Calidad aplicable al desarrollo de equipos lógicos” [2], son los siguientes:
(1) Documento del Plan de Sistemas de Información
(DPSI)
(2) Documento de Especificaciones de
Diseño (DED)
(3) Documento de Diseño Funcional (DDF)
(4) Plan de Pruebas del Equipo Lógico del
Proyecto (PPRB)
(5) Documento de Diseño Técnico (DDT)
(6) Documento de Operación (DOP)
(7) Documentación Técnica de Programación
(DTP)
(8) Informe de las Pruebas de validación
de Módulos (IPVM)
(9) Informe de Pruebas de Integración
(IPI)
(10) Documentación de Procedimientos de
Usuario
Aunque la revisión y aceptación formal de
estos documentos se produce normalmente al final de las diferentes fases
establecidas por MÉTRICA, sus contenidos se van incorporando durante la realización
de las diferentes actividades y tareas en las que se descomponen dichas fases,
correspondiéndose, en muchos casos, los apartados del documento con los nombres
de las tareas o actividades de la metodología. Además, MÉTRICA incluye una guía de adaptación a diferentes
tipos de proyectos. Esta adaptación afecta a la documentación establecida por
la metodología,
recomendando la unificación de documentos o la eliminación de apartados en
función del tipo de proyecto que se trate.
En cuanto a las actividades para la
gestión de los documentos generados, la metodología MÉTRICA sólo lo contempla
en el caso de los de procedimientos de usuario que recogen toda la información
necesaria para que los usuarios sean capaces de utilizar el software desarrollado. Para esta gestión, MÉTRICA propone como
primera actividad del módulo “Desarrollo de Procedimientos de Usuario” de la
fase de Construcción, la preparación de un plan de desarrollo de procedimientos
de usuario que, entre otras, establezca normas sobre el formato y estilo de los documentos, y sobre su
distribución y
mantenimiento.
Sin
detallarlo tanto como en el caso particular de los procedimientos de usuario,
MÉTRICA también contempla al final de cada fase del desarrollo una tarea de
revisión por parte del “Comité de Calidad” de los productos obtenidos
(normalmente documentos), en la que además de comprobar su coherencia y
exactitud, en el caso de los documentos, comprueba que éstos siguen las normas
o estándares establecidos, haciendo las modificaciones oportunas con el
objetivo de ajustarse al máximo a estas normas.a documentación generada durante
el desarrollo de un Sistema de Información es el elemento integrador de las
diferentes actividades y de los diferentes participantes que intervienen, de
una u otra forma, a lo largo del ciclo de vida del sistema; y sin embargo,
es un aspecto al que tradicionalmente se le ha prestado escasa atención. Esto,
como afirma Sommerville [1], ha sido precisamente lo que ha dificultado, a lo
largo de toda la historia de la informática, el mantenimiento de los sistemas
de información.
La
creciente preocupación por este tema ha llevado a organizaciones de
normalización como ISO y ANSI a establecer que la gestión documental debe
considerarse como un proceso más de los que componen el ciclo de vida del
software. En el caso de ISO, en su norma 12207 [2] considera que el proceso de
documentación forma parte del conjunto de los denominados “procesos de apoyo”,
junto con otros como el de Gestión de la Configuración, el
de aseguramiento de la calidad, o el de auditoría. Por su parte, ANSI, en el
estándar 1074 [3], lo considera como uno de los cuatro “procesos integrales”
(los otros serían: gestión de configuración, verificación y validación, y
formación) necesarios para completar con éxito todas las actividades de un
proyecto de desarrollo garantizando un adecuado nivel de calidad. También ISO,
en la influyente norma 9001 sobre sistemas de calidad [4], y en su
correspondiente guía de aplicación al caso del desarrollo de software [5],
establece la necesidad de contemplar el control de la documentación como uno de
los procedimientos necesarios para el aseguramiento de la calidad del software.
Para
llevar a cabo todas las actividades documentales exigidas por estos y otros
estándares, es necesaria la participación de expertos en documentación que se
encarguen de la implantación, en las organizaciones de desarrollo de software,
de Sistemas Integrados de Gestión Documental que, además de la generación y
edición de documentos, soporten otras funciones relacionadas con la
planificación, diseño, indización, recuperación y distribución de toda la
documentación implicada en los proyectos de desarrollo. En los siguientes
apartados se establece el perfil profesional y misión de estos documentalistas,
que han de colaborar con los ingenieros de software para obtener finalmente
sistemas de información con un adecuado nivel de calidad.
2.
El perfil profesional del ingeniero documental
El ingeniero
documental que se integre en un proyecto de desarrollo de software ha de ser
una persona con una sólida formación en el ámbito de las Ciencias de la
Documentación, así como conocedor de las necesidades documentales generales que
se plantean en esta clase de proyectos. Entre las materias que debe dominar un
profesional de este tipo, deben encontrarse las relacionadas con: la
biblioteconomía, el análisis documental, los lenguajes documentales, la
archivística, la recuperación de la información, la planificación y evaluación
de sistemas de documentación, los sistemas de gestión documental, el workflow y
las tecnologías de la información y de la comunicación. La aplicación de estas
disciplinas en el ámbito del desarrollo de sistemas de
información puede incluir los siguientes aspectos:
·Biblioteconomía:
Las técnicas y procedimientos utilizadas en el ámbito bibliotecario pueden ser
perfectamente aplicables en el caso de las organizaciones de desarrollo de
software cuando el volumen de documentación manejada es grande, facilitando así
la localización de los documentos que se necesiten para llevar a cabo las
diferentes tareas en el seno de la organización.
·Archivística:
El conocimiento de los fundamentos de esta disciplina permitirá al ingeniero
documental aplicar métodos y técnicas adecuadas para una correcta conservación
y difusión del patrimonio documental de las organizaciones de desarrollo de sistemas de información.
·Análisis documental:
El objetivo del análisis documental es la representación abreviada de la forma
y contenido de los documentos para facilitar en el futuro su búsqueda y
recuperación. En el caso particular del análisis documental de contenido, esa
representación recibe el nombre de índice, existiendo una norma ISO
(5963) [6] que establece un método estándar para
seleccionar, de un lenguaje de indización tipo tesauro,
los términos de indización que constituirán el índice de un documento. En el
caso del desarrollo de software, el análisis documental ha de ser una de las
principales funciones del ingeniero documental, ya que de la correcta elaboración
de los índices dependerá la eficacia de las
búsquedas que se realicen a lo largo de un proyecto, lo cual puede influir en
gran medida en en el correcto desarrollo del mismo.
·Lenguajes documentales:
Los lenguajes documentales, especialmente los tesauros de descriptores [7], son
los que ofrecen los términos que pueden asociarse a los documentos durante el
análisis. Para conseguir una representación precisa del contenido de los
documentos, existe una gran cantidad de lenguajes de
este tipo, específicos para el contexto o universo del discurso al que se
refieren los documentos (medicina, economía, etc.). El ingeniero documental
debe saber elaborar un lenguaje documental para cualquier ámbito de aplicación,
ya que se debe disponer de un lenguaje adaptado a las necesidades de los
proyectos de desarrollo de software para poder llevar a cabo el análisis de
cada uno de los documento generados.
·Planificación y evaluación de
Sistemas de Documentación: Otra materia
que debe estar presente en el currículum de los ingenieros documentales es la
que hace referencia a la forma de planificar y evaluar el impacto de la
implantación de unidades o sistemas de documentación en las organizaciones. Es
necesario que el profesional que se integre en un proyecto de desarrollo de software
conozca estos temas, ya que deberá participar en la elaboración del plan de
desarrollo del proyecto, en lo que concierne a la planificación de todos los
aspectos relacionados tanto con la documentación que debe generarse durante el
mismo, como con la que ya existe y que deberá ser utilizada en el proyecto.
Sistemas de Gestión Documental: Un
ingeniero documental debe estar familiarizado con el uso de herramientas
informáticas, conocidas como “Sistemas de Gestión Documental” (Document Management Systems) o “Sistemas de
Información Documental” (Document-based
Information Systems), que permiten el control automatizado de los
documentos a través de su ciclo de vida completo en una organización, desde su
creación inicial hasta su archivado final; ofreciendo para ello mecanismos de
edición, identificación, almacenamiento, seguimiento, recuperación y
presentación de los documentos. Puesto que la mayoría de los documentos
utilizados por las organizaciones de desarrollo de Sistemas de Información son
electrónicos, es evidente la conveniencia de incorporar herramientas de este
tipo para facilitar su gestión.
3.
Funciones del Ingeniero Documental en proyectos de software
La
incorporación de expertos en documentación, en los proyectos de desarrollo de
sistemas de información, permitirá mejorar el cumplimiento de los requisitos
exigidos por las normas, estándares y metodologías, sobre calidad y
proceso software, aplicables al proyecto. Para
ello, se debe asignar a estos profesionales un conjunto de tareas documentales
relacionadas: con la planificación y diseño previos a la producción de los
documentos; con la creación o selección del lenguaje documental más adecuado
para el proyecto (por ejemplo un tesauro de descriptores); con la realización
de un análisis de los documentos
producidos para, mediante una operación de indización,
asgnarles los términos del lenguaje documental que permitan repersentar su
contenido; o con la selecciión del lenguaje de búsqueda
utilizado en la explotación de los documentos durante el proyecto de desarrollo
y posterior mantenimiento del software. En los siguientes apartados se describen brevemente el
objeto de estas actividades.
3.2 Planificación de la documentación
Una
de las funciones de los documentalistas debe ser el estudio de las necesidades
de documentación del proyecto de software que se vaya a desarrollar. El
resultado de este esudio debe recogerse en un “Plan de Documentación” que
establezca, entre otros, el tipo de documentos a elaborar, la tecnología que se
utilizará y la secuencia de operaciones para la producción y distribución de
los documentos, y para la construcción del lenguaje documental que se utilizará
durante su indización para facilitar las búsquedas que se realizarán durante el
desarrollo y mantenimiento del sistema de información. Para elaborar este plan,
habrá que realizar, al menos, las siguientes tareas documentales en el seno del
proyecto:
·Identificar
las necesidades de documentación, lo que supone la realización de un análisis
de los diferentes tipos de documentos que deberán producirse, los cuales
vendrán normalmente impuestos por la metodología de desarrollo de sistemas de
información utilizada.
·Establecer
el nivel de detalle apropiado para los documentos, en función del tipo de
proyecto, así como las interrelaciones de cada documento con el resto.
·Planificar
el almacenamiento de los documentos, preveyendo su organización en estructuras
de mayor nivel (carpetas, bases de datos documentales, etc.) en las que se
ordenen en base a deteminados criterios.
·Determinar
la secuencia de operaciones para la producción de los documentos, y su
distribución a la audiencia para su aprobación.
·Si
se estima necesaria la elaboración de un lenguaje documental que facilite las
búsquedas durante la explotación y mantenimiento de los documentos, se deberá
planificar el proceso de construcción de tal lenguaje.
·Decidir,
en base a criterios económicos, la alternativa tecnológica más apropiada para
la implementación de las actividades documentales en el proyecto.
Para
llevar a cabo estas actividades, el ingeniero documental deberá utilizar
técnicas de planificación de proyectos; de estimación de costes; y de
especificación del flujo de trabajo implicado en la producción y distribución
de los documentos, como las utilizadas habitualmente en el ámbito del groupware
[6].
3.2 Diseño de la documentación
En el diseño de las caracterísitcas de los
documentos a producir en el seno de un proyecto de software también ha de
intervenir el ingeniero documental, mediante la descripción de todos los
aspectos necesarios para la construcción de los documentos. En este sentido, el
documentalista debe asumir las siguientes funciones:
·Realizar
una estructuración que permita identificar las partes de los documentos y sus
relaciones, y simplifique su mantenimiento.
·Definir
el comportamiento dinámico o ciclo vital de los documentos que complemente la
dimensión estática anterior para obtener una descripción completa de la
documentación del proyecto de desarrollo de software.
·Opcionalmente,
añadir especificaciones de tipo hipermedial en el diseño de la documentación
para mostrar las posibilidades de navegación a través de hiper-enlaces.
·Establecer
las características de la interface de los documentos con su audiencia
potencial, teniendo en cuenta la determinante influencia de ésta en la
comprensión de su contenido.
Todos
estos aspectos del diseño deben recogerse en diferentes modelos
conceptuales elaborados mediante las
técnicas adecuadas. Puede adoptarse un enfoque de orientación a objetos, adaptando
alguno de los métodos de modelado existentes en el ámbito de la ingeniería del
software (por ejemplo, UML [7]), al caso particular de objetos
documentales. Para el diseño de las características hipermediales de la
documentación y de su interface con el usuario, también pueden aplicarse
técnicas Orientadas a Objetos, como EORM [8] o ADV [9]
respectivamente.
3.3 Elaboración del lenguaje
documental
Una
de las funciones exclusivas del ingeniero documental es la elaboración de un
lenguaje que recoja la terminología utilizada, tanto en el ámbito del proyecto
(condicionada, sobre todo, por la metodología de desarrollo seguida) como en el
dominio de aplicación del sistema de información que se va a desarrollar. Este
lenguaje deberá permitir representar, en forma de índices, el conocimiento
contenido en los documentos generados, para facilitar la realización de
búsquedas documentales, primero durante la ejecución del proyecto, y después
durante el mantenimiento del software.
Por
ser un tipo de lenguaje documental de gran precisión, que ofrece muchas
facilidades en la formulación de consultas de búsquedas, sería muy adecuada la
utilización de un tesauro de descriptores [10]. Su construcción implica el
establecimiento de una serie de términos (descriptores, no-descriptores,
descriptores compuestos, grupos de descriptores) y de relaciones semánticas
entre términos, extraidos del dominio o dominios
temáticos tratados en los documentos del proyecto software. El ingeniero documental encargado de la
elaboración del tesauro deberá colaborar con los ingenieros de software,
recibiendo de éstos propuestas de inclusión de nuevos términos en el lenguaje
según avanza la ejecución del proyecto.
3.4 Indización de la documentación
Para
facilitar el trabajo del personal implicado en el desarrollo de un sistema de
información, que constantemente necesitará consultar documentos elaborados
anteriormente en el seno del proyecto (por ejemplo, un programador consultará
los documentos de diseño, un diseñador los de análisis, etc.), el ingeniero
documental debe llevar a cabo un análisis documental de cada uno de los
documentos producidos, identificando los términos de indización que
constituirán un modelo reducido, denominado índice, que representará su contenido
informativo y que facilitará las búsquedas documentales en el futuro. La
indización de la documentación de un proyecto simplificará su mantenimiento, ya
que cuando se vayan a introducir cambios en algunos documentos, será posible
determinar qué otros también se verían afectados, para poder valorar las
consecuencias que supondrían los cambios.
Si
se dispone de la tecnología adecuada, además de asignar términos extraídos del
lenguaje documental (por ejemplo, un tesauro), cuya elaboración, como se
indicaba en el apartado anterior, también es misión suya, el ingeniero
documental también debe ser capaz de realizar una indización asociativa que
permita la navegación hipermedia, mediante el establecimiento de hiper-enlaces
entre los diferentes contenidos de los documentos. Para facilitar el
mantenimiento de estos enlaces, sobre todo cuando su número es muy grande,
deberá utilizarse alguna técnica de modelado de la estructura de enlaces
establecida para el índice asociativo, que recoja todas las posibilidades de
navegación a través de los documentos del proyecto. Existen algunas técnicas de
este tipo que el ingeniero documental debiera conocer; normalmente se basan en
la teoría de grafos, como la la denominada OCPN (Object Composition Petri Net) [11] o la conocida
como IDM (Interactive
Dinamic Map) [12].
3.5 Control de los documentos
El
control de los documentos de un proyecto es otra de las funciones del ingeniero
documental, tanto en lo que respecta al control de la calidad de la
documentación, como al control de su distribución y archivado final. En el
primer caso, deberá realizar un control de los diferentes factores que inciden
directamente en la calidad de cada uno de los documentos, como la estructura,
determinada por su contenido; el formato y el estilo de escritura. Para ello,
habrá que tener en cuenta las normas y estándares para la documentación
establecidas previamente en la organización, y las recomendaciones de expertos
en el tema [13] [14] [15].
La
distribución y archivado de los documentos ha de controlarse para asegurar que
se cumple lo que se estableció en el “Plan de Documentación” del proyecto
respecto a la forma en que debía circular cada uno de los documentos generado,
y respecto a la política de almacenamiento y custodia de originales, y de
gestión del archivo de los documentos que han de formar parte del patrimonio
documental de la organización. En cuanto al control de la distribución, éste
puede simplificarse en gran medida utilizando un sistema de workflow que
permita diseñar y ejecutar modelos de distribución que garanticen que cuando
cualquier participante del proyecto se disponga a realizar una tarea, reciba de
forma automática los documentos que necesite [6].
4.
Conclusiones
2. Nuevas
actividades de gestión documental para MÉTRICA
Las actividades relacionadas con la documentación que se propone incluir en MÉTRICA constituyen realmente una metodología de gestión documental, con un ciclo de vida
propio que se ha estructurado atendiendo a las necesidades documentales que se plantean en el seno de los proyectos de desarrollo de
software. La primera actividad propuesta será común para todos los documentos; se trata de la planificación y diseño de los
documentos que serán
producidos (figura 1).
Después
de la planificación, se debe proceder a la elaboración de los documentos según
el ciclo de vida que se haya establecido para cada uno de ellos, contemplando,
además del diseño y producción del documento, otras actividades de gestión
relacionadas con su distribución, explotación y mantenimiento. El desarrollo de
varios documentos en paralelo, algo que suele ser habitual, también está
previsto, pudiendo ocurrir que, por ejemplo, se diseñen varios simultáneamente,
que durante la producción de uno se esté diseñando otro, que hasta que no esté
en explotación un documento determinado no se elaboren otros, etc.
Figura 1. Actividades de gestión de los documentos de un proyecto software.
Después
de la planificación, se debe proceder a la elaboración de los documentos según el ciclo de vida que se haya establecido para cada uno de ellos, contemplando,
además del diseño y producción del documento, otras actividades de gestión relacionadas con su distribución, explotación y mantenimiento. El desarrollo de varios documentos en paralelo, algo que suele ser habitual, también está previsto, pudiendo ocurrir que, por ejemplo, se diseñen varios
simultáneamente, que durante la producción de uno se esté diseñando otro, que
hasta que no esté en explotación un documento determinado no se elaboren otros,
etc.
La libertad para determinar el grado de
independencia de la elaboración de unos documentos respecto a otros, o para
decidir en qué momento debe comenzar la
ejecución de cada una de las actividades previstas para cada documento en el seno
de un proyecto, dependerá de la
metodología de desarrollo de software utilizada, en este caso MÉTRICA, y de la estructura de su ciclo de
vida, ya que la misión de los documentos no es
sino registrar información producida por los procesos implicados en el ciclo de
vida del software, para lo cual, las diferentes tareas que constituyen el
proceso de documentación se activarárán a
partir de las necesidades documentales que surjan en el
seno del proyecto.
En el caso de MÉTRICA, existen fases de Análisis, Diseño, Construcción e Implantación; y cada una de
ellas implicará
la elaboración de uno o varios documentos que deberán
ser producidos durante la realización de las actividades establecidas para esa
fase, debiendo estar disponibles para ser explotados durante la siguiente. El diseño de los documentos
generados en una fase puede hacerse en cualquier momento anterior al comienzo de ésta.; sin embargo, su diseño no necesariamente ha de
comenzar entonces, sino que podría haberse hecho en cualquier momento anterior
a la fase durante la que serán producidos.
La combinación de la metodología MÉTRICA con la metodología documental que se propone dará
lugar a un marco
metodológico global cuyo ciclo de vida tiene una estructura bidimensional. En
la dimensión del desarrollo se encontrarán las fases, módulos, actividades y tareas establecidas por MÉTRICA, que componen la secuencia de
operaciones para desarrollar el software, en las que estarán implicados
documentos que han de elaborarse, a su vez, según la secuencia de operaciones
establecida por la metodología documental, constituyendo así la segunda
dimensión metodológica, la documental, que discurrirá en paralelo con la anterior. Según esto, la
evolución en el tiempo de un proyecto dependerá de las actividades a llevar a
cabo en ambas dimensiones, siendo el esfuerzo o trabajo requerido por el
proyecto la combinación del dedicado a la parte de desarrollo y el de la parte
documental
La
integración de ambas metodologías puede llevarse a cabo de diferente manera en función del tipo de
proyecto de que se trate. Una forma podría consistir en la realización de las actividades de
Planificación y Diseño de todos los documentos que exige MÉTRICA antes de comenzar la Fase de Análisis. Posteriormente, durante cada fase de MÉTRICA se
ejecutaría la actividad
de Producción del documento o documentos implicados en esa fase (por ejemplo, el Documento de Especificaciones de Diseño durante la fase de Análisis de Requisitos del Sistema).
Antes de comenzar la siguiente fase debería realizarse también la actividad de
Indización del
documento producido para que, a partir de ese momento,
pueda ser sometido a Explotación y mantenimiento en el seno del proyecto.
Por otra parte, aunque sería
recomendable, no en todos los proyectos se podrá aplicar la metodología
documental propuesta en toda su extensión, bien por limitaciones tecnológicas
(por ejemplo, si no se dispone de la tecnología hipermedia adecuada no se
podrán ejecutar las etapas que se refieren al diseño y producción de hiperdocumentos)
o por no disponer de los recursos suficientes para cada una de las actividades
previstas (por ejemplo, si no existe personal cualificado para la construcción
de un lenguaje documental o para la indización de los documentos).
También puede ocurrir que la complejidad
del proyecto o del software a desarrollar, por reducida, invite a reconsiderar
la conveniencia de algunas etapas. En ese caso, se recomienda no dejar de
ejecutar ninguna de las actividades, sino hacerlo de una forma menos exigente
(por ejemplo, la indización de los documentos se podría basar en un lenguaje
documental tan simple como una lista de palabras clave). En cualquier caso,
todas las decisiones al respecto deberán establecerse al inicio del proyecto y
recogerse en el plan de documentación del mismo.
2.1
Descomposición de las actividades documentales
Los objetivos establecidos para cada una de las actividades documentales, así como su descomposición en
sub-actividades o tareas, son los que se indican a
continuación:
1. Planificación de la documentación: El objetivo de esta actividad es el estudio de las necesidades
de documentación del proyecto de software que se vaya a desarrollar, elaborando
un “Plan de Documentación” que establezca, entre otros, el tipo de documentos a
elaborar, la tecnología que se utilizará y la secuencia de operaciones para la
producción y distribución de los documentos, y para la construcción del
lenguaje documental que se utilizará durante su indización. Este plan será el
punto de partida de la siguiente fase, la de diseño. Las tareas a realizar serán las siguientes: 1) Identificar las necesidades de documentación, 2) Definir los documentos y sus relaciones, 3) Establecer la organización documental, 4) Elaborar el Plan de producción y distribución de
documentos, 5) Elaborar el Plan de construcción del lenguaje
documental, 6) Estudiar diferentes alternativas tecnológicas.
2. Diseño de los documentos: Una vez establecido en el plan
anterior el modo en que se llevará a cabo el proceso de documentación, se
procederá a la descripción, en forma de diferentes modelos conceptuales, de
todos los aspectos necesarios para la producción de cada un de los documentos,
desde los relativos a su estructura interna, hasta los referentes a las
características de su presentación a la audiencia, pasando por otro tipo de
especificaciones, por ejemplo, de tipo hipermedial. También será objeto de esta
fase la revisión del “Plan de Documentación”, ahora que se dispone de una
información más detallada sobre los documentos a producir. Las tareas a realizar serán las
siguientes: 1) Diseñar
la estructura cada documento, 2) Diseñar el comportamiento dinámico de cada documento, 3) Incorporar aspectos hipermediales en el diseño, 4) Diseñar la presentación de los documentos, 5) Revisar el plan de producción y distribución de
documentos.
3. Producción de los documentos: Se trata de generar cada uno de los diferentes documentos necesarios
para la realización del proyecto de desarrollo de software. Cada documento será
elaborado con la información producida durante una o varias tareas del ciclo de
vida del software y servirá de punto de partida para otras tareas del proyecto.
Durante esta fase, en base al contenido que se registre en cada documento,
también se construirá el lenguaje documental que será utilizado en la siguiente
para la indización de los documentos. Las tareas a realizar serán las siguientes: 1)
Preparar el entorno de producción, 2) Producir y revisar los documentos, 3) Construir el lenguaje documental, 4) Liberar (publicar) los documentos.
4. Indización de los documentos: Para facilitar el trabajo del
personal implicado en el desarrollo de software, que constantemente necesitará
consultar documentos elaborados anteriormente en el seno del proyecto (por
ejemplo, un programador consultará los documentos de diseño, un diseñador los
de análisis, etc.), se ha incluido esta actividad, con el propósito de llevar a cabo un análisis del
contenido de cada uno de los documentos producidos, identificando los términos
de indización que facilitarán su localización para consultarlo o modificarlo. Las tareas a realizar serán las
siguientes: 1) Examinar
los documentos, 2) Identificar los conceptos de los documentos, 3) Seleccionar
los términos de indización, 4) Establecer hiper-enlaces
(indización asociativa),
5) Validar los índices
producidos.
5. Explotación y mantenimiento de los documentos: Esta última actividad contempla la utilización de cada
documento para explotar su contenido durante la realización de determinadas
tareas de desarrollo de software. Para ello se llevará a cabo una difusión, o
puesta a disposición de los participantes en el proyecto que la necesiten, de
la información contenida en ellos. También en esta fase se contemplan las
actividades relacionadas con la introducción controlada de modificaciones en
los documentos y con su destrucción por obsoletos, o su almacenamiento en un
archivo para formar parte del patrimonio documental de la organización,
pudiendo ser reutilizados en próximos proyectos. Las tareas a realizar serán las siguientes: 1) Difundir y explotar los
documentos, 2) Realizar el mantenimiento de los documentos, 3) Archivar o
eliminar documentos.
3. Técnicas de gestión documental
La realización de las actividades propuestas relacionadas con la gestión
documental requiere la existencia de técnicas adecuadas para llevarlas a cabo. En el seno
del Grupo de Investigación
en Ingeniería de la Información y de la Documentación de la Universidad de
Alcalá se está trabajando en una decena de técnicas de diferente tipo, aunque
con un elemento integrador,
el documento. Una de
estas técnicas es la denominada Diagrama de Estructura Documental (DED), que permite modelar la estructura y organización estática de
los documentos.
Se han definido otras tres técnicas para modelar los aspectos dinámicos de la
gestión documental, bien desde el punto de vista del trabajo documental a
realizar en el seno de un proyecto, como es el caso del Diagrama de Flujo de Trabajo Documental (DFTD); bien adoptando un enfoque orientado a las
interacciones que se producen entre los documentos durante la realización de
una tarea documental, ofreciéndose para ello el Diagrama de Interacción Documental (DID); o bien modelando la
“vida” de cada documento en particular utilizando un Diagrama de Ciclo de Vida de un Documento (DCVD) [3]. Las técnicas DED, DID y DCVD se
basan en el lenguaje de modelado orientado a objetos UML [4], mientras que para definir DFTD
se han tenido en cuenta, entre otras, las especificaciones de la Workflow Management Coalition [5] y las del Consejo Superior de Informática [6]. Como ejemplo de diagrama de este
tipo, en la figura 2 se muestra el modelo de flujo de trabajo correspondiente
al proceso de producción
de uno de los documentos exigidos por MÉTRICA, se trata del Documento de Especificaciones de Diseño.
El hecho de que en un proyecto los
documentos que se manejarán probablemente sean electrónicos, ha originado la
definición de otra técnica llamada Diagrama
de Presentación de Documentos (DPD), que permite modelar la forma en que su
audiencia va a percibir los contendidos, bien en un formato impreso o a través
de una Interface Gráfica en la pantalla de un computador. En este caso, si los
documentos pueden contener elementos multimedia, además de la disposición
espacial de los contenidos, también habrá que establecer su sincronización temporal
cuando se presenten ante el usuario, para lo cual se ha establecido una técnica
con el nombre de Diagrama de
Sincronización Multimedia (DSM). Si, además, existe la posibilidad de
establecer hiper-enlaces que soporten la indización asociativa que forma parte
de una de las actividades documentales descritas en el apartado anterior, para
poder “navegar” por el contenido de los documentos, se podrán modelar los índices asociativos mediante la técnica
denominada Mapa de Navegación Hipermedia (MNH)
[7].
Además de los hiper-enlaces como
mecanismo de indización, se propone otra técnica de indización basada en un
lenguaje documental: el Tesauro de
Descriptores de un Proyecto Software (TDPS), que reúne todas las características establecidas por ISO para este tipo de
lenguajes [8,9]. La última de las técnicas que se ha definido,
fundamental para la explotación de los documentos, consiste en un Lenguaje
de Búsqueda Documental (LBD), basado en la norma ISO 8777 [10].
Figura
2. Proceso de producción del Documento de
Especificaciones de Diseño (DED)
La elaboración de estas técnicas se ha realizado después de llevar a cabo
una investigación exhaustiva en todos los ámbitos relacionados con los diferentes
aspectos de la gestión documental y del desarrollo de software. Se han asumido
las ideas consideradas más interesantes presentes en otras técnicas
similares, aunque adaptándolas a las necesidades específicas de la
documentación de un proyecto de software.
4. Conclusiones
La realización de las actividades documentales propuestas, en los proyectos basados en MÉTRICA, además de facilitar el mantenimiento del software,
supone el establecimiento de un marco metodológico más amplio que contempla, tanto las tareas propias del proceso de desarrollo de software, como las correspondientes a lo que ISO [11] y ANSI [12] denominan el Proceso
de Documentación, considerado por estas organizaciones como elemento fundamental e integrador en los proyectos de software.
Para
realizar esta incorporación, teniendo en cuenta su complejidad, se ha considerado que el
desarrollo de la documentación debepuede
concebirse como un proceso
de ingeniería, que pretende el diseño, construcción y utilización de los documentos; por lo que se ha establecido un método riguroso de trabajo basado en una
descomposición del proceso documental en etapas (actividades y tareas), en las que se utilizan diferentes técnicas
y herramientas.
En el Departamento de Ciencias de la Computación de la Universidad de Alcalá, en
el que convivimos personas de áreas de conocimiento relacionadas
con la Informática y con la Biblioteconomía y Documentación, se están investigando formas de incorporación, de la tecnología que debe dar soporte a las actividades documentales propuestas, en las herramientas CASE, para conseguir verdaderos entornos integrados de desarrollo documentado del
software que ayuden a mejorar un aspecto
habitualmente descuidado en los proyectos como es la documentación.
Referencias
Referencias
[1] Metodología de Planificación y Desarrollo de
Sistemas de Información. MÉTRICA Versión 2.1. Ministerio para las Administraciones Públicas
(MAP), Madrid, 1995.
Sommerville, I.: Software
Engineering. Addison Wesley, Reading, MA, 1992.
[2] Plan General de
Garantía de Calidad aplicable al desarrollo de Equipos Lógicos. Ministerio para las
Administraciones Públicas (MAP), Madrid, 1991.
[3] Gutiérrez, J.A., Hilera,
J.R., Cerrato, V.: “Generación de Autómatas para el Control del Comportamiento
Dinámico de los Documentos”. Actas de las
III Jornadas Nacionales de Información y Documentación Empresarial,
Universidad de Murcia, 1996, 119-128.
[4] Booch, G., Rumbaugh, J., Jacobson,
I.: Unified Modeling Language (UML). User Guide. Addison-Wesley,
Menlo Park, CA, 1998.
[5] Glossary– A Workflow Management Coalition Specification.
The Workflow Management Coalition, Bruselas, 1994.
[6] Especificaciones
para el Tratamiento de Flujos Automatizados (ESTROFA).
Ministerio para las Administraciones Públicas, Madrid, 1996.
[7] Martínez, J.M., Hilera, J.R.:
“Modelado de Documentación Multimedia e Hipermedia”. Cuadernos de Documentación Multimedia, no.
6-7, 1998.
[8] ISO 2788,
Documentation. Guidelines for the establishment and development of monolingual
thesauri. International Standards
Organization, Ginebra (Suiza), 1986.
[9] ISO 5964,
Documentation. Guidelines for the establishment and development of multilingual
thesauri. International Standards
Organization, Ginebra (Suiza), 1985.
[10] ISO 8777,
Information and Documentation. Commands for interactive text searching. International Standards Organization, Ginebra
(Suiza), 1993.
[11] ISO/IEC
12207, Software Life-Cycle Processes. International Standards
Organization, Ginebra (Suiza), 1995.
ISO/IEC 12207,
Software Life-Cycle Processes, International Standards Organization, Geneva,
Switzerland, 1995.
[123] ANSI/IEEE Std 1074, Standard for
Software Life Cycle Processes. IEEE Computer Society, Nueva ew York, 1991.
[4] ISO 9001, Quality systems -
Model for quality assurance in design, development, production, installation
and servicing. International Standards Organization, Geneva, Switzerland, 1994.
[5] ISO 9000-3, Quality management
and quality system elements - Guidelines for development, supply and
maintenance of software. International Standards Organization, Geneva,
Switzerland, 1991.
[6] Khoshafian,
S., Buckiewicz, M.: Groupware, Workflow and Workgroup Computing. John Wiley
& Sons, New York, 1995.
[7] Unified
Modeling Language - UML. Rational
Software Corp., 1997.
[8] Lange,
D.: An Object-Oriented Design Approach for Developing Hypermedia Information
Systems, Research Report RT0112. IBM Tokyo Research Laboratory, Tokyo, Japan,
1995.
[9] Rossi,
G., Schwabe, D., Lucena, C., Cowan, D.: An Object Oriented Model for Designing
the Human-Computer Interface of Hypermedia Applications”. Proceedings of the
Int. Workshop on Hypermedia Design, Montpellier, France, 1-2 June 1995,
Springer-Verlag & British Computer Society, London, 1996, 123-143.
[10] ISO
2788, Documentation. Guidelines for the establishment and development of
monolingual thesauri. International Standards Organization, Geneva,
Switzerland, 1986.
[] Hilera,
J.R. Aportes metodológicos para la gestión documental en
el desarrollo de software. Tesis doctoral, Universidad de
Alcalá, 1997.