开源软件中社区文档应用与维护的实证研究

社区文档对开源软件的开发和和管理具有重要意义,虽然已有部分研究对社区文档的内容进行了初步分析,但是社区文档在开源软件中的实际应用情况以及开发者对社区文档的维护实践尚未得到充分研究.为填补这一空白,通过量化分析手段探索了社区文档的应用和维护现状.首先随机收集了托管于GitHub 平台上近2000 个开源项目的社区文档数据,分析了编程语言、项目所有者类型、项目成长期和项目社区规模等多个因素对社区文档应用的影响.与此同时,从文档位置、创建延迟、维护者、更新频率和更新原因多个方面分析了社区文档的维护实践.研究结果表明,README 文档和LICENSE 文档比CON-TRIBUTING,CONDUCT 和TEMPLATE 文档具有更高的应用普及率和更早的应用时间.此外,社区文档在TypeScript 语言的项目、大规模社区的项目以及组织所拥有的项目中的应用更为普遍.就文档位置而言,社区文档常被放置于项目的根目录中,由开发者中的小部分成员出于完善性和适应性需求,对文档进行低频率的更新和维护.本研究有助于增强开源软件开发者和使用者对社区文档应用和维护实践的了解,引导开源软件社区的健康发展.