Environment analysis: ferramentas de geração de documentação a partir de um sistema SAP

• Main Author: Faria, Vítor Manuel Gavina
• Publication Date: 2020
• Format: Master thesis
• Language: por
• Source: Repositórios Científicos de Acesso Aberto de Portugal (RCAAP)
• Download full: http://hdl.handle.net/10400.13/3113
• topic: Documentação software; Código fonte; ABAP; SAP; Software documentation; Source code; OLE2Object; Engenharia Informática; .; Faculdade de Ciências Exatas e da Engenharia

Com o crescimento dos projetos de software, em tamanho, a importância da documentação do código fonte tornou-se por demais evidente. Todavia, esta atividade por diversos fatores, como o cumprimento de prazos de entrega e o tempo gasto com o desviar da atenção dos programadores, vai sendo descurada, daí que a procura de ferramentas para tornarem este processo autónomo seja da maior relevância. Efetivamente, um sistema bem documentado, será de fácil interpretação para qualquer um, tanto para aquele que entra em contacto pela primeira vez com o sistema, como para aquele que terá de realizar a sua manutenção. A documentação de projetos de software é bastante abrangente pois inclui documentos referentes a requisitos, arquitetura, design, código fonte do software, testes, manutenção, e todos estes com informação essencial. Para este trabalho iremos nos focar apenas nas ferramentas para gerar documentação a partir do código fonte. Este trabalho propõe-se a criar uma ferramenta de geração de documentação a partir de um sistema SAPi , em linguagem de programação ABAPii , de forma a que se consiga produzir com pouco esforço documentação com qualidade, autonomamente. Na solução apresentada foi implementado estruturas de suporte para a recolha da informação desejada, seguindo o paradigma da SAP e da linguagem ABAP. Para posteriormente, produzir a documentação, foi utilizado o Word, ferramenta de processamento de texto, tendo sido alcançados resultados bastante interessantes e aplicáveis. Assim, como resultado final obtivemos um documento Word com conteúdo pré-definido, pelo próprio utilizador da nossa ferramenta, discriminando todos os artefactos utilizados num dado programa tornando assim o código fonte mais percetível.