WRITEME: uma Ferramenta de Auxílio à Escrita de READMEs Baseada em Dados Abertos

Abstract

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.