Producing Just Enough Documentation: The Next SAD Version Problem

Autores
Diaz Pace, Jorge Andres; Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Vidal, Santiago Agustín
Año de publicación
2014
Idioma
inglés
Tipo de recurso
artículo
Estado
versión publicada
Descripción
Software architecture knowledge is an important asset in today´s projects, as it serves to share the main design decisions among the project stakeholders. Architectural knowledge is commonly captured by the Software Architecture Document (SAD), an artifact that is useful but can also be costly to produce and maintain. In practice, the SAD often fails to fulll its mission of addressing the stakeholders´ information needs, due to factors such as: detailed or high-level contents that do not consider all stakeholders, outdated documentation, or documentation generated late in the lifecycle, among others. To alleviate this problem, we propose a documentation strategy that seeks to balance the stakeholders´ interests in the SAD against the efforts of producing it. Our strategy is cast as an optimization problem called "the next SAD version problem (NSVP) and several search-based techniques for it are discussed. A preliminary evaluation of our approach has shown its potential for exploring cost-benefit tradeoffs in documentation production.
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
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: Vidal, Santiago Agustín. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina
Materia
Architecture Documentation Model
Stakeholders
Information Needs
Combinatorial Optimization
Search-Based Techniques
Nivel de accesibilidad
acceso abierto
Condiciones de uso
https://creativecommons.org/licenses/by-nc-sa/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/6790
Acceder
id CONICETDig_399c22da61f2b95f049d51300138ec2e
oai_identifier_str oai:ri.conicet.gov.ar:11336/6790
network_acronym_str CONICETDig
repository_id_str 3498
network_name_str CONICET Digital (CONICET)
spelling Producing Just Enough Documentation: The Next SAD Version ProblemDiaz Pace, Jorge AndresNicoletti, Matías AlbertoSchiaffino, Silvia NoemiVidal, Santiago AgustínArchitecture Documentation ModelStakeholdersInformation NeedsCombinatorial OptimizationSearch-Based Techniqueshttps://purl.org/becyt/ford/1.2https://purl.org/becyt/ford/1Software architecture knowledge is an important asset in today´s projects, as it serves to share the main design decisions among the project stakeholders. Architectural knowledge is commonly captured by the Software Architecture Document (SAD), an artifact that is useful but can also be costly to produce and maintain. In practice, the SAD often fails to fulll its mission of addressing the stakeholders´ information needs, due to factors such as: detailed or high-level contents that do not consider all stakeholders, outdated documentation, or documentation generated late in the lifecycle, among others. To alleviate this problem, we propose a documentation strategy that seeks to balance the stakeholders´ interests in the SAD against the efforts of producing it. Our strategy is cast as an optimization problem called "the next SAD version problem (NSVP) and several search-based techniques for it are discussed. A preliminary evaluation of our approach has shown its potential for exploring cost-benefit tradeoffs in documentation production.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; ArgentinaFil: 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: Vidal, Santiago Agustín. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; ArgentinaSpringer2014-07info:eu-repo/semantics/articleinfo:eu-repo/semantics/publishedVersionhttp://purl.org/coar/resource_type/c_6501info:ar-repo/semantics/articuloapplication/pdfapplication/pdfapplication/vnd.rarapplication/pdfapplication/pdfapplication/pdfhttp://hdl.handle.net/11336/6790Diaz Pace, Jorge Andres; Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Vidal, Santiago Agustín; Producing Just Enough Documentation: The Next SAD Version Problem; Springer; Lecture Notes In Computer Science; 8636; 7-2014; 46-600302-9743enginfo:eu-repo/semantics/altIdentifier/url/http://link.springer.com/chapter/10.1007%2F978-3-319-09940-8_4info:eu-repo/semantics/altIdentifier/doi/10.1007/978-3-319-09940-8_4info: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:58:39Zoai:ri.conicet.gov.ar:11336/6790instacron: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:58:39.478CONICET Digital (CONICET) - Consejo Nacional de Investigaciones Científicas y Técnicasfalse
dc.title.none.fl_str_mv Producing Just Enough Documentation: The Next SAD Version Problem
title Producing Just Enough Documentation: The Next SAD Version Problem
spellingShingle Producing Just Enough Documentation: The Next SAD Version Problem
Diaz Pace, Jorge Andres
Architecture Documentation Model
Stakeholders
Information Needs
Combinatorial Optimization
Search-Based Techniques
title_short Producing Just Enough Documentation: The Next SAD Version Problem
title_full Producing Just Enough Documentation: The Next SAD Version Problem
title_fullStr Producing Just Enough Documentation: The Next SAD Version Problem
title_full_unstemmed Producing Just Enough Documentation: The Next SAD Version Problem
title_sort Producing Just Enough Documentation: The Next SAD Version Problem
dc.creator.none.fl_str_mv Diaz Pace, Jorge Andres
Nicoletti, Matías Alberto
Schiaffino, Silvia Noemi
Vidal, Santiago Agustín
author Diaz Pace, Jorge Andres
author_facet Diaz Pace, Jorge Andres
Nicoletti, Matías Alberto
Schiaffino, Silvia Noemi
Vidal, Santiago Agustín
author_role author
author2 Nicoletti, Matías Alberto
Schiaffino, Silvia Noemi
Vidal, Santiago Agustín
author2_role author
author
author
dc.subject.none.fl_str_mv Architecture Documentation Model
Stakeholders
Information Needs
Combinatorial Optimization
Search-Based Techniques
topic Architecture Documentation Model
Stakeholders
Information Needs
Combinatorial Optimization
Search-Based Techniques
purl_subject.fl_str_mv https://purl.org/becyt/ford/1.2
https://purl.org/becyt/ford/1
dc.description.none.fl_txt_mv Software architecture knowledge is an important asset in today´s projects, as it serves to share the main design decisions among the project stakeholders. Architectural knowledge is commonly captured by the Software Architecture Document (SAD), an artifact that is useful but can also be costly to produce and maintain. In practice, the SAD often fails to fulll its mission of addressing the stakeholders´ information needs, due to factors such as: detailed or high-level contents that do not consider all stakeholders, outdated documentation, or documentation generated late in the lifecycle, among others. To alleviate this problem, we propose a documentation strategy that seeks to balance the stakeholders´ interests in the SAD against the efforts of producing it. Our strategy is cast as an optimization problem called "the next SAD version problem (NSVP) and several search-based techniques for it are discussed. A preliminary evaluation of our approach has shown its potential for exploring cost-benefit tradeoffs in documentation production.
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
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: Vidal, Santiago Agustín. Consejo Nacional de Investigaciones Científicas y Técnicas. Centro Científico Tecnológico Tandil. Instituto Superior de Ingenieria del Software; Argentina
description Software architecture knowledge is an important asset in today´s projects, as it serves to share the main design decisions among the project stakeholders. Architectural knowledge is commonly captured by the Software Architecture Document (SAD), an artifact that is useful but can also be costly to produce and maintain. In practice, the SAD often fails to fulll its mission of addressing the stakeholders´ information needs, due to factors such as: detailed or high-level contents that do not consider all stakeholders, outdated documentation, or documentation generated late in the lifecycle, among others. To alleviate this problem, we propose a documentation strategy that seeks to balance the stakeholders´ interests in the SAD against the efforts of producing it. Our strategy is cast as an optimization problem called "the next SAD version problem (NSVP) and several search-based techniques for it are discussed. A preliminary evaluation of our approach has shown its potential for exploring cost-benefit tradeoffs in documentation production.
publishDate 2014
dc.date.none.fl_str_mv 2014-07
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/6790
Diaz Pace, Jorge Andres; Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Vidal, Santiago Agustín; Producing Just Enough Documentation: The Next SAD Version Problem; Springer; Lecture Notes In Computer Science; 8636; 7-2014; 46-60
0302-9743
url http://hdl.handle.net/11336/6790
identifier_str_mv Diaz Pace, Jorge Andres; Nicoletti, Matías Alberto; Schiaffino, Silvia Noemi; Vidal, Santiago Agustín; Producing Just Enough Documentation: The Next SAD Version Problem; Springer; Lecture Notes In Computer Science; 8636; 7-2014; 46-60
0302-9743
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/chapter/10.1007%2F978-3-319-09940-8_4
info:eu-repo/semantics/altIdentifier/doi/10.1007/978-3-319-09940-8_4
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
application/vnd.rar
application/pdf
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_ 1842269533143826432
score 13.13397

Publicaciones similares