GAIADOC : uma ferramenta de documentação de código fonte direcionada aos requisitos de negócio

• Main Author: Humberto Ferreira da Luz Junior
• Other Authors: Rodolfo Miranda de Barros .
• Language: Portuguese
• Published: Universidade Estadual de Londrina. Centro de Ciências Exatas. Programa de Pós-Graduação em Ciência da Computação. 2013
• Online Access: http://www.bibliotecadigital.uel.br/document/?code=vtls000185599

Com o objetivo de preencher uma lacuna nos métodos tradicionais de documentação de código fonte, que se concentram principalmente na documentação de API para outros programadores, esta pesquisa apresenta uma nova abordagem para a documentação dos requisitos de negócio, mapeando-os através de um conjunto de anotações. Essas anotações, por sua vez, são interpretadas pela ferramenta GaiaDoc, que é especificada neste trabalho e é capaz de gerar a documentação em forma de especificações de caso de uso em uma linguagem e formato de fácil compreensão pelos participantes do projeto. Junto com a proposta da ferramenta GaiaDoc, um fluxo de requisitos baseado no RUP é desenvolvido para se encaixar com as necessidades da nova abordagem de documentação de código fonte e é validado por meio das áreas de processo de requisitos do CMMI. Dois estudos de caso da aplicação da metodologia proposta são apresentados antes das considerações finais. === Aiming to fill a gap in traditional methods of source code documentation, which focus mainly on the API documentation for other programmers, this research presents a new approach for business requirements documentation, mapping them through a set of annotations. These annotations, in turn, are interpreted by the GaiaDoc tool, which is specified in this paper and is able to generate documentation in form of use case specifications in a language and format easily understandable by the project stakeholders. Along with the GaiaDoc tool proposal, a RUP based requirements flow is developed to meet the needs of the new approach for source code documentation and it is validated by means of the CMMI requirements process areas. Two case studies of the proposed methodology's application are presented before the final considerations.