Software Documentation Issues Unveiled
Technical TrackIndustry Program
(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.
Systems and Computing Engineering Department , Universidad de los Andes , Bogotá, Colombia
Fri 31 May (GMT-04:00) Eastern Time (US & Canada) change
|16:00 - 16:20|
|16:20 - 16:40|
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
|16:40 - 17:00|
Hideaki HataNara Institute of Science and Technology, Christoph TreudeThe University of Adelaide, Raula Gaikovina KulaNAIST, Takashi IshioNara Institute of Science and TechnologyDOI Pre-print Media Attached
|17:00 - 17:10|
Gede Artha Azriadi PranaSingapore Management University, Christoph TreudeThe University of Adelaide, Ferdian Thung, Thushari AtapattuThe University of Adelaide, David LoSingapore Management UniversityLink to publication DOI Pre-print
|17:10 - 17:20|