链接代码变更与文档变更：初步分析

代码变更是指项目中添加、修改或删除的代码量的度量，通常用于评估代码库的稳定性和可维护性。程序理解或变更的可理解性对于可维护性同样重要。文档对于知识转移至关重要，尤其是在新的维护者接管废弃代码时。我们强调相应文档更新的必要性，因为这反映了项目作为第三方库的健康状况和可信度。因此，我们认为每次代码变更都应促使文档更新（定义为文档变更）。将代码变更与文档更新联系起来对于项目的可持续性非常重要，因为它促进了知识转移并减少了程序理解所需的工作量。本研究调查了三个GitHub开源项目中代码变更与文档更新之间的同步性。我们将使用定性分析和仓库挖掘来检查代码变更与文档更新随时间推移的一致性和相关性。我们想确定哪些代码变更可能与文档同步，以及文档可以在多大程度上自动生成。初步结果表明，不同项目之间的同步程度不同，这凸显了集成并发文档实践的重要性，并提供了关于如何利用AI（如大语言模型（LLM））等最新技术来保持代码和文档变更同步的见解。这项研究的新颖之处在于展示了将代码变更与文档更新同步如何通过增强多样性和效率来改进开发生命周期。