Software documentation: a comparative analysis between traditional documentation and living documentation
| Autor: | Silva, André Santiago da Fonseca |
|---|---|
| Přispěvatelé: | Cirilo, Elder, Kulesza, Uira, Barbosa, Eiji Adachi Medeiros |
| Jazyk: | portugalština |
| Rok vydání: | 2020 |
| Předmět: | |
| Zdroj: | Repositório Institucional da UFRN Universidade Federal do Rio Grande do Norte (UFRN) instacron:UFRN |
| Popis: | 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. 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. |
| Databáze: | OpenAIRE |
| Externí odkaz: |
|