Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain

Autores
Diaz Pace, Jorge Andres; Villavicencio, Christian Paulo; Schiaffino, Silvia Noemi; Nicoletti, Matías Alberto; Vázquez, Hernán Ceferino
Año de publicación
2016
Idioma
inglés
Tipo de recurso
artículo
Estado
versión publicada
Descripción
The Software Architecture is an important asset in a software development process, which serves to share and discuss the main design concerns among the project stakeholders. The architecture must be properly documented (e.g., via a Wiki environment) to be effectively used by these stakeholders. However, the process of producing architecture documentation often fails to deliver contents that address the stakeholders’ information needs. To address the problem, we argue for a knowledge management strategy in which: (i) architecture documentation is created incrementally; and (ii) its contents are driven by a model of stakeholder preferences. In this work, we present an information optimization approach applied to the architecture documentation domain, derived from an existing documentation method called Views & Beyond. To do so, we define the Next SAD Version Problem (NSVP) and then provide tool support to assist architects in producing cost-effective documentation. Based on prior work, we perform a sensitivity analysis of the optimization model and develop a robust formulation that takes into account uncertainty in the parameter estimations for NSVP instances, thus improving the outcomes of our documentation assistant.
Fil: Diaz Pace, Jorge Andres. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Villavicencio, Christian Paulo. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Schiaffino, Silvia Noemi. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Nicoletti, Matías Alberto. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Vázquez, Hernán Ceferino. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Materia
ARCHITECTURE DOCUMENTATION MODEL
DISCRETE OPTIMIZATION
INFORMATION NEEDS
ROBUSTNESS
SENSITIVITY ANALYSIS
STAKEHOLDERS
Nivel de accesibilidad
acceso abierto
Condiciones de uso
https://creativecommons.org/licenses/by-nc-nd/2.5/ar/
Repositorio
CONICET Digital (CONICET)
Institución
Consejo Nacional de Investigaciones Científicas y Técnicas
OAI Identificador
oai:ri.conicet.gov.ar:11336/58569
Acceder
id CONICETDig_579b4941c436a1a883abe5777779efc8
oai_identifier_str oai:ri.conicet.gov.ar:11336/58569
network_acronym_str CONICETDig
repository_id_str 3498
network_name_str CONICET Digital (CONICET)
spelling Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture DomainDiaz Pace, Jorge AndresVillavicencio, Christian PauloSchiaffino, Silvia NoemiNicoletti, Matías AlbertoVázquez, Hernán CeferinoARCHITECTURE DOCUMENTATION MODELDISCRETE OPTIMIZATIONINFORMATION NEEDSROBUSTNESSSENSITIVITY ANALYSISSTAKEHOLDERShttps://purl.org/becyt/ford/1.2https://purl.org/becyt/ford/1The Software Architecture is an important asset in a software development process, which serves to share and discuss the main design concerns among the project stakeholders. The architecture must be properly documented (e.g., via a Wiki environment) to be effectively used by these stakeholders. However, the process of producing architecture documentation often fails to deliver contents that address the stakeholders’ information needs. To address the problem, we argue for a knowledge management strategy in which: (i) architecture documentation is created incrementally; and (ii) its contents are driven by a model of stakeholder preferences. In this work, we present an information optimization approach applied to the architecture documentation domain, derived from an existing documentation method called Views & Beyond. To do so, we define the Next SAD Version Problem (NSVP) and then provide tool support to assist architects in producing cost-effective documentation. Based on prior work, we perform a sensitivity analysis of the optimization model and develop a robust formulation that takes into account uncertainty in the parameter estimations for NSVP instances, thus improving the outcomes of our documentation assistant.Fil: Diaz Pace, Jorge Andres. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; ArgentinaFil: Villavicencio, Christian Paulo. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; ArgentinaFil: Schiaffino, Silvia Noemi. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; ArgentinaFil: Nicoletti, Matías Alberto. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; ArgentinaFil: Vázquez, Hernán Ceferino. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; ArgentinaSpringer2016-03info: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/58569Diaz Pace, Jorge Andres; Villavicencio, Christian Paulo; Schiaffino, Silvia Noemi; Nicoletti, Matías Alberto; Vázquez, Hernán Ceferino; Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain; Springer; Journal on Data Semantics; 5; 1; 3-2016; 37-531861-20321861-2040CONICET DigitalCONICETenginfo:eu-repo/semantics/altIdentifier/url/http://link.springer.com/article/10.1007%2Fs13740-015-0053-0info:eu-repo/semantics/altIdentifier/doi/10.1007/s13740-015-0053-0info:eu-repo/semantics/openAccesshttps://creativecommons.org/licenses/by-nc-nd/2.5/ar/reponame:CONICET Digital (CONICET)instname:Consejo Nacional de Investigaciones Científicas y Técnicas2025-09-29T10:04:24Zoai:ri.conicet.gov.ar:11336/58569instacron: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-29 10:04:24.938CONICET Digital (CONICET) - Consejo Nacional de Investigaciones Científicas y Técnicasfalse
dc.title.none.fl_str_mv Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
title Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
spellingShingle Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
Diaz Pace, Jorge Andres
ARCHITECTURE DOCUMENTATION MODEL
DISCRETE OPTIMIZATION
INFORMATION NEEDS
ROBUSTNESS
SENSITIVITY ANALYSIS
STAKEHOLDERS
title_short Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
title_full Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
title_fullStr Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
title_full_unstemmed Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
title_sort Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain
dc.creator.none.fl_str_mv Diaz Pace, Jorge Andres
Villavicencio, Christian Paulo
Schiaffino, Silvia Noemi
Nicoletti, Matías Alberto
Vázquez, Hernán Ceferino
author Diaz Pace, Jorge Andres
author_facet Diaz Pace, Jorge Andres
Villavicencio, Christian Paulo
Schiaffino, Silvia Noemi
Nicoletti, Matías Alberto
Vázquez, Hernán Ceferino
author_role author
author2 Villavicencio, Christian Paulo
Schiaffino, Silvia Noemi
Nicoletti, Matías Alberto
Vázquez, Hernán Ceferino
author2_role author
author
author
author
dc.subject.none.fl_str_mv ARCHITECTURE DOCUMENTATION MODEL
DISCRETE OPTIMIZATION
INFORMATION NEEDS
ROBUSTNESS
SENSITIVITY ANALYSIS
STAKEHOLDERS
topic ARCHITECTURE DOCUMENTATION MODEL
DISCRETE OPTIMIZATION
INFORMATION NEEDS
ROBUSTNESS
SENSITIVITY ANALYSIS
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 The Software Architecture is an important asset in a software development process, which serves to share and discuss the main design concerns among the project stakeholders. The architecture must be properly documented (e.g., via a Wiki environment) to be effectively used by these stakeholders. However, the process of producing architecture documentation often fails to deliver contents that address the stakeholders’ information needs. To address the problem, we argue for a knowledge management strategy in which: (i) architecture documentation is created incrementally; and (ii) its contents are driven by a model of stakeholder preferences. In this work, we present an information optimization approach applied to the architecture documentation domain, derived from an existing documentation method called Views & Beyond. To do so, we define the Next SAD Version Problem (NSVP) and then provide tool support to assist architects in producing cost-effective documentation. Based on prior work, we perform a sensitivity analysis of the optimization model and develop a robust formulation that takes into account uncertainty in the parameter estimations for NSVP instances, thus improving the outcomes of our documentation assistant.
Fil: Diaz Pace, Jorge Andres. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Villavicencio, Christian Paulo. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Schiaffino, Silvia Noemi. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Nicoletti, Matías Alberto. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
Fil: Vázquez, Hernán Ceferino. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Conicet - Tandil. Instituto Superior de Ingeniería del Software. Universidad Nacional del Centro de la Provincia de Buenos Aires. Instituto Superior de Ingeniería del Software; Argentina
description The Software Architecture is an important asset in a software development process, which serves to share and discuss the main design concerns among the project stakeholders. The architecture must be properly documented (e.g., via a Wiki environment) to be effectively used by these stakeholders. However, the process of producing architecture documentation often fails to deliver contents that address the stakeholders’ information needs. To address the problem, we argue for a knowledge management strategy in which: (i) architecture documentation is created incrementally; and (ii) its contents are driven by a model of stakeholder preferences. In this work, we present an information optimization approach applied to the architecture documentation domain, derived from an existing documentation method called Views & Beyond. To do so, we define the Next SAD Version Problem (NSVP) and then provide tool support to assist architects in producing cost-effective documentation. Based on prior work, we perform a sensitivity analysis of the optimization model and develop a robust formulation that takes into account uncertainty in the parameter estimations for NSVP instances, thus improving the outcomes of our documentation assistant.
publishDate 2016
dc.date.none.fl_str_mv 2016-03
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/58569
Diaz Pace, Jorge Andres; Villavicencio, Christian Paulo; Schiaffino, Silvia Noemi; Nicoletti, Matías Alberto; Vázquez, Hernán Ceferino; Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain; Springer; Journal on Data Semantics; 5; 1; 3-2016; 37-53
1861-2032
1861-2040
CONICET Digital
CONICET
url http://hdl.handle.net/11336/58569
identifier_str_mv Diaz Pace, Jorge Andres; Villavicencio, Christian Paulo; Schiaffino, Silvia Noemi; Nicoletti, Matías Alberto; Vázquez, Hernán Ceferino; Producing Just Enough Documentation: An Optimization Approach Applied to the Software Architecture Domain; Springer; Journal on Data Semantics; 5; 1; 3-2016; 37-53
1861-2032
1861-2040
CONICET Digital
CONICET
dc.language.none.fl_str_mv eng
language eng
dc.relation.none.fl_str_mv info:eu-repo/semantics/altIdentifier/url/http://link.springer.com/article/10.1007%2Fs13740-015-0053-0
info:eu-repo/semantics/altIdentifier/doi/10.1007/s13740-015-0053-0
dc.rights.none.fl_str_mv info:eu-repo/semantics/openAccess
https://creativecommons.org/licenses/by-nc-nd/2.5/ar/
eu_rights_str_mv openAccess
rights_invalid_str_mv https://creativecommons.org/licenses/by-nc-nd/2.5/ar/
dc.format.none.fl_str_mv application/pdf
application/pdf
dc.publisher.none.fl_str_mv Springer
publisher.none.fl_str_mv Springer
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_ 1844613870035927040
score 13.070432

Publicaciones similares