【软件开发】为什么开发者喜欢干净的代码却讨厌写文档？

为什么开发者喜欢干净的代码却讨厌写文档？是时候把这件事交给AI了。

在开发者系数（Developer Coefficient）研究中，由金融科技巨头 Stripe 委托完成的报告显示，开发者每周花费超过 17 小时在维护性任务上，例如调试和重构——这些被归类为“重复性工作”（toil）。

我们的 2024 年开发者调查也揭示了类似的问题和不满情绪。对于专业开发者来说，最让人沮丧的问题（且遥遥领先于其他问题）是技术债务。而相反，最让开发者感到满意的事情是提升代码质量和优化开发环境。展望未来，开发者认为生成式 AI（GenAI）工具在两个领域能带来最多价值：代码测试和文档编写。

优质文档是否有助于减少导致开发者挫败感和倦怠的“重复性工作”和技术债务？在多大程度上，它又能支持那些让开发者感到满意的事情，比如提升代码质量？

文档是否真的影响重复性工作？

在探讨 AI 生成文档的角色之前，已有实证研究表明，良好的开发者文档对重构和调试等工作有积极影响。

一项对 60 多篇关于软件质量和文档的学术论文的元研究发现，文档的好处体现在多个方面：缩短任务持续时间、提高代码质量、提升生产力，或其他与软件开发相关的改进。研究还指出，文档编写通常占开发者工作时间的 11%。

2023 年发表在 PLOS ONE 上的一项研究开发了一个模型，用于测试哪些技术对重构过程有积极或消极的影响。作者写道：“文档有助于新团队成员的入职，并确