存储与代码项目关联的文档的最佳方法是什么?


10

我们有很多与软件开发相关的文档。其中包括需求,设计文档,外部PDF,客户文件,测试说明等内容。目前,这些文档分散在各处(Wiki,“网络上的某个地方”,本地开发人员的硬盘(!),甚至更糟的地方)。

跟踪它们的最佳方法是什么?由于我们使用Visual Studio(2010)进行开发,并且该项目上实际上没有任何非开发人员,所以我认为将它们存储在VS“解决方案”中是一个好主意,这将使他们由源代码控制,并由所有开发人员普遍访问。

但是,VS似乎并不是专门为实现此目的而构建的。如果您编辑任何文档文件,即使使用构建属性“无”,“请勿复制”设置的文档文件,VS也必须先重建软件,然后才能再次运行。无法在解决方案中创建“文档项目”。(为此,我们使用一个空的C#项目)。Visual Studio和Word / Excel Flat不能很好地进行源代码控制。您无法查看签入的文件,然后决定进行更改,而无需先关闭文件,进入项目并在进行更改之前手动将其检出。充其量是缓慢而乏味的。

无论如何,这是我们团队能提供的最好的解决方案,但我真的希望我有一个更好的(免费)解决方案。


您的团队有多大?
杰夫,

我们现在有3-4人。
大卫,

您专门使用什么版本控制。我不知道您将使用Visual Studio来管理它的源代码管理。
Earlz 2011年

我在哪里工作,我们使用TFS存储代码和SharePoint的文档,测试计划等
招聘

4
我不建议将PDF之类的文档放入VSS。提醒您,我也不建议将源代码放入VSS。
Carson63000

Answers:


3

我不确定是否只有一个“最佳方法”,但是从您的描述看来,每个开发人员都在按照自己的方式存储文档。通过一种存储文档的方法从所有人那里买入,使它井井有条变得容易得多。

除了“为您找到最佳方法”答案外,我还要说至少要寻找一种易于搜索文档的解决方案。在一家公司中,我建立了一个Wiki,其中包含指向所有关于Serverland的文件的链接,这突然使搜索和定位文档变得更加容易,无论它们在哪里。一旦其他用户开始使用Wiki查找文档,他们也将开始对其进行更新以链接新文档,或者仅创建一个Wiki条目作为文档。

我很想听听其他人是否知道可以很好地处理文档的免费版本控制系统。唯一浮出水面的是Sharepoint,它不是完全免费的。我已经看到了非官方的版本控制系统,其中的人们拥有一个“ Archive”文件夹,然后将文件的过去修订版本简单地放在该文件夹中,而最新的修订版本与“ Archive”处于同一文件夹级别。


我们的“维基”解决方案是链接到网络共享(或直接链接到网络上的文件。缺点是没有版本控制),或者您将文件下载/编辑/上传到Wiki,这是一个您可以随时编辑10个步骤来修正拼写错误
David

许多免费的共享点替代方法(更好!):尝试Nuxeo设置简单。或Alfresco,如果需要的话,可以提供更多功能。
gbjbaanb

您计算机上安装的Google搜索确实可以找到所需的内容。

3

在我公司中效果最好的解决方案是建立一个Wiki(我们使用mediawiki)。从传统的Wiki条目到简单的“ This is a ...”以及Word文档,它都有多种用法。搜索非常容易。我们正在逐步建立一个非常有用的信息库。


我们已经尝试过使用doku-wiki,但是使用起来非常繁琐(尝试解决doc typo单词拼写错误是10个繁琐的步骤),而且没有关于谁在编辑内容的多用户支持。关于文件大小和文件扩展名,还有很多警告和限制,实际上,这些警告和限制所带来的不仅仅是帮助。我没有得到公司其他人的支持。我看到了巨大的潜力,但不幸的是我的公司没有。
大卫,

1

至少在VS 2008中,您可以将C ++项目的配置类型(在项目属性->常规->项目默认设置下)设置为Utility,在这种情况下VS不会对其执行任何操作。

您是否尝试过在基于C#的解决方案中使用这样的项目?(也许一个C#项目有类似的东西?)


0

我绝对同意,这里没有一个最佳解决方案。但是版本控制!=包含在解决方案中;大多数系统都可以处理IDE以外的内容。因此,在大多数情况下,可以使文档保持关闭状态,但请注意。

现在,摆脱烦人的单词习惯,每当打开文件时都要更改文件,这是另一个问题。。。


0

不,Visual Studio(以及C#和Vb.net)项目对解决方案资源管理器有一个脑残的方法。VC ++更好,因为您可以创建不依赖于磁盘布局的虚拟文件夹,并在其中放置各种东西。愚蠢的微软试图使其变得“易于理解”,从而打破了它。

您仍然可以将其放在“解决方案文件夹”中,但仍不如您想要的灵活。这意味着您必须找到替代方法,而我推荐的替代方法是Web工具。如果您不想尝试可以在其中存储文档拥有Wiki,错误跟踪器等的项目门户网站(例如Redmine),则可以使用文档管理工具。诸如Nuxeo或Owl之类的东西会对您有好处。一旦进入网络,您就可以拥有一个中心位置,以便人们知道在哪里寻找这些东西-这可能是文档管理中最重要的部分。如果将其绑定到版本控制系统(如subversion)(继续,在VSS之后您将不会后悔!),则仍然可以将文档链接到Web工具并对其进行版本控制。

Subversion甚至可以将存储库显示为webdav文件夹(即网络文件夹),因此您可以将它们存储在“网络驱动器”上,但仍可以对其进行版本控制。

我个人还是喜欢Redmine。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.