Goto

Collaborating Authors

 terrasa


Terrasa

AAAI Conferences

Nowadays, most of the code hosting platforms for open-source projects consider the README file as the project cover. As it is the first piece of documentation seen by the project user or maintainer, such a document needs to be crafted with care. Documentation assist can be a useful tool to help documentation writers produce better documentation like README files. In this paper, we show how an abstract representation of a README file can help documentation assist tools provide better suggestions to writers. Our approach benefits from natural language processing tools and techniques to analyze the content of a README file. Using this model and the current cursor position within the document, our tool can suggest pieces of documentation, examples, and figures as well as structure improvements and update suggestions to the writer. Suggestions are presented as cards that can be selected to automatically enhance the document under writing.