协作编码和文档

Question

在一项新的研究工作中，我将参与清理相当广泛的 Java 代码库（7 年多的开发）的长期工作。它目前驻留在 SVN 上，但我正在考虑使用 Mercurial。

可能有两种类型的人在该项目上进行合作。第一类：将开发大量代码和编写文档的人。类型 2：代码的用户，对文档和可用性有很好的建议。

我想象这样的工作流程：

1. 开发人员审查一段代码并（重新）编写文档（代码内 Javadoc/Doxygen 样式）
2. 开发人员提交代码
3. 版本控制服务器更新 HTML 文档
4. 类型 2 用户可以审查文档并对文档发表评论页面本身（维基风格？）。合作者可以在这里进行讨论。
5. 开发人员查看评论并转到步骤 1。

我正在寻找有关拟议工作流程的任何建议以及有助于完成该工作流程的工具的想法。谢谢！

Answer 1

我强烈建议建立一个提交邮件列表：通过让每个人都可以轻松地看到所做的更改，当它们发生时，我们的代码审查明显更好：更早地发现错误，在代码在开发人员的头脑中仍然新鲜的时候提出建议，并且每个人都感觉到更加了解团队中其他人正在做什么。

Answer 2

我建议您让第 2 类（客户？）人员直接成为团队的一部分，这样他们就可以立即帮助开发人员，而不必编写文档。

这应该会使速度更快，因为它增加了沟通并极大地缩短了反馈循环。