Blogs (1) >>
ICSE 2019
Sat 25 - Fri 31 May 2019 Montreal, QC, Canada
Fri 31 May 2019 17:00 - 17:10 at Centre-Ville - Software Documentation Chair(s): Bonita Sharif

README files play an essential role in shaping a developer’s first impression of a software repository and in documenting the software project that the repository hosts. Yet, we lack a systematic understanding of the content of a typical README file as well as tools that can process these files automatically. To close this gap, we conduct a qualitative study involving the manual annotation of 4,226 README file sections from 393 randomly sampled GitHub repositories and we design and evaluate a classifier and a set of features that can categorize these sections automatically. We find that information discussing the ‘What’ and ‘How’ of a repository is very common, while many README files lack information regarding the purpose and status of a repository. Our multi-label classifier which can predict eight different categories achieves an F1 score of 0.746. To evaluate the usefulness of the classification, we used the automatically determined classes to label sections in GitHub README files using badges and showed files with and without these badges to twenty software professionals. The majority of participants perceived the automated labeling of sections based on our classifier to ease information discovery. This work enables the owners of software repositories to improve the quality of their documentation and it has the potential to make it easier for the software development community to discover relevant information in GitHub README files.

Fri 31 May

icse-2019-Paper-Presentations
16:00 - 17:20: Papers - Software Documentation at Centre-Ville
Chair(s): Bonita SharifUniversity of Nebraska-Lincoln, USA
icse-2019-Software-Engineering-in-Practice16:00 - 16:20
Talk
Ariana MirianUniversity of California San Diego, Nikunj BhagatGoogle, Caitlin Sadowski, Adrienne Porter FeltGoogle, Stefan SavageUniversity of California San Diego, Geoffrey M. VoelkerUniversity of California San Diego
icse-2019-Technical-Papers16:20 - 16:40
Talk
Emad AghajaniSoftware Institute, Faculty of Informatics, USI Lugano, Csaba NagyUniversità della Svizzera italiana (USI), Olga Lucero Vega-MarquezUniversidad de los Andes, Universidad de los Llanos, Mario Linares-VásquezSystems and Computing Engineering Department , Universidad de los Andes , Bogotá, Colombia , Laura MorenoColorado State University, Gabriele BavotaUniversità della Svizzera italiana (USI), Michele LanzaUniversita della Svizzera italiana (USI)
Pre-print
icse-2019-Technical-Papers16:40 - 17:00
Talk
Hideaki HataNara Institute of Science and Technology, Christoph TreudeThe University of Adelaide, Raula Gaikovina KulaNAIST, Takashi IshioNara Institute of Science and Technology
DOI Pre-print Media Attached
icse-2019-Journal-First-Paper17:00 - 17:10
Talk
Gede Artha Azriadi PranaSingapore Management University, Christoph TreudeThe University of Adelaide, Ferdian Thung, Thushari AtapattuThe University of Adelaide, David LoSingapore Management University
Link to publication DOI Pre-print
icse-2019-Paper-Presentations17:10 - 17:20
Talk