Software Documentation: The Practitioners' PerspectiveTechnical
In theory, (good) documentation is an invaluable asset to any software project, as it helps stakeholders to use, understand, maintain, and evolve a system. In practice, however, documentation is generally affected by numerous shortcomings and issues, such as insufficient and inadequate content and obsolete, ambiguous information. To counter this, researchers are investigating the development of advanced recommender systems that automatically suggest high-quality documentation, useful for a given task. A crucial first step is to understand what quality means for practitioners and what information is actually needed for specific tasks.
We present two surveys performed with 146 practitioners to investigate (i) the documentation issues they perceive as more relevant together with solutions they apply when these issues arise; and (ii) the types of documentation considered as important given specific tasks. Our findings can help researchers in designing the next generation of documentation recommender systems.
Thu 9 JulDisplayed time zone: (UTC) Coordinated Universal Time change
08:05 - 09:05 | I18-APIs and CommitsNew Ideas and Emerging Results / Journal First / Technical Papers at Silla Chair(s): Massimiliano Di Penta University of Sannio | ||
08:05 8mTalk | Enriching API Documentation with Code Samples and Usage Scenarios from Crowd KnowledgeJ1 Journal First Jingxuan Zhang Nanjing University of Aeronautics and Astronautics, He Jiang School of Software, Dalian University of Technology, Zhilei Ren Dalian University of Technology, Tao Zhang Harbin Engineering University, Zhiqiu Huang Nanjing University of Aeronautics and Astronautics | ||
08:13 6mTalk | Cooperative API Misuse Detection Using Correction RulesNIER New Ideas and Emerging Results Sebastian Nielebock Otto-von-Guericke University Magdeburg, Germany, Robert Heumüller Chair of Software Engineering, Faculty of Computer Science, Otto-von-Guericke-University Magdeburg, Jacob Krüger Otto von Guericke University Magdeburg, Frank Ortmeier Otto-von-Guericke-University Magdeburg, Faculty of Computer Science, Chair of Software Engineering DOI Pre-print | ||
08:19 12mTalk | How Android Developers Handle Evolution-induced API Compatibility Issues: A Large-scale StudyTechnical Technical Papers Hao Xia Fudan University, Yuan Zhang Fudan University, Yingtian Zhou Fudan University, Xiaoting Chen Fudan University, Yang Wang Fudan University, Xiangyu Zhang Purdue University, Shuaishuai Cui Fudan University, Geng Hong Fudan University, Xiaohan Zhang Fudan University, Min Yang Fudan University, Zhemin Yang Fudan University | ||
08:31 12mTalk | An Empirical Study on API Parameter RulesTechnical Technical Papers | ||
08:43 6mTalk | Boosting Automated Program Repair with Bug-Inducing CommitsNIER New Ideas and Emerging Results Ming Wen Huazhong University of Science and Technology, China, Yepang Liu Southern University of Science and Technology, Shing-Chi Cheung Department of Computer Science and Engineering, The Hong Kong University of Science and Technology | ||
08:49 12mTalk | Software Documentation: The Practitioners' PerspectiveTechnical Technical Papers Emad Aghajani Software Institute, USI - Lugano, Switzerland, Csaba Nagy Software Institute - USI, Lugano, Switzerland, Mario Linares-Vásquez Universidad de los Andes, Laura Moreno Colorado State University, Gabriele Bavota Università della Svizzera italiana, Michele Lanza Universita della Svizzera italiana (USI), David C. Shepherd Virginia Commonwealth University Pre-print Media Attached |