Documentação de software: uma análise comparativa entre documentação tradicional e living documentation

Detalhes bibliográficos
Ano de defesa: 2020
Autor(a) principal: Silva, André Santiago da Fonseca
Orientador(a): Barbosa, Eiji Adachi Medeiros
Banca de defesa: Não Informado pela instituição
Tipo de documento: Dissertação
Tipo de acesso: Acesso aberto
Idioma: por
Instituição de defesa: Universidade Federal do Rio Grande do Norte
Programa de Pós-Graduação: PROGRAMA DE PÓS-GRADUAÇÃO EM TECNOLOGIA DA INFORMAÇÃO
Departamento: Não Informado pela instituição
País: Brasil
Palavras-chave em Português:
Link de acesso: https://repositorio.ufrn.br/handle/123456789/32140
Resumo: Muitos times de desenvolvimento que trabalham com processos ágeis acabam por menosprezar a importância da documentação do software como ferramenta de apoio a capacidade de escalabilidade de suas soluções e de seu processo produtivo. Deixando de observar, de acordo com os valores ágeis, que embora software em funcionamento seja bastante valorizado, ter uma documentação abrangente também pode ser necessário. Em um ambiente de desenvolvimento caracterizado pela alta rotatividade de colaboradores e diversidade de domínios das soluções, o que muitas vezes observamos são equipes de desenvolvimento tentando adaptar atividades de Engenharia de Requisitos e documentação de software dos processos de desenvolvimento ditos tradicionais. Essa situação pode impactar no entendimento dos desenvolvedores quanto ao comportamento das funcionalidades do software, diminuindo o diferencial competitivo da equipe de desenvolvimento ágil. Nesta dissertação quantificamos o impacto que a documentação do software tem no entendimento dos desenvolvedores quanto ao comportamento das funcionalidades de software. Para isso, através de um experimento controlado, fizemos uma análise comparativa entre um tipo de documentação de software caraterístico dos processos de desenvolvimento tradicionais e a living documentation (documentação viva, em tradução livre) gerada a partir da estratégia de Desenvolvimento Orientado ao Comportamento (do inglês Behavior Driven Development - BDD). O estudo chegou a conclusão que, dado o contexto em que se desenvolveu, a documentação tradicional parece facilitar o entendimento quanto ao comportamento das funcionalidades por parte dos desenvolvedores, o que indica que a implantação da living documentation pode ter mais esse desafio a ser vencido na sua implantação.
id UFRN_3ecab1a6a1cc16e08f8e18ecc4c9c75b
oai_identifier_str oai:https://repositorio.ufrn.br:123456789/32140
network_acronym_str UFRN
network_name_str Repositório Institucional da UFRN
repository_id_str
spelling Silva, André Santiago da Fonsecahttp://lattes.cnpq.br/3221668224060624http://lattes.cnpq.br/8833409749475821Cirilo, Elderhttp://lattes.cnpq.br/4349166507859931Kulesza, Uirahttp://lattes.cnpq.br/0189095897739979Barbosa, Eiji Adachi Medeiros2021-04-09T19:22:48Z2021-04-09T19:22:48Z2020-12-28SILVA, André Santiago da Fonseca. Documentação de software: uma análise comparativa entre documentação tradicional e living documentation. 2020. 124f. Dissertação (Mestrado Profissional em Tecnologia da Informação) - Instituto Metrópole Digital, Universidade Federal do Rio Grande do Norte, Natal, 2020.https://repositorio.ufrn.br/handle/123456789/32140Muitos times de desenvolvimento que trabalham com processos ágeis acabam por menosprezar a importância da documentação do software como ferramenta de apoio a capacidade de escalabilidade de suas soluções e de seu processo produtivo. Deixando de observar, de acordo com os valores ágeis, que embora software em funcionamento seja bastante valorizado, ter uma documentação abrangente também pode ser necessário. Em um ambiente de desenvolvimento caracterizado pela alta rotatividade de colaboradores e diversidade de domínios das soluções, o que muitas vezes observamos são equipes de desenvolvimento tentando adaptar atividades de Engenharia de Requisitos e documentação de software dos processos de desenvolvimento ditos tradicionais. Essa situação pode impactar no entendimento dos desenvolvedores quanto ao comportamento das funcionalidades do software, diminuindo o diferencial competitivo da equipe de desenvolvimento ágil. Nesta dissertação quantificamos o impacto que a documentação do software tem no entendimento dos desenvolvedores quanto ao comportamento das funcionalidades de software. Para isso, através de um experimento controlado, fizemos uma análise comparativa entre um tipo de documentação de software caraterístico dos processos de desenvolvimento tradicionais e a living documentation (documentação viva, em tradução livre) gerada a partir da estratégia de Desenvolvimento Orientado ao Comportamento (do inglês Behavior Driven Development - BDD). O estudo chegou a conclusão que, dado o contexto em que se desenvolveu, a documentação tradicional parece facilitar o entendimento quanto ao comportamento das funcionalidades por parte dos desenvolvedores, o que indica que a implantação da living documentation pode ter mais esse desafio a ser vencido na sua implantação.Many development teams that work with agile processes end up underestimating the importance of software documentation as a tool to support the scalability of their solutions and their production process. Failing to observe, according to agile values, that although software in operation is highly valued, having comprehensive documentation may also be necessary. In a development environment characterized by high employee turnover and diversity of solution domains, what we often observe are development teams trying to adapt Requirements Engineering activities and software documentation of the so-called traditional development processes. This situation can impact the developers’ understanding of the behavior of the software functionalities, reducing the competitive advantage of the agile development team. In this dissertation we quantify the impact that the software documentation has on the developers’ understanding regarding the behavior of the software functionalities. For this, through a controlled experiment, we made a comparative analysis between a type of software documentation characteristic of traditional development processes and the textit living documentation generated from the Oriented Development strategy to Behavior (from English textit Behavior Driven Development - BDD). The study came to the conclusion that, given the context in which it developed, traditional documentation seems to facilitate the understanding of the behavior of functionalities by developers, which indicates that the implementation of living documentation may have more of this challenge to be overcome implementation.Universidade Federal do Rio Grande do NortePROGRAMA DE PÓS-GRADUAÇÃO EM TECNOLOGIA DA INFORMAÇÃOUFRNBrasilDesenvolvimento orientado ao comportamentoDocumentação de softwareEngenharia de requisitosDocumentação vivaExperimento controladoDocumentação de software: uma análise comparativa entre documentação tradicional e living documentationSoftware documentation: a comparative analysis between traditional documentation and living documentationinfo:eu-repo/semantics/publishedVersioninfo:eu-repo/semantics/masterThesisinfo:eu-repo/semantics/openAccessporreponame:Repositório Institucional da UFRNinstname:Universidade Federal do Rio Grande do Norte (UFRN)instacron:UFRNTHUMBNAILDocumentacaosoftwareanalise_Silva_2020.pdf.jpgDocumentacaosoftwareanalise_Silva_2020.pdf.jpgGenerated Thumbnailimage/jpeg1198https://repositorio.ufrn.br/bitstream/123456789/32140/2/Documentacaosoftwareanalise_Silva_2020.pdf.jpg53bbce38ef1ce52766ea9e31b14962eeMD52ORIGINALDocumentacaosoftwareanalise_Silva_2020.pdfapplication/pdf2182217https://repositorio.ufrn.br/bitstream/123456789/32140/1/Documentacaosoftwareanalise_Silva_2020.pdfac20e34ad23e0dbfa92bea7122e4110bMD51123456789/321402021-04-11 06:06:19.424oai:https://repositorio.ufrn.br:123456789/32140Repositório de PublicaçõesPUBhttp://repositorio.ufrn.br/oai/opendoar:2021-04-11T09:06:19Repositório Institucional da UFRN - Universidade Federal do Rio Grande do Norte (UFRN)false
dc.title.pt_BR.fl_str_mv Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
dc.title.alternative.pt_BR.fl_str_mv Software documentation: a comparative analysis between traditional documentation and living documentation
title Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
spellingShingle Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
Silva, André Santiago da Fonseca
Desenvolvimento orientado ao comportamento
Documentação de software
Engenharia de requisitos
Documentação viva
Experimento controlado
title_short Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
title_full Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
title_fullStr Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
title_full_unstemmed Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
title_sort Documentação de software: uma análise comparativa entre documentação tradicional e living documentation
author Silva, André Santiago da Fonseca
author_facet Silva, André Santiago da Fonseca
author_role author
dc.contributor.authorID.pt_BR.fl_str_mv
dc.contributor.authorLattes.pt_BR.fl_str_mv http://lattes.cnpq.br/3221668224060624
dc.contributor.advisorID.pt_BR.fl_str_mv
dc.contributor.advisorLattes.pt_BR.fl_str_mv http://lattes.cnpq.br/8833409749475821
dc.contributor.referees1.none.fl_str_mv Cirilo, Elder
dc.contributor.referees1ID.pt_BR.fl_str_mv
dc.contributor.referees1Lattes.pt_BR.fl_str_mv http://lattes.cnpq.br/4349166507859931
dc.contributor.referees2.none.fl_str_mv Kulesza, Uira
dc.contributor.referees2ID.pt_BR.fl_str_mv
dc.contributor.referees2Lattes.pt_BR.fl_str_mv http://lattes.cnpq.br/0189095897739979
dc.contributor.author.fl_str_mv Silva, André Santiago da Fonseca
dc.contributor.advisor1.fl_str_mv Barbosa, Eiji Adachi Medeiros
contributor_str_mv Barbosa, Eiji Adachi Medeiros
dc.subject.por.fl_str_mv Desenvolvimento orientado ao comportamento
Documentação de software
Engenharia de requisitos
Documentação viva
Experimento controlado
topic Desenvolvimento orientado ao comportamento
Documentação de software
Engenharia de requisitos
Documentação viva
Experimento controlado
description Muitos times de desenvolvimento que trabalham com processos ágeis acabam por menosprezar a importância da documentação do software como ferramenta de apoio a capacidade de escalabilidade de suas soluções e de seu processo produtivo. Deixando de observar, de acordo com os valores ágeis, que embora software em funcionamento seja bastante valorizado, ter uma documentação abrangente também pode ser necessário. Em um ambiente de desenvolvimento caracterizado pela alta rotatividade de colaboradores e diversidade de domínios das soluções, o que muitas vezes observamos são equipes de desenvolvimento tentando adaptar atividades de Engenharia de Requisitos e documentação de software dos processos de desenvolvimento ditos tradicionais. Essa situação pode impactar no entendimento dos desenvolvedores quanto ao comportamento das funcionalidades do software, diminuindo o diferencial competitivo da equipe de desenvolvimento ágil. Nesta dissertação quantificamos o impacto que a documentação do software tem no entendimento dos desenvolvedores quanto ao comportamento das funcionalidades de software. Para isso, através de um experimento controlado, fizemos uma análise comparativa entre um tipo de documentação de software caraterístico dos processos de desenvolvimento tradicionais e a living documentation (documentação viva, em tradução livre) gerada a partir da estratégia de Desenvolvimento Orientado ao Comportamento (do inglês Behavior Driven Development - BDD). O estudo chegou a conclusão que, dado o contexto em que se desenvolveu, a documentação tradicional parece facilitar o entendimento quanto ao comportamento das funcionalidades por parte dos desenvolvedores, o que indica que a implantação da living documentation pode ter mais esse desafio a ser vencido na sua implantação.
publishDate 2020
dc.date.issued.fl_str_mv 2020-12-28
dc.date.accessioned.fl_str_mv 2021-04-09T19:22:48Z
dc.date.available.fl_str_mv 2021-04-09T19:22:48Z
dc.type.status.fl_str_mv info:eu-repo/semantics/publishedVersion
dc.type.driver.fl_str_mv info:eu-repo/semantics/masterThesis
format masterThesis
status_str publishedVersion
dc.identifier.citation.fl_str_mv SILVA, André Santiago da Fonseca. Documentação de software: uma análise comparativa entre documentação tradicional e living documentation. 2020. 124f. Dissertação (Mestrado Profissional em Tecnologia da Informação) - Instituto Metrópole Digital, Universidade Federal do Rio Grande do Norte, Natal, 2020.
dc.identifier.uri.fl_str_mv https://repositorio.ufrn.br/handle/123456789/32140
identifier_str_mv SILVA, André Santiago da Fonseca. Documentação de software: uma análise comparativa entre documentação tradicional e living documentation. 2020. 124f. Dissertação (Mestrado Profissional em Tecnologia da Informação) - Instituto Metrópole Digital, Universidade Federal do Rio Grande do Norte, Natal, 2020.
url https://repositorio.ufrn.br/handle/123456789/32140
dc.language.iso.fl_str_mv por
language por
dc.rights.driver.fl_str_mv info:eu-repo/semantics/openAccess
eu_rights_str_mv openAccess
dc.publisher.none.fl_str_mv Universidade Federal do Rio Grande do Norte
dc.publisher.program.fl_str_mv PROGRAMA DE PÓS-GRADUAÇÃO EM TECNOLOGIA DA INFORMAÇÃO
dc.publisher.initials.fl_str_mv UFRN
dc.publisher.country.fl_str_mv Brasil
publisher.none.fl_str_mv Universidade Federal do Rio Grande do Norte
dc.source.none.fl_str_mv reponame:Repositório Institucional da UFRN
instname:Universidade Federal do Rio Grande do Norte (UFRN)
instacron:UFRN
instname_str Universidade Federal do Rio Grande do Norte (UFRN)
instacron_str UFRN
institution UFRN
reponame_str Repositório Institucional da UFRN
collection Repositório Institucional da UFRN
bitstream.url.fl_str_mv https://repositorio.ufrn.br/bitstream/123456789/32140/2/Documentacaosoftwareanalise_Silva_2020.pdf.jpg
https://repositorio.ufrn.br/bitstream/123456789/32140/1/Documentacaosoftwareanalise_Silva_2020.pdf
bitstream.checksum.fl_str_mv 53bbce38ef1ce52766ea9e31b14962ee
ac20e34ad23e0dbfa92bea7122e4110b
bitstream.checksumAlgorithm.fl_str_mv MD5
MD5
repository.name.fl_str_mv Repositório Institucional da UFRN - Universidade Federal do Rio Grande do Norte (UFRN)
repository.mail.fl_str_mv
_version_ 1797777659879489536