An optimization-based tool to support the cost-effective production of software architecture documentation

Abstract

Some of the challenges faced by most software projects are tight budget constraints and schedules, whichoften make managers and developers prioritize the delivery of a functional product over other engineeringactivities, such as software documentation. In particular, having little or low-quality documentation of thesoftware architecture of a system can have negative consequences for the project, as the architecture is the main container of the key design decisions to fulfill the stakeholders? goals. To further complicate thissituation, generating and maintaining architectural documentation is a non-trivial and time-consuming activity.In this context, we present a tool approach that aims at (i) assisting the documentation writer in their tasks and (ii) ensuring a cost-effective documentation process by means of optimization techniques. Ourtool, called SADHelper, follows the principle of producing reader-oriented documentation, in order to focus the available, and often limited, resources on generating just enough documentation that satisfies the stakeholders?concerns. The approach was evaluated in two experiments with users of software architecture documents, with encouraging results. These results show evidence that our tool can be useful to reduce the documentation costs and even improve the documentation quality, as perceived by their stakeholders.