热门 GitHub 项目中产品特性文档策略的探索性研究
软件工程
2024-08-05 v1
摘要
[背景] 在大型开源软件项目中，开发知识往往分散在多个制品和贡献者之中，以至于单个利益相关者通常不了解产品特性的全貌。然而，用户想知道软件能做什么，而贡献者需要知道在何处修复、更新和添加特性。[目标] 本研究旨在理解 GitHub 项目中特性知识是如何被文档化的，以及它（如果有的话）是如何与源代码关联的。[方法] 我们对 25 个提供 GitHub 社区标准指标所推荐文档制品的热门 GitHub 仓库进行了深入的定性探索性内容分析。我们首先提取了在文本制品中用于文档化软件特性的策略，然后提取了将特性文档与源代码相链接的策略。[结果] 我们在所有研究项目的 README、wiki 和网站资源文件等制品中都观察到了特性文档。然而，特性常以非结构化的方式描述。此外，连接特性文档与源代码的追踪技术很少被使用。[结论] 我们的结果表明，开源项目中缺乏（或低优先级）特性文档，很少使用规范化结构，并且很少显式引用源代码。因此，产品特性的可追溯性很可能非常有限，可维护性也会随时间下降。
引用
@article{arxiv.2208.01317,
title = {An Exploratory Study of Documentation Strategies for Product Features in Popular GitHub Projects},
author = {Tim Puhlfürß and Lloyd Montgomery and Walid Maalej},
journal= {arXiv preprint arXiv:2208.01317},
year = {2024}
}
备注
Accepted for the New Ideas and Emerging Results (NIER) track of the 38th IEEE International Conference on Software Maintenance and Evolution (ICSME)