科技写作的版本控制

Question

我在包括这里在内的不同地方寻找答案，但无济于事，或者我由于缺乏版本控制经验而无法看到答案（原谅我的无知） 。

我正在一个技术人员团队工作，我们正在处理的文档包含典型的可重用部分（例如，描述在多个应用程序中使用的GUI元素）。当这样一个GUI元素更新到更新的版本并且这个更改影响多个文档时，问题就出现了。是否有办法自动检查所有文件是否与组成部分相关，以查看文件是否与上述组成部分相符？

Answer 1

你所描述的不是我认为的版本控制问题。通过类推，如果程序使用算法并更新算法，我们不使用版本控制来检测使用算法的所有位置是否是最新的。相反，我们使用DRY（不要重复自己）等原则 - 以及促进这些原则的工具 - 来构建软件。

如果您可以在允许您执行链接图像（而不是嵌入它们）之类的环境中创建软件，那可能会有所帮助。顺便提一下，一个好的文档管理包可以提供这种类型的东西，但版本控制功能也可能比git提供的更适合技术文档需求。

Answer 2

我明白了为什么你想到“版本控制”，但我同意其他答案，这不是一个版本控制问题。

我认为你正在寻找一种通常被称为“包含能力”的东西：你有N个引用相同GUI元素的文档：而不是重复N次与GUI相关的变化，你会做出改变只有一次，N个文档将“包含”描述GUI的文档。

例如，asciidoctor，轻量但功能强大的文档标记系统具有include的这个概念。 （许多其他系统都有这种能力）。

查看这个blog post的例子;它指的是包含部分代码，但是可以使用相同的概念来包括文本和图像的部分。

查看http://asciidoctor.org了解更多信息。