如何最好的版本设计文件？ [英] How to best version design documents?
问题描述
已经有一些关于SO的讨论（和这里）之前关于办公室文件如何版本化，但是我认为我的问题仍然有些不同。
我的编程项目从项目文件夹开始这是空的，除了名为设计文档的子文件夹，其中包含项目的功能规范的草案，并开始使用，后来扩展为包含API规范或其他任何需要。
自然地，我也检查这些文件到SVN。 我正在寻找的是良好的文件格式和策略，可以在整个版本，差异化和合并过程中发挥出色。例如，我认为最好将文字处理器文件存储为XML或者对于读者来说，差异是否会变得丑陋和无用？以下是我想要做的：
- diff和合并文本文档（必须有OOo，nice-to-have MS Word）
- diff（可能合并，虽然这可能在概念上很困难）架构图，如UML图。我认为这些可以是独立的XML / SVG文件，并被链接到文本文档中，但是我不知道这些文档是如何工作的，以说明是否可以实现。
- 在文本文档中显示自动更新的修订版本号（可能与 svn：keywords ）
有没有人做过这样的事情？可能有一些关于OOo文件的文档和教程等等，我可以查看，但是我也很欣赏这些指南，我主要是寻找在实践中做的或者没有工作的第一手帐户。
编辑：只要确定，这里没有涉及非技术用户 。它只是程序员，文档仅用于编程项目。可能会出版PDF，但这只是另一个构建的文物，没有什么必须进行版本化。
仍然，我们不真的想要使用Tex等。我知道这是非常好的，但我只是不能打扰一个简单的文本文档。我们必须学习它，获得所有额外的包，将Tex-to-PDF渲染添加到我们的构建过程等。这将是一个仅仅是两个或三个文档的一个编程项目。如果有什么，我宁愿使用HTML，但是一个文字处理器对我来说似乎是一个很好的选择，除了我想要的版本更好。
还有一个想法：有一些像OOo的SVN插件或其他方式吗？或者甚至，为OOo添加SVN支持需要什么？像文件菜单中的同步选项和修订号文本字段一样。我的意思是说，这不会真的成为我们业务的一部分，但它会很酷，毕竟我是老板。
WYSIWYG编辑器（Word，OpenOffice）一般不会看到任何人为什么会弄乱他们的文件的原因，所以找到非技术用户可以使用和的编辑器，这是友好的到版本控制系统是不可能的。例外：git有一个可以查看OpenOffice文件的过滤器。我不知道您是否可以使用关键字扩展。
我建议您为用户使用维基和一周的培训。它解决了所有的问题（一些维基甚至可以被检入版本控制系统）。正如我在不同的帖子中所说的，唯一的障碍是用户将需要几天才能习惯这个想法。之后，他们会爱上它。
There has been some discussion on SO (here and here) before on how office documents can be versioned, however I think my question is still a little different.
My programming projects start with a project folder that is empty except for a subfolder named "Design Documents", which contains a draft of the project's functional spec to begin with and is later expanded to contain API specs or whatever else is needed.
Naturally, I check these files into SVN as well. What I'm looking for is good file formats and strategies to play well with the whole versioning, diff'ing and merging processes. For example, I reckon it would be best to store word processor files as XML, or would the diffs be ugly and useless for human readers? Here's what I'd like to do:
- diff and merge text documents (must-have OOo, nice-to-have MS Word)
- diff (and maybe merge, though that might turn out to be conceptually difficult) schema drawings, like UML diagrams. I was thinking that these could be independent XML/SVG files and be linked into the text documents, but I don't know enough about how these documents work to tell if that's actually possible.
- show automatically updated revision numbers inside the text documents (maybe with svn:keywords)
Has anybody done this kind of thing already? There's probably a number of documentation and tutorials on OOo files etc. that I could look up, but while I also appreciate pointers to those, I'm mainly looking for first-hand accounts of things that did or didn't work in practice.
Edit: Just to be sure, there's no "non-technical users" involved here. It's just programmers and the documents are for use on programming projects only. There may be PDFs to be published but that's going to be just another build artefact, nothing that has to be versioned.
Still, we don't really want to use Tex or the like. I know it's great and all, but I just can't be bothered for a simple text document. We'd have to learn it, get all the extra packages right, add Tex-to-PDF rendering to our build process etc. It would be like a little programming project just for the two or three docs. If anything, I'd rather use HTML, but a word processor still seems like a good option to me, except that I want good versioning.
There's another thought: Is there something like an SVN plugin for OOo or the other way around? Or even, what would it take to add SVN support to OOo? Like a "Synchronize" option in the File menu and a "Revision number" text field. I mean, that would not really be part of our business, but it would be cool, and after all, I'm the boss.
WYSIWYG editors (Word, OpenOffice) generally don't see a reason why anybody else should mess with their files, so finding an editor which a non-technical user can use and which is friendly to a version control system is impossible. Exception: git has a filter which can look into OpenOffice files. I'm not sure if you can use keyword expansion, though.
I suggest to use a wiki and a week of training for your users how to use it. It solves all your problems (some wikis can even be checked into a version control system). As I said in a different post, the sole obstacle is that users will take a few days to get accustomed to the idea. After that, they will love it.
这篇关于如何最好的版本设计文件？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
