文档应该由熟练的程序员来编写吗？

Question

我一直认为文档对于一个项目和团队来说非常重要，应该定期且详细地编写。它可以使事情并行进行，而无需总是四处询问熟练的程序员。但我确实发现很多开发人员(甚至领导者)并没有对文档给予太多关注，只是认为它们是理所当然的，这让我感觉很糟糕。

那么我对文件的态度对吗？文件真的很重要吗？我该如何说服组长更加关注文档？

如果文档很重要，就会出现第二个问题。 谁应该编写文档？ IMO，它们应该由熟练的程序员编写，例如框架创建者(如果我们使用自己的框架)，项目的重要部分(例如数据库模式，整个架构，等)等等。

好处是显而易见的，比如帮助新人、帮助维护等等。

所以我认为，熟练的程序员(这里的定义可能不同)在基础设施完成后应该更注重文档的编写而不是代码的编写。

这一点我说得对吗？

感谢您分享这些问题。

Answer 1

您有多种文档，其中之一是您的责任:

在完成时记录每个函数、类、结构、成员

理想情况下，您可以通过允许自动提取源文档(例如 Doxygen)的方式来执行此操作。请务必边做边做。

就客户文档而言，我的信念是:

• 每个开发公司都应该雇用测试人员
• 测试人员应该为文档流程做出巨大贡献

我曾与一些公司合作过，这些公司不会为最终产品全额付款，除非最终产品附带完整且全面的文档。通常会保留 10%，只是为了确保承包商有动力交付所有 Material 。

就测试人员而言，他们确实是您最好的 friend (或者应该是)。他们几乎和您一样了解您的软件如何工作。是的，我同意，您至少应该有一个程序功能的概述，这可以防止您偏离“增值”切线。让测试人员填写此内容，然后让开发人员检查其准确性是有意义的。

您甚至可能会发现自己说“不不不.. 那样不行.. 测试人员弄错了...”，然后您启动应用程序来意识到他们做对了:) 在这方面，这对 QA 流程也很有帮助。