Docs-checker: uma ferramenta de análise de documentações escritas a partir de geradores de sites estáticos em Markdown

• Autor(a) principal: VIEIRA, Fanny Batista.
• Data de Publicação: 2021
• Tipo de documento: Trabalho de conclusão de curso
• Idioma: por
• Título da fonte: Biblioteca Digital de Teses e Dissertações da UFCG
• Texto Completo: http://dspace.sti.ufcg.edu.br:8080/jspui/handle/riufcg/19591
• topic: Docs-Checker; Verificador-documentos; Comprobador de documentos; Análise de documentação escrita; Análisis de la documentación escrita; Analysis of written documentation; Geradores de sites estáticos - markdown; Static site generators - markdown; Estrutura de documentação de APIs - conformidade; Structure APIs documentation - compliance; estructura Documentación de las API: cumplimiento; Static site generators - markdown; Sitio estático generadores - rebaja; Local estático geradores - markdown; Ciência da Computação

Documentações são artefatos cruciais no desenvolvimento de software. A documentação explica o propósito de projetos, unifica informações e de modo geral, evita possíveis dúvidas das partes interessadas. Para que a documentação seja efetiva, sua estrutura deve ser simples, amigável e direta, no entanto, garantir que esses requisitos sejam atendidos é um trabalho difícil, principalmente, porque atualmente é um processo realizado manualmente. Neste trabalho, criaremos uma ferramenta para analisar a conformidade de estruturas de documentação de APIs com uma especificação, se atendo àquelas escritas por meio de static site generators (SSGs) em markdown. O sistema estabelece regras que a documentação deve atender e assim automaticamente avalia a qualidade da documentação. O usuário consegue customizar essas regras, de acordo com suas necessidades. O desempenho da ferramenta foi avaliado e os dados obtidos revelaram que a solução possui um comportamento de complexidade linear, levando aproximadamente 300 milissegundos para documentações de pequeno porte e 1 minuto para aquelas de grande porte. Além disso, ao avaliar a ferramenta em documentações populares como é o caso de React e Typescript obtivemos uma taxa de sucesso superior a 80%, comprovando que a solução consegue garantir a conformidade da estrutura de documentações.