Como se ha visto en el capítulo del estado de la cuestión, existen estándares de documentación software que aportan soluciones en cuanto a la estructura de los documentos y el contenido de los mismos, pero no de una forma directa, como se pretende hacer con una orientación a documentos del proceso software.
0 10 20 30 40 50 60 70 80 90 100 Forward Garousi
3-22 Capítulo 3
Por otro lado, se han estudiado distintos metamodelos para la definición de metodologías que podrían utilizarse para definir metodologías centradas en documentos, con la idea mejorar la calidad de los mismos, al ser los que guían el proceso. Estos metamodelos presentan una serie de carencias que hacen que su aplicación en este sentido sea poco efectiva.
Por último se han visto algunas soluciones parciales con respecto al problema de la documentación software, pero que no cubren todo el ciclo de vida o se centran en ciertos aspectos concretos.
La Tabla 3-10 muestra el impacto de cada una de las soluciones sobre los atributos de calidad seleccionados. Hay que tener en cuenta, sobre todo en las soluciones parciales, que un impacto alto en algún atributo de calidad está limitado al tipo de documentos que manejan, pero no es aplicable a la documentación software en conjunto.
Atributos de calidad de la documentación
Soluciones estudiadas Co Di Tr Cn Ac For Fc Au Or At Fi Estándares
◑
●
●
●
○
◑
◑
◑
●
◑
○
Metamodelos◑
◑
●
◑
○
◑
◑
◑
◑
◑
○
Generadores◑
○
○
○
●
○
●
○
◑
○
●
Wiki-proceso○
●
◑
○
◑
○
○
◑
○
◑
◑
MDD◑
◑
◑
●
●
◑
●
○
◑
○
●
Leyenda: ● Impacto alto, ◑ Impacto medio, ○ Impacto nulo
Co: Completitud, Di: Disponibilidad, Tr: Trazabilidad, Cn: Consistencia, Ac: Actualidad, For: Formato, Fc: Facilidad de creación, Au: Audiencia, Or: Organización de la información, At: Autoría, Fi: Fiabilidad
Tabla 3-10. Impacto de soluciones actuales sobre los atributos de calidad de la documentación.
Analizando los impactos mostrados en la tabla anterior sobre los atributos de calidad de la documentación software, podemos concluir lo siguiente:
El atributo de Completitud obtiene un impacto medio por parte de los estándares, debido al problema entre la desconexión entre tareas y su documentación. En los metamodelos, debido a las carencias que presentan para abordar metodologías centradas en documento, el impacto también es medio. El impacto medio sobre los generadores de documentación a partir del código fuente o de sistemas de desarrollo guiado por modelos es debido a que sólo cubren este tipo de documentación.
El atributo de Disponibilidad, altamente valorado tanto en Forward como en Garousi, obtiene un impacto de nivel alto en estándares. Esto es debido a la existencia de procesos bien definidos para la gestión de la documentación. Los metamodelos presentan un impacto de nivel medio por las carencias presentadas tanto en el capítulo del estado de la cuestión como en el de la
Capítulo 3 3-23
definición del metamodelo. La solución de integración de una wiki con el proceso software aporta un impacto alto en este atributo. Básicamente es el atributo en el que se centra esta solución. En el caso del MDD, el impacto es parcial debido a que sólo cubre unos documentos específicos de desarrollo.
Trazabilidad, aunque es un atributo con una valoración dispar en ambos
estudios, sigue siendo un atributo importante y recibe un impacto de alto nivel por parte de los estándares, en los que la trazabilidad siempre está presente en la definición de los documentos. En el caso de los metamodelos el impacto también es alto, ya que es una característica específica de SPEM. La solución wiki-proceso mantiene cierta información histórica sobre los documentos que le otorga un impacto medio sobre la trazabilidad. La solución basada en MDD tiene un impacto medio sobre la trazabilidad, ya que se pueden seguir los documentos a través de los niveles de abstracción y las reglas de transformación.
El atributo de Consistencia tiene un impacto alto por parte de los estándares y medio por parte de los metamodelos. En el primer caso, la descripción de los contenidos de las distintas partes de los documentos asegura la consistencia entre ellas. En el caso de los metamodelos, éstos no pueden asegurar la consistencia más allá de lo que describan las metodologías de partida. En el caso de MDD, la consistencia viene asegurada for la propia forma de trabajar: la documentación se genera a partir de los modelos, impactando de forma alta en este atributo. Las reglas sintácticas y semánticas de los modelos ayudan en gran medida en este sentido.
El atributo de Actualidad es uno de los que presenta más problemas, como hemos visto en los estudios de Forward y Garousi. Actualizar la documentación software es algo que se hace con poca frecuencia. Por esa razón, no está bajo la influencia de los estándares ni de los metamodelos. No obstantes, los generadores de documentación a partir de código fuente obtienen unos documentos plenamente actualizados. Lo mismo ocurre con los generadores de documentación en sistemas que siguen MDD. El impacto en este caso es alto, aunque se restringe a sólo unos cuantos documentos del proceso. Por su parte, la wiki anima a los desarrolladores a mantener la documentación (de cualquier tipo) actualizada. Es por ello que tiene un impacto medio sobre este atributo.
El atributo de Formato tiene un impacto medio por parte de los estándares y de los metamodelos. En el caso de los estándares, no se entra en nivel de detalle suficiente como para definir completamente el formato de los documentos. Los metamodelos dependen del ingeniero de método para influir en este atributo.
Facilidad de creación es un atributo definido por Forward y se puede
considerar como el último de los atributos importantes. Los estándares presentan un impacto medio sobre este atributo, ya que dan indicaciones sobre
3-24 Capítulo 3
el contenido de los documentos, pero no de una forma directa. En la mayoría de los casos presentan plantillas que facilitan el trabajo, pero esto no suele ser suficiente. Como en el caso anterior, los metamodelos facilitarán el trabajo de creación de documentos en la medida en la que lo haga el ingeniero de método que los utilice. Por esta razón, su impacto es medio sobre este atributo. Los generadores de documentación a partir de código y de MDD, al ser herramientas automáticas tienen un impacto alto sobre la facilidad de creación de documentos. Se trata de un proceso automático resultado del trabajo de codificación o modelado por parte de los desarrolladores. No obstante, hay que tener en cuenta que los documentos generados son sólo los asociados a estas actividades.
El de Audiencia, tiene un impacto medio por parte de los estándares. Normalmente en los estándares se indica a quien va dirigido un determinado documento, pero a nivel del documento completo. No aportan suficiente nivel de detalle en este sentido. Por la misma razón que en los casos anteriores, los metamodelos podrán definir la audiencia a la que se dirigen los documentos en función del uso que haya hecho el ingeniero de método a la hora de definir la metodología. Su impacto, por tanto, es medio. También tiene un impacto medio en el caso de la wiki, ya que cuando un documento se añade al repositorio común, sí se pretende indicar la audiencia del mismo. Sin embargo es el documento completo al que se dirige la audiencia y no se tiene en cuenta esto a la hora de crearlo, sino de distribuirlo.
El atributo de Organización tiene un impacto alto por parte de los estándares: las plantillas que aportan indican cómo está organizada la información en los documentos de forma muy precisa. Los metamodelos pueden definir la estructura de los documentos pero, de nuevo dependen de la labor del ingeniero de método, por lo que su impacto es medio. Los generadores de documentación desde código fuente o MDD tienen un impacto medio debido a que cubren sólo unos cuantos documentos del proceso.
El atributo de autoría tiene un impacto medio por parte de los estándares, ya que los autores aparecen a nivel de documento completo, sin llegar a especificar quién es autor o responsable de cada parte. En el caso de los metamodelos, el impacto es medio debido a las carencias que presenta en la relación productor-producto. La wiki presenta el mismo problema que en los estándares: la autoría se refiere a documentos completos, no a sus partes. Por esta razón el impacto es medio.
La fiabilidad de la documentación es un atributo de calidad que no puede ser
impactado por los estándares ni por los metamodelos debido a que siguen el punto de vista de realizar tareas y luego documentarlas. Esto hace que el contenido de los documentos pueda considerarse poco fiable. En el caso de los generadores de documentos, tanto desde código fuente o MDD, el contenido
Capítulo 3 3-25
de los mismos es un fiel reflejo de las tareas de codificación y modelado, por lo que tienen un alto impacto en cuanto a la fiabilidad (en el sentido de que contienen un reflejo fidedigno de la realidad). El impacto se puede considerar alto, aunque hay que seguir teniendo en cuenta que sólo generan unos determinados documentos de proceso. La wiki puede aportar cierta mejora al atributo de fiabilidad, aunque sólo sea porque se puede comprobar cuándo un documento fue incluido en el repositorio. Esto le otorga un impacto medio sobre el atributo de fiabilidad.
Como se puede observar, todas las soluciones aportan alguna mejora sobre los atributos de calidad de la documentación, pero son los estándares y la generación de documentación en entornos MDD los que mayor número de impactos altos tiene sobre estos atributos. La adopción de estándares y su cumplimiento exhaustivo solucionarían los problemas de la documentación software, pero se ha visto a través de los estudios realizados que no se respeta este cumplimiento. Por otro lado, los generadores de documentación en MDD tienen la ventaja de la automatización de la documentación. Esto le otorga un impacto importante sobre la calidad de la documentación software, pero tienen el problema de no cubrir todos los aspectos necesarios en la documentación de un proyecto. Sólo ayudan en el proceso de desarrollo, aunque de una manera muy positiva.