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

Question

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

除了通过工作项之外，我还有哪些选项可以将文档链接到VS.net/TFS中的代码。我可以立即想到两个选项 -

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

这些似乎都不令人满意 - （1）意味着文档在SCCS之外不可用，并且（2）意味着程序员必须通过代码搜索才能找到文档链接（可以在任何标题中的任何位置）。

还有其他常用选项吗？

菲利普

Answer 1

我不知道你的问题是否只有一个金色答案。但是，让我分享一下我是如何做到的。

我个人将文档拆分为技术和业务文档。 技术文档仅包含四个文档：

• 我们正在构建什么，您可以提供给新开发人员的简短文档，以便快速加快项目的速度。
• 编译说明。本文档描述了开发人员在全新机器上编译代码和运行单元测试时需要采取的任何步骤
• 部署说明。将应用程序部署到新环境的所有必要信息
• 技术。项目中使用的技术列表，如果开发人员需要学习某些内容，可以链接到更多信息。

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

外部利益相关者可以通过TFS的Web访问查看此文档。但是，如果没有Visual Studio或团队资源管理器并知道如何使用它们，它们就无法更改它。

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

Answer 2

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

此外，当文档移动时，您只有一个地方可以更新它。