ArqCheck: A checklist-based approach to architectural document inspection

• Rafael Ferreira Barcelos UFRJ
• Guilherme Horta Travassos UFRJ

DOI: https://doi.org/10.5753/sbqs.2006.15608

Abstract

Software architecture, usually represented by an architectural document, is extremely important to stakeholders since it is used in several moments throughout the software development process. Therefore, due to it importance, the reviewing of architectural documents becomes a fundamental activity for the success of the software project and for the improvement of the software quality. The architectural evaluation approaches described on the technical literature have some limitations related to their use that make difficult to apply them in industrial environments. This work proposes ArqCheck, an approach to inspect architectural documents that aims at minimizing these limitations. Moreover, it describes some results from a feasibility study conducted to evaluate this approach.

Keywords: ArqCheck, document inspection, checklist

References

Babar, M. A., L. Zhu and R. Jeffery (2004). A framework for classifying and comparing software architecture evaluation methods. Proceedings of the Australian Software Engineering Conference, Melbourne, Australia.

Barcelos, R. F. (2006). Uma abordagem para inspeção de documentos arquiteturais baseada em checklist. Dissertação de Mestrado. Rio de Janeiro, Programa de Engenharia de Sistemas e Computação - COPPE/UFRJ.

Barcelos, R. F. and G. H. Travassos (2005). Avaliando documentos arquiteturais através de um checklist baseado em atributos de qualidade. Proceedings of Workshop de Teses e Dissertação de Engenharia de Software (WTES) - SBES, Uberlândia, MG, Brasil.

Barcelos, R. F. and G. H. Travassos (2006). Evaluation Approaches for Software Architectural Documents: a Systematic Review. Proceedings of the Ibero-American Workshop on Requirements Engineering and Software Environments (IDEAS), Buenos Aires, Argentina.

Basili, V., G. Caldieira and H. Rombach (1994). Goal Question Metrics Paradigm. Encyclopedia of Software Engineering. J. J. Marciniak, Wiley. I.

Bass, L., P. Clements and R. Kazman (2003). Software Architecture in Practice, Second Edition, Addison Wesley.

Boehm, B. W. (1981). Software Engineering Economics, Prentice-Hall.

Boehm, B. W. and V. R. Basili (2001). "Software Defect Reduction Top 10 List." IEEE Computer 34(1): 135-137.

Chen, T. Y., P. L. Poon and S. F. Tang (2002). Towards a Problem-Driven Approach to Perspective-Based Reading. Proceedings of the 7th IEEE International Symposium on High Assurance Systems Engineering (HASE'02), Washington, DC, USA, IEEE Computer Society.

Clements, P., F. Bachmann, L. Bass, D. Garlan, J. Ivers, R. Little, R. Nord and J. Stafford (2004). Documenting Software Architectures, Addison-Wesley.

Conradi, R., P. Mohagheghi and T. Arif (2003). Object-Oriented Reading Techniques for Inspection of UML Models - An Industrial Experiment. Proceedings of the European Conference on Object-Oriented Programming, Darmstadt, Germany.

Erickson, R. L., N. D. Griffeth, M. Y. Lai and S. Y. Wang (1993). Software architecture review for telecommunications software improvement. IEEE International Conference on Communications.

Fagan, M. E. (1976). "Design and code inspection to reduce Errors in Program Development." IBM Systems Journal 15(3): 182-211.

Garlan, D. (2000). Software architecture: a roadmap. Proceedings of The Conference on The Future of Software Engineering, ACM Press.

Hollocker, C. P. (1990). Software Reviews and Audits Handbook. New York, John Wiley \& Sons, Inc.

IEEE (2000). IEEE Recommended Practice For Architectural Description Of Software-Intensive Systems - IEEE Standard 1471-2000, Institute of Electrical and Electronics Engineers.

Kalinowski, M. (2004). Infra-Estrutura Computacional de Apoio ao Processo de Inspeção de Software. Dissertação de Mestrado. Rio de Janeiro, Programa de Engenharia de Sistemas e Computação - COPPE/UFRJ.

Laitenberger, O. and J. DeBaud (1998). Scenarios, Quality Attributes, and Patterns: Capturing and Using their Synergistic Relationships for Product Line Architectures. Kaiserslautern, Germany, Fraunhofer Institute Experimental Software Engineering.

MCT/Sepin, Qualidade e Produtividade no Setor de Software, 2005, "Qualidade e Produtividade no Setor de Software". In: http://www.mct.gov.br/sepin/Dsi/Software/Menu_Qualidade.htm accessed in Fevereiro, 2006.

Nasa (1993). Software Formal Inspections Guidebook, NASA Goddard Space Flight Center.

Neto, A. C. D., R. F. Barcelos, W. A. Chapetta, P. S. M. Santos, S. N. Mafra and G. H. Travassos (2004). Infrastructure for Software Engineering Experiments Definition and Planning. Proceedings of the Experimental Software Engineering Latin American Workshop, Brasilia.

Shull, F., J. Carver and G. H. Travassos (2001). An Empirical Methodology for Introducing Software Processes. Proceedings of European Software Engineering Conference.

Shull, F., I. Rus and V. Basili (2000). "How perspective-based reading can improve requirements inspections." IEEE Computer 33(7): 73-79.

Shull, F. J. (1998). Developing techniques for using software documents: a series of empirical studies. Tese de Doutorado, University of Mariland.

Travassos, G. H., F. Shull, J. Carver and V. R. Basili (2002). Reading Techniques for OO Design Inspections, Programa de Engenharia de Software - COPPE/UFRJ.

Tvedt, R. T., P. Costa and M. Lindvall (2002). Does the code match the design? A process for architecture evaluation. Proceedings of the International Conference on Software Maintenance.

Villela, K. (2004). Definição e construção de ambientes de software orientados à organização. Tese de Doutorado, Programa de Engenharia de Sistemas e Computação - COPPE/UFRJ.