源控制软件可以用于您的技术文档吗？

Question

我知道你可以使用源代码控制软件来获取源代码，但是你也可以将它用于你的技术文档吗？例如，您是否可以存储Word文档并保留更改历史记录（我知道它有跟踪更改，这只是示例）？谢谢。

Answer 1

如果您使用的是Windows平台，那么TortoiseSVN有一些非常实用的功能可以让您区分（但不幸的是不会合并）Word文档。它直接与已安装的Word进行交互，当您请求diff时，它会运行一个脚本，将两个文档加载到Word中进行比较，并使用Word的内置文档进行比较来比较它们。

使用该功能，结合Subversion的锁定（编辑必须请求锁定文档以关闭只读标志），我发现使用Subversion管理Word文档非常容易。它不像普通文本那么方便，但是当你必须生成Word文档时，它肯​​定是可行的。

如上所述，一般而言，文档是软件开发过程的产物，必须以某种方式进行版本控制。否则，您的流程不完整。

Answer 2

版本控制系统虽然可以存储任意文件（如Word文档），但对用户编辑为源文本文档更有效，因为差异可以以面向行的方式有意义地表示给用户。

对于此和many other reasons，我最近在reStructuredText源文件中编写了所有文档，与其他源文件一起编辑并在版本控制中进行跟踪。在构建时，HTML和PDF版本与项目生成的其余文件一起呈现。

Answer 3

是

但请注意，许多文档将存储为二进制文件。这将限制将它们存储在源代码管理中的效用，这使得更难以看到细粒度的更改。

如果你有LaTeX文档或基于XML的文档，那么事情会更好。

Answer 4

理论上你可以控制任何东西，我听说设计师来源控制他们的Photoshop文件。如果您总是编写清晰的提交消息，则可以轻松回滚到以前的版本。

Answer 5

MS Word文档几乎被视为二进制文件，因此几乎不可能对不同版本的Word文件进行区分或合并。

这并不意味着它不能或不应该被置于版本控制之下，只是它不会帮助你解决冲突。

如果您需要，可能需要以纯文本格式（例如.tex）存储文档

Answer 6

对技术文档使用源代码管理是一个好主意，但是正如许多其他人所说的那样，Word并不是最佳的文件格式。

Word文件实际上是一个隐藏的XML文件文件夹（将.docx文件重命名为filename.zip，然后将其解压缩以查看该文件夹）。理论上，您可以为每个版本创建一个zip文件夹，将该文件夹存储在Git源代码管理中，并查看版本差异。但是，这确实是不切实际的，而且价值有限。

您还可以使用Pandoc将每个.docx文件版本转换为Markdown，并将Markdown文件置于源代码控制之下。

Word还具有内置的文件比较功能（“查看”>“比较”）。这将标记任何两个.docx文件之间的差异。

我喜欢使用Markdown或AsciiDoc文本文件来编写技术文档，并使用Gi​​t进行版本控制。 Git相当容易学习，可用于基本需求。该系统使我可以完美地控制文档，并了解文档的历史记录，因为文档的历史随着每个草稿，审阅者的评论等而变化。

Answer 7

不确定。我们在工作中这样做，并且真正有助于跟踪技术文档，有时可以像源代码本身一样频繁地更改：）

Answer 8

是的，你可以。 您可以将文件上传到版本控件，并为其保留更改历史记录。

Answer 9

正如其他人所说，您绝对可以将源代码管理用于您的技术文档。但是，我肯定会站在海报的旁边，建议进行重组测试。修订控制的全部要点是能够看到差异并在它们之间合并，在我的书中，你将需要使用文本文件来完成它。

restuctureText之外的其他一些选项是DocBook和DITA。它们在技术出版界非常流行，并且都基于XML，所以它们有一些不错的支持工具。对于DocBook，您可以查看XML Mind。

Answer 10

事实上，MS协作解决方案 - 即Team System - 使用SharePoint来实现这一目标。我几乎不了解SharePoint，并且很容易使用它来保留技术文档的版本一段时间。

如果您想直接在字词中使用它，可以尝试使用{-3}}字样的加载项。

假设您使用Visual Studio作为团队系统服务的主要界面，请单击View-＆gt; Team Explorer。如果您还没有，请设置您的存储库服务器并添加您的项目（对于大多数这些东西，网上都有很好的here。）

在项目树节点下，转到 Documents ，然后创建/添加您的文档。编辑它，检查＆amp;随意退房（让你的队友也这样做）。当您需要文档的版本历史记录时，请从团队资源管理器窗口中打开它。在将要启动的单词app中，您应该（在默认情况下）右侧是“SharePoint”面板。 （我写这篇文章时没有访问团队客户，但我很确定我没有犯任何不可恢复的错误......）。在其中，导航到 info 标签，然后向下滚动到'历史记录...'（或者它是版本... ？确切地说详情明天。）

Answer 11

我将简历作为LibreOffice文档保存在Git存储库中。它工作正常；版本控制不适用于二进制文件的想法绝对是错误的。

真实的是二进制文件需要适当的差异和合并工具，但是Git允许您指定这些文件。就我而言，我从来没有这样做，但是确实存在LibreOffice / OpenOffice文件的diff实用程序。