内部产品文档

Question

我们有一个已经发展了多年的系统（ASP.NET Web Forms，MySQL），我们正在寻找关于如何记录以及如何记录它的指导，以便我们有一个我们可以去了解系统应该如何表现的一个地方。

本文档将允许开发人员和测试人员识别在我们进行更改时可能会受到的影响。

我们正在构建全面的单元测试，但这项工作仍在进行中，我不认为单元测试将会是一个很好的，可读的系统功能描述。

人们如何记录系统的功能和行为？你用什么工具？谁负责文档？你是否按屏幕组织它？按情景？

Answer 1

我觉得Doxygen对文档很有用。 （如果这是你使用的语言，它支持C＃）。至于谁负责，我认为正确的答案是所有的开发人员都应该负责。 Doxygen（和许多其他文档工具）可以选择为没有记录的代码生成警告。

任何开发人员在提交代码之前都应该检查是否可以生成一整套文档。即使是一个相当大的项目，这也只需要几分钟的时间来检查和解决。这比其他人稍后回去并试图弄清楚发生了什么要容易得多。

Answer 2

我意识到这是一个老问题，但MindTouch已经花了几年的时间来开发一个解决方案（MindTouch TCS），它非常适合您描述的内容。 http://www.mindtouch.com/products/mindtouch_tcs

它使产品文档的协作变得简单。您可以拖放文件来创建页面，嵌入视频，从页面发送消息，回滚编辑，解决版本冲突等。