Métricas de la documentación del software
 
 

Prof. Dr. José Ramón Hilera González

E-mail: ccjrhg@cc.alcala.es
 
 

Como ocurre con la cuantificación de la calidad del software, la de un documento también podría realizarse si se consigue identificar un conjunto suficientemente representativo de variables de medida para ello. En este sentido hay que diferenciar, por una parte, la medida de la calidad del texto incluido en un documento, la calidad de la interface del documento con el usuario, la calidad de la estructura del documento, sobre todo en documentos hipertexto o hipermedia, y, por otro lado, la calidad de los diagramas o modelos que aparecen en ellos como consecuencia de haber aplicado alguna metodología de desarrollo de software. En este último caso, el establecimiento de variables de medida es más sencillo, pues vienen impuestas por la propia técnica de modelado, existiendo métricas tanto para modelos estructurados como orientados a objetos.
 
 

Más complicada es la cuantificación de la calidad global de un documento, que normalmente se refiere a la medida de su comprensibilidad. Los principales métodos de medida pueden agruparse en las siguientes categorías establecidas por Lehner [1993]:
 
 

Aunque todo lo anterior es perfectamente aplicable al caso particular de la valoración de la calidad de la documentación de los proyectos de desarrollo de software, especial mención en el campo del software merece el trabajo de [Arhur y Stevens, 1989], quienes han propuesto una serie de indicadores de calidad de los documentos (DQI: Document Quality Indicators) y los han clasificado siguiendo una estructura de descomposición en tres niveles: en el superior se encontrarían los atributos (precisión, completitud, usabilidad, etc.), en el segundo los factores en los que se descompone cada atributo (consistencia sería un factor del atributo precisión, legibilidad del atributo usabilidad, etc.) y en el tercer nivel se situarían la medidas cuantificables en que se descomponen los factores (consistencia conceptual sería una medida del factor consistencia, índice de comprensibilidad lo sería del factor legibilidad, etc.).
 
 

Hay otros autores, como [Torkzadeh y Doll, 1993], que se han especializado exclusivamente en la cuantificación de la calidad de los manuales de usuario, por la importancia comercial de estos documentos, ya que de ellos va a depender en gran medida el grado de satisfacción de los usuarios con la aplicación informática que han adquirido. Estos autores han propuesto y experimentado un método para cuantificar su calidad basado en el tratamiento estadístico de 15 medidas. Para comprobar la incidencia de la calidad de la documentación de usuario en la satisfacción del usuario con el software, estos autores han establecido también un sistema de 12 medidas para valorar tal satisfacción.
 
 

Además de las métricas anteriores, si como afirmamos en [Hilera et al., 1998], la documentación del software puede considerarse un proceso de ingeniería, también será susceptible de ser medida como proceso, además de como producto, utilizando métricas similares a las empleadas en otras ingenierías.
 
 

Referencias
 
 

[Aigrain y Longueville, 1992] P. Aigrain y V. Longueville, "Evaluation of navigational links between images", Information Processing & Management, vol. 28, no. 4, pp. 517-528, 1992.

[Arthur y Stevens, 1989] J.D. Arthur y K.T. Stevens, "Assessing the Adequacy of Documentation Through Document Quality Indicators", Proc. Conference on Software Maintenance, Miami (EE.UU.), 16-19 Octubre, pp. 40-49, IEEE Computer Society Press, 1989.

[Botafogo et al., 1992] R.A. Botafogo, E. Rivlin y B. Shneiderman, "Structural Analysis of Hypertexts: Identifying Hierarchies and Useful Metrics", ACM Transactions of Information Systems, vol. 10, no. 2, pp. 142-180, Abr. 1992.

[Blustein y Webber, 1995] J. Blustein y R.E. Webber, "Using LSI to evaluate the quality of hypertext links", incluido en M. Agosti y J. Allan (Eds.), Information retrieval and automatic construction of hypermedia: a research workshop, ACM, 1995.

[Blustein et al., 1997] J. Blustein, R.E. Webber y J. Tague-Sutcliffe, "Methods for evaluating the quality of hypertext links", Information Processing & Management, vol. 33, no. 2, pp. 255-271, 1997.

[Cruz et al., 1998] I.F. Cruz, S. Borisov, M.A. Marks y T.R. Webb, "Measuring Structural Similarity Among Web Documents: Preliminary Results", incluido en R.D. Hersch, J. André y H. Brown (Eds.), "Electronic Publishing, Artistic Imaging, and Digital Typography", pp. 513-524, Berlin: Springer-Verlag, 1998.

[Dumais, 1991] S.T. Dumais, "Improving the retrieval of information from external sources", Behavior Research Methods, Instruments & Computers, vol. 23, no. 2, pp. 229-236, 1991.

[Hall y Zweben, 1986] W.E. Hall y S.H. Zweben, "The Cloze Procedure and Software Comprehensibility Measurement", IEEE Transactions on Software Engineeering, vol. 12, no. 5, pp. 608-623, 1986.

[Hammond, 1993] N. Hammond, "Learning with Hypertext: Problems, Principles and Prospects", en "Hypertext: A psychological perspective" (C. McKnight, A. Dillon y J. Richardson eds.), Nueva York: Ellis Horwood, 1993.

[Hilera et al., 1998] J.R. Hilera, L.A. González, J.A. Gutiérrez, J.M. Martínez, "Software documentation as an engineering process", ACM SIGSOFT Software Engineering Notes, vol. 23, no. 5, pp. 61-64, 1998.

[Hu y Furuta, 1998] S. Hu y R. Furuta, "A Tool for Maintaining Multi-variant Hypertext Documents", incluido en R.D. Hersch, J. André y H. Brown (Eds.), "Electronic Publishing, Artistic Imaging, and Digital Typography", pp. 525-536, Berlin: Springer-Verlag, 1998.

[Johnson, 1995] S. Johnson, "Control for Hypertext Construction", Communications of the ACM, vol. 38, no. 8, pp. 87, 1995.

[Lehner, 1993] F. Lehner, "Quality control in software documentation: Measurement of text comprehensibility", Information and Management, vol. 25, pp. 133-146, 1993.

[Rada, 1991] R. Rada, "HYPERTEXT: from Text to Expertext", Berhshire (U.K.): McGraw-Hill, 1991.

[Salton, 1989] G. Salton, "Automatic text processing: the transformation, analysis and retrieval of information by computer", Reading (EE.UU.): Addison Wesley, 1989.

[Smeaton, 1996] A.F. Smeaton, "Building Hypertexts Under the Influence of Topology Metrics", incluido en S. Fraïssé, F. Garzotto, T. Isakowitz, J. Nanard y M. Nanard (Eds.), "Hypermedia Design: Proceedings of the International Workshop on Hypermedia Design", pp. 105-106, Springer-Verlag, 1996.

[Torkzadeh y Doll, 1993] G. Torkzadeh y W.J. Doll, "The place and value of documentation in end-user computing", Information and Management, vol. 24, pp. 147-158, 1993.

[Thistlewaite, 1995] P. Thistlewaite, "Automatic construction of open webs using derived link patterns", incluido en M. Agosti y J. Allan (Eds.), Information retrieval and automatic construction of hypermedia: a research workshop, ACM, 1995.

[Thüring et al., 1995] M. Thüring, J. Hannemann y J.M. Haake, "Hypermedia and Cognition: Designing for Comprehension", Communications of the ACM, vol. 38, no. 8, pp. 57-66, Agosto 1995.

[Westland, 1998] J.C. Westland, "Some conditions for cost efficiency in hypermedia", Information Processing & Management, vol. 34, no. 2/3, pp. 309-323, 1998.