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

(Good) Software documentation provides developers and users with a description of what a software system does, how it operates, and how it should be used. For example, technical documentation (e.g., an API reference guide) aids developers during evolution/maintenance activities, while a user manual explains how users are to interact with a system. Despite its intrinsic value, the creation and the maintenance of documentation is often neglected, negatively impacting its quality and usefulness, ultimately leading to a generally unfavourable take on documentation.

Previous studies investigating documentation issues have been based on surveying developers, which naturally leads to a somewhat biased view of problems affecting documentation. We present a large scale empirical study, where we mined, analyzed, and categorized 878 documentation-related artifacts stemming from four different sources, namely mailing lists, Stack Overflow discussions, issue repositories, and pull requests. The result is a detailed taxonomy of documentation issues from which we infer a series of actionable proposals both for researchers and practitioners.

Fri 31 May

Displayed time zone: Eastern Time (US & Canada) change

16:00 - 17:20
Software DocumentationTechnical Track / Papers / Software Engineering in Practice / Journal-First Papers at Centre-Ville
Chair(s): Bonita Sharif University of Nebraska-Lincoln, USA
16:00
20m
Talk
Web Feature Deprecation: A Case Study for ChromeSEIPIndustry Program
Software Engineering in Practice
Ariana Mirian University of California San Diego, Nikunj Bhagat Google, Caitlin Sadowski , Adrienne Porter Felt Google, Stefan Savage University of California San Diego, Geoffrey M. Voelker University of California San Diego
16:20
20m
Talk
Software Documentation Issues UnveiledTechnical TrackIndustry Program
Technical Track
Emad Aghajani Software Institute, USI - Lugano, Switzerland, Csaba Nagy Università della Svizzera italiana (USI), Olga Lucero Vega-Marquez Universidad de los Andes, Universidad de los Llanos, Mario Linares-Vásquez Systems and Computing Engineering Department , Universidad de los Andes , Bogotá, Colombia , Laura Moreno Colorado State University, Gabriele Bavota Università della Svizzera italiana (USI), Michele Lanza Universita della Svizzera italiana (USI)
Pre-print
16:40
20m
Talk
9.6 Million Links in Source Code Comments: Purpose, Evolution, and DecayArtifacts AvailableTechnical Track
Technical Track
Hideaki Hata Nara Institute of Science and Technology, Christoph Treude The University of Adelaide, Raula Gaikovina Kula NAIST, Takashi Ishio Nara Institute of Science and Technology
DOI Pre-print Media Attached
17:00
10m
Talk
Categorizing the Content of GitHub README FilesJournal-First
Journal-First Papers
Gede Artha Azriadi Prana Singapore Management University, Christoph Treude The University of Adelaide, Ferdian Thung , Thushari Atapattu The University of Adelaide, David Lo Singapore Management University
Link to publication DOI Pre-print
17:10
10m
Talk
Discussion Period
Papers