探索发布说明的相关制品:从业者的视角
软件工程
2022-04-13 v1
摘要
软件发布说明是软件开发生命周期中必不可少的文档之一。软件发布包含一组信息,例如错误修复和安全修复。发布说明用于不同阶段,例如需求工程、软件测试和发布管理。不同类型的从业者(例如项目经理和客户)从发布说明中受益,以了解最新发布的概览。因此,已有若干关于发布说明生成与实践使用的研究。然而,在生成书写良好且结构良好的发布说明以及针对不同目标用户需求组织适当信息方面,存在两个显著问题(例如发布说明内容中的重复和不一致)。因此,从业者在使用现有工具编写和阅读发布说明时面临困难。为缓解这些问题,我们在论文中执行了两项不同的研究。首先,我们通过分析21个GitHub仓库的3,347份发布说明执行探索性研究,以理解发布说明中记录的内容。结果我们发现了相关关键制品,例如发布说明内容中的议题(29%)、拉取请求(32%)、提交(19%)和常见漏洞与暴露(CVE)问题(6%)。其次,我们对32位专业人士开展调查,以了解发布说明中依据用户角色包含的关键信息。例如,项目经理比不太关键的缺陷修复更有兴趣了解新功能。我们的研究可指导未来研究方向,帮助从业者生成含相关内容的发布说明并提升文档质量。
引用
@article{arxiv.2204.05355,
title = {Exploring Relevant Artifacts of Release Notes: The Practitioners' Perspective},
author = {Sristy Sumana Nath and Banani Roy},
journal= {arXiv preprint arXiv:2204.05355},
year = {2022}
}