开发文档

Question

我们是一个开发团队，我们需要记录我们的代码。 每个开发人员都在代码的一部分上工作，可以将其称为模块。 我们需要一个具有此规范的文档

1. 应该易于实施和使用
2. 每个开发人员记录她/他自己的工作，当另一个开发人员需要了解任何模块时，他/她不应该被要求向原始开发人员询问文档。他/她应该能够自己找到该文件。
3. 我们应该能够搜索整个文档。

你有什么建议吗？

Answer 1

大多数语言都可以通过代码注释生成文档。 Java和JavaScript都有将注释转换为API规范的方法，例如Java的Javadocs。这实际上取决于你正在使用的平台。

Answer 2

您谈的是设计决策，要求等吗？

为什么不使用wiki（我们使用PmWiki）进行此类协作？