论文标题
探索发行说明的相关文物：从业者的观点
Exploring Relevant Artifacts of Release Notes: The Practitioners' Perspective
论文作者
论文摘要
软件发行说明是软件开发生命周期中的重要文档之一。该软件发布包含一组信息，例如错误修复和安全修复程序。发行说明以不同的阶段使用，例如需求工程，软件测试和发布管理。不同类型的从业人员（例如，项目经理和客户）从发行说明中受益，以了解最新版本的概述。结果，已经对发行说明的生产和用法进行了几项研究。但是，在生产良好编写且结构良好的发行说明以及组织有关不同目标用户需求的适当信息时，存在两个重大问题（例如，发行说明内容的重复和不一致之处）。因此，从业人员使用现有工具在写作和阅读发行说明方面面临困难。为了减轻这些问题，我们在论文中执行了两项不同的研究。首先，我们通过分析21个GitHub存储库的3,347个发行说明来执行探索性研究，以了解发行说明的记录内容。结果，我们发现相关的关键人工制品，例如问题（29％），拉普雷斯（32％），提交（19％）以及公共漏洞和暴露率（CVE）问题（CVE）问题（6％）（6％）。其次，我们与32位专业人员进行了一项调查研究，以了解有关用户角色的发行说明中包含的关键信息。例如，项目经理比不太关键的错误修复更感兴趣地学习新功能。我们的研究可以指导未来的研究方向，以帮助从业人员制作具有相关内容的发行说明并提高文档质量。
A software release note is one of the essential documents in the software development life cycle. The software release contains a set of information, e.g., bug fixes and security fixes. Release notes are used in different phases, e.g., requirement engineering, software testing and release management. Different types of practitioners (e.g., project managers and clients) get benefited from the release notes to understand the overview of the latest release. As a result, several studies have been done about release notes production and usage in practice. However, two significant problems (e.g., duplication and inconsistency in release notes contents) exist in producing well-written & well-structured release notes and organizing appropriate information regarding different targeted users' needs. For that reason, practitioners face difficulties in writing and reading the release notes using existing tools. To mitigate these problems, we execute two different studies in our paper. First, we execute an exploratory study by analyzing 3,347 release notes of 21 GitHub repositories to understand the documented contents of the release notes. As a result, we find relevant key artifacts, e.g., issues (29%), pull-requests (32%), commits (19%), and common vulnerabilities and exposures (CVE) issues (6%) in the release note contents. Second, we conduct a survey study with 32 professionals to understand the key information that is included in release notes regarding users' roles. For example, project managers are more interested in learning about new features than less critical bug fixes. Our study can guide future research directions to help practitioners produce the release notes with relevant content and improve the documentation quality.
