An optimization-based tool to support the cost-effective production of software architecture documentation
- Autores
- Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Diaz Pace, Jorge Andres
- Año de publicación
- 2015
- Idioma
- inglés
- Tipo de recurso
- artículo
- Estado
- versión publicada
- Descripción
- 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.
Fil: Nicoletti, Matías Alberto. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina
Fil: Schiaffino, Silvia Noemi. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina
Fil: Diaz Pace, Jorge Andres. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina - Materia
-
Software Architecture
Architecture Documentation
Multi-Objective Optimization
Stakeholders - Nivel de accesibilidad
- acceso abierto
- Condiciones de uso
- https://creativecommons.org/licenses/by-nc-sa/2.5/ar/
- Repositorio
- Institución
- Consejo Nacional de Investigaciones Científicas y Técnicas
- OAI Identificador
- oai:ri.conicet.gov.ar:11336/6840
Ver los metadatos del registro completo
id |
CONICETDig_db5dc3252729598c3826a0691f8a18db |
---|---|
oai_identifier_str |
oai:ri.conicet.gov.ar:11336/6840 |
network_acronym_str |
CONICETDig |
repository_id_str |
3498 |
network_name_str |
CONICET Digital (CONICET) |
spelling |
An optimization-based tool to support the cost-effective production of software architecture documentationNicoletti, Matías AlbertoSchiaffino, Silvia NoemiDiaz Pace, Jorge AndresSoftware ArchitectureArchitecture DocumentationMulti-Objective OptimizationStakeholdershttps://purl.org/becyt/ford/1.2https://purl.org/becyt/ford/1Some 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.Fil: Nicoletti, Matías Alberto. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; ArgentinaFil: Schiaffino, Silvia Noemi. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; ArgentinaFil: Diaz Pace, Jorge Andres. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; ArgentinaWiley2015-09info:eu-repo/semantics/articleinfo:eu-repo/semantics/publishedVersionhttp://purl.org/coar/resource_type/c_6501info:ar-repo/semantics/articuloapplication/pdfapplication/pdfhttp://hdl.handle.net/11336/6840Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Diaz Pace, Jorge Andres; An optimization-based tool to support the cost-effective production of software architecture documentation; Wiley; Journal of Software: Evolution and Process; 27; 9; 9-2015; 674-6992047-7481enginfo:eu-repo/semantics/altIdentifier/url/http://onlinelibrary.wiley.com/doi/10.1002/smr.1734/abstractinfo:eu-repo/semantics/altIdentifier/doi/10.1002/smr.1734info:eu-repo/semantics/altIdentifier/doi/info:eu-repo/semantics/openAccesshttps://creativecommons.org/licenses/by-nc-sa/2.5/ar/reponame:CONICET Digital (CONICET)instname:Consejo Nacional de Investigaciones Científicas y Técnicas2025-09-03T09:59:02Zoai:ri.conicet.gov.ar:11336/6840instacron:CONICETInstitucionalhttp://ri.conicet.gov.ar/Organismo científico-tecnológicoNo correspondehttp://ri.conicet.gov.ar/oai/requestdasensio@conicet.gov.ar; lcarlino@conicet.gov.arArgentinaNo correspondeNo correspondeNo correspondeopendoar:34982025-09-03 09:59:03.099CONICET Digital (CONICET) - Consejo Nacional de Investigaciones Científicas y Técnicasfalse |
dc.title.none.fl_str_mv |
An optimization-based tool to support the cost-effective production of software architecture documentation |
title |
An optimization-based tool to support the cost-effective production of software architecture documentation |
spellingShingle |
An optimization-based tool to support the cost-effective production of software architecture documentation Nicoletti, Matías Alberto Software Architecture Architecture Documentation Multi-Objective Optimization Stakeholders |
title_short |
An optimization-based tool to support the cost-effective production of software architecture documentation |
title_full |
An optimization-based tool to support the cost-effective production of software architecture documentation |
title_fullStr |
An optimization-based tool to support the cost-effective production of software architecture documentation |
title_full_unstemmed |
An optimization-based tool to support the cost-effective production of software architecture documentation |
title_sort |
An optimization-based tool to support the cost-effective production of software architecture documentation |
dc.creator.none.fl_str_mv |
Nicoletti, Matías Alberto Schiaffino, Silvia Noemi Diaz Pace, Jorge Andres |
author |
Nicoletti, Matías Alberto |
author_facet |
Nicoletti, Matías Alberto Schiaffino, Silvia Noemi Diaz Pace, Jorge Andres |
author_role |
author |
author2 |
Schiaffino, Silvia Noemi Diaz Pace, Jorge Andres |
author2_role |
author author |
dc.subject.none.fl_str_mv |
Software Architecture Architecture Documentation Multi-Objective Optimization Stakeholders |
topic |
Software Architecture Architecture Documentation Multi-Objective Optimization Stakeholders |
purl_subject.fl_str_mv |
https://purl.org/becyt/ford/1.2 https://purl.org/becyt/ford/1 |
dc.description.none.fl_txt_mv |
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. Fil: Nicoletti, Matías Alberto. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina Fil: Schiaffino, Silvia Noemi. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina Fil: Diaz Pace, Jorge Andres. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina |
description |
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. |
publishDate |
2015 |
dc.date.none.fl_str_mv |
2015-09 |
dc.type.none.fl_str_mv |
info:eu-repo/semantics/article info:eu-repo/semantics/publishedVersion http://purl.org/coar/resource_type/c_6501 info:ar-repo/semantics/articulo |
format |
article |
status_str |
publishedVersion |
dc.identifier.none.fl_str_mv |
http://hdl.handle.net/11336/6840 Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Diaz Pace, Jorge Andres; An optimization-based tool to support the cost-effective production of software architecture documentation; Wiley; Journal of Software: Evolution and Process; 27; 9; 9-2015; 674-699 2047-7481 |
url |
http://hdl.handle.net/11336/6840 |
identifier_str_mv |
Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Diaz Pace, Jorge Andres; An optimization-based tool to support the cost-effective production of software architecture documentation; Wiley; Journal of Software: Evolution and Process; 27; 9; 9-2015; 674-699 2047-7481 |
dc.language.none.fl_str_mv |
eng |
language |
eng |
dc.relation.none.fl_str_mv |
info:eu-repo/semantics/altIdentifier/url/http://onlinelibrary.wiley.com/doi/10.1002/smr.1734/abstract info:eu-repo/semantics/altIdentifier/doi/10.1002/smr.1734 info:eu-repo/semantics/altIdentifier/doi/ |
dc.rights.none.fl_str_mv |
info:eu-repo/semantics/openAccess https://creativecommons.org/licenses/by-nc-sa/2.5/ar/ |
eu_rights_str_mv |
openAccess |
rights_invalid_str_mv |
https://creativecommons.org/licenses/by-nc-sa/2.5/ar/ |
dc.format.none.fl_str_mv |
application/pdf application/pdf |
dc.publisher.none.fl_str_mv |
Wiley |
publisher.none.fl_str_mv |
Wiley |
dc.source.none.fl_str_mv |
reponame:CONICET Digital (CONICET) instname:Consejo Nacional de Investigaciones Científicas y Técnicas |
reponame_str |
CONICET Digital (CONICET) |
collection |
CONICET Digital (CONICET) |
instname_str |
Consejo Nacional de Investigaciones Científicas y Técnicas |
repository.name.fl_str_mv |
CONICET Digital (CONICET) - Consejo Nacional de Investigaciones Científicas y Técnicas |
repository.mail.fl_str_mv |
dasensio@conicet.gov.ar; lcarlino@conicet.gov.ar |
_version_ |
1842269558010806272 |
score |
13.13397 |