协作编码和文档

Question

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

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

我想象一个像这样的工作流程：

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

我正在寻找有关建议的工作流程的任何建议以及有助于实现它的工具的想法。谢谢！

Answer 1

我强烈建议提交邮件列表：通过让每个人都可以轻松看到更改，我们的代码审查明显更好：错误被提前发现，建议是在开发人员的脑海中代码仍然是新鲜的，并且每个人都更加意识到团队中其他人正在做的事情。

Answer 2

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

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