存储软件文档的最佳方法是什么？

一个明显的答案是"内部维基".用于软件文档的wiki的优缺点是什么？还有其他建议吗？你在使用什么软件文档？

Loren Segal - 遗憾的是我们没有任何doc工具支持从源代码注释中编译信息,但我同意这是存储技术文档的最佳方式.我的问题是关于各种文档 - 从sysadmin类型到用户文档.

这是一个非常开放的问题,取决于很多因素.

一般来说,如果你使用的语言具有良好的文档生成工具(javadoc,doxygen,MS的C#东西),你应该在你的方法上面编写你的文档并让你的工具生成页面.优点是您可以将文本源与代码保持在一起,这意味着它在逻辑上正确的位置进行了组织,并且在对方法的行为进行更改时可以轻松编辑.

如果您没有良好的doc工具支持或无法访问源代码,那么wiki并不是一个坏主意,但它们是上述选择的第二选择.

注意:我这里只讨论代码文档.其他工件显然不能与代码一起存储 - 维基是放置这些文档的好地方.或者,如果您使用某些CMS,您只需将它们docs/作为text/pdf /任何可通过存储库编辑的文件提交到某个文件夹中.优点是,如果移动存储库,它们会保留在存储库中,而维基存储库则不会(必然).