在VS.net中存储和访问技术文档

Question

我正在使用VS.net和TFS。在过去，我将我的技术文档(解释性文档等)存储在TFS文档WSS存储库中，并通过Story、Task或其他工作项将其链接到我的源代码。从长远来看，这证明是不能令人满意的，因为文档与它描述的代码没有很强的联系。

除了通过工作项，我还有哪些选项可以将文档链接到VS.net/TFS中的代码。我可以马上想到两种选择-

1)将其作为内容添加到项目或解决方案本身，并将其存储在源代码控制存储库中；2)将其作为URL添加到代码头中，并存储在TFS WSS文档存储区中。

这两种方法似乎都不尽如人意- (1)意味着文档在SCCS之外是不可用的，(2)意味着程序员必须搜索代码才能找到文档链接(文档链接可以在任何标题中的任何位置)。

还有其他常用的选项吗？

菲利浦

Answer 1

我不知道你的问题是否有一个金科玉律。但让我分享一下我是怎么做的。

就我个人而言，我将我的文档分为技术文档和业务文档。技术文件仅由四份文件组成：

• 我们正在建设什么，简短的文件，你可以提供给一个新的开发人员，以获得更快的速度，所有的项目是什么。
• 编译指令。本文档描述开发人员在一台全新机器上编译代码和运行单元测试所需的任何步骤。
• 部署指令。将应用程序部署到新环境所需的所有信息
• 技术。项目中使用的技术列表，如果开发人员需要学习一些东西，可以链接到更多信息。

此文档存储在Visual中的解决方案文件夹中，作为解决方案的一部分。

外部利益相关者可以通过TFS的web访问来查看这些文档。但是，如果没有Visual或，并且知道如何使用这些资源，他们就无法更改它。

对于所有其他文档，我们使用SharePoint。TFS允许您将工作项链接到SharePoint中的文档。我们尽量避免这里的任何技术文档。

Answer 2

您可能考虑的另一个选项是创建一个名为" document“的新工作项类型，并从这里到文档位置有一个超链接。现在，您可以在代码文件和变更集以及PBI与原始文档之间创建硬链接。

此外，当文档移动时，您只有一个位置来更新它。