WRITEME 2.0: generalização e validação de uma ferramenta de auxílio à escrita de READMEs baseada em dados abertos

Abstract

Uma forma comum de documentação de software são os arquivos README (leia-me, em português) comumente disponibilizados em repositórios de código. Essa documentação facilita a utilização do software por seus usuários e também a contribuição por desenvolvedores que desejam ajudar na sua implementação. O arquivo serve como uma página de boas vindas e, quando mal escrito, pode dificultar a utilização do software. O trabalho que idealizou o WRITEME propôs um modelo de ferramenta baseada em dados abertos, que teria caráter genérico e dinâmico para auxiliar desenvolvedores a escrever READMEs, recomendando seções para a escrita da documentação de seus projetos. Entretanto, sua implementação não foi finalizada, fazendo com que em seu estado atual esteja restrita a duas linguagens de programação. Este projeto continua a implementação da integração entre o back-end e o front-end da ferramenta, enfim trazendo seu caráter dinâmico e genérico. Isso amplia sua utilização e facilita a realização de mais testes para validação, realizando uma nova pesquisa sobre a experiência de uso.