Documentation 为项目文件分配资源

对于以下场景，您有何建议：

十几个开发人员需要构建和设计一个复杂的系统。需要为未来的开发人员记录此设计，并且必须注意设计决策。这些报告大约需要每两个月提交一次。我的问题是这个项目应该如何记录

我认为有两种可能性。每个开发人员都写下他们帮助设计和集成的东西，然后由一个人将这些文档组合在一起。最终文件可能会不连贯或有时是多余的，因为负责组装所有部件的人员没有太多时间调整每个部件

假设每个开发人员的文档部分在截止日期前几天到达。协作系统（即wiki）无法正常工作，因为截止日期前几天才有任何内容可供阅读

---

或者，在团队其他成员实际开发系统时，是否应该让几个人（2-3人）负责编写文档？开发者需要一种方法将他们的设计选择和结论传递给技术作者。如何有效地完成这项工作？

我认为您可以使用Sand Castle来记录您的项目

看看

---

这不是一个完整的文档，但确保使用注释对接口等进行注释意味着编写代码和文档更紧密地结合在一起

这样，开发人员应该记录他们所做的事情。我仍然认为需要架构师的审查以确保一致的质量，但确保人们记录他们所做的是确保他们遵循体系结构的最佳方式。

我们使用confluence（atlassian的类似wiki的东西）并记录各种不同的“事情”。开发人员不断地这样做，我们互相推动文档——我们让同行的压力决定需要什么。每当有新人出现时，他/她都要通读所有的东西，并找出仍然正确的东西。因此，不正确的内容会被删除或更新。当我们可以删除内容时，我们很高兴；）

---

这个过程的好处是，相关的内容保留下来，不相关的内容被删除。我们总是声称，如果“他们”需要，我们总是可以构建他们想要的word文档，从而“避开”更正式的需求。“他们”从来就不需要它们。

我认为备选方案2不那么敏捷，因为它意味着项目进入了一个新阶段（尽管它可能与测试并行）

如果您处于敏捷模型中，那么只需添加文档（遵循指南）作为故事。

---

如果您采用的是分阶段的方法，那么我仍然会要求开发人员按照一些指导原则编写文档，并在设计和代码中查看文档。最终，你可能会有一位技术作家为正确的英语复习所有内容，但那将是一种“发布”活动。

我们使用RUP风格的方法从两个方面着手。在第一种情况下，您将有一位领域专家负责对您将要交付的内容进行粗略的设计，必要时由开发人员参与。在第二种情况下，我们使用一位技术作者——他们记录了应用程序，因此他们应该很好地了解它是如何连接在一起的，并且您可以让他们直接参与到设计和开发过程中。在这种情况下，他们可以帮助完善设计，并确保它符合他们认为正在开发的内容