WRITEME: uma Ferramenta de Auxílio à Escrita de READMEs Baseada em Dados Abertos
Resumo
Repositórios de código são acompanhados de um arquivo chamado README (leia-me, em português) que deve ser lido antes do uso do software que acompanham. Pesquisas recentes identificaram que tipos de conteúdos estão presentes nesses arquivos, porém faltam ferramentas que divulguem e apliquem esses conhecimentos como forma de suporte a desenvolvedores no processo de escrita dos documentos. Neste trabalho apresentamos uma ferramenta de auxílio à escrita de READMEs, que usa dados abertos dos repositórios mais populares do GitHub para gerar recomendações de seções. Os repositórios usados como exemplo são os que mais receberam estrelas, e são de projetos da linguagem de programação escolhida pelo usuário. A ferramenta consiste de um back-end que adquire os READMEs pela API do GitHub, e classifica suas seções de acordo com o tipo de conteúdo presente. No front-end é apresentada uma interface web onde o usuário pode escolher as seções que se aplicam ao seu projeto, e fazer download do esqueleto do seu README.
Referências
A. Terrasa, J. Privat, and G. Tremblay, “Using natural language processing for documentation assist,” in Workshops at the Thirty-Second AAAI Conference on Artificial Intelligence, 2018.
T. C. Lethbridge, J. Singer, and A. Forward, “How software engineers use documentation: The state of the practice,” IEEE software, vol. 20, no. 6, pp. 35–39, 2003.
Y. Zhang, D. Lo, P. S. Kochhar, X. Xia, Q. Li, and J. Sun, “Detecting similar repositories on github,” in 2017 IEEE 24th International Conference on Software Analysis, Evolution and Reengineering (SANER). IEEE, 2017, pp. 13–23.
M. Koskela, I. Simola, and K. Stefanidis, “Open source software recommendations using github,” in International Conference on Theory and Practice of Digital Libraries. Springer, 2018, pp. 279–285.
M. M. Rahman, S. Chakraborty, G. Kaiser, and B. Ray, “A case study on the impact of similarity measure on information retrieval based software engineering tasks,” arXiv preprint arXiv:1808.02911, 2018.
R. L. Q. Portugal, M. A. Casanova, T. Li, and J. C. S. do Prado Leite, “Gh4re: Repository recommendation on github for requirements elicitation reuse.” in CAiSE-Forum-DC, 2017, pp. 113–120.
