技术写作的版本控制

Question

我一直在包括此处在内的其他地方寻找答案，但无济于事，或者由于我缺乏版本控制经验而无法看到答案（对不起，请问无知）。

我正在一个技术作家团队中工作，我们正在处理的文档由典型的可重用部分组成（例如，描述在多个应用程序中使用的GUI元素）。 当这样的GUI元素更新到较新的版本并且更改影响多个文档时，就会出现问题。 有没有一种方法可以根据一组组成部分自动检查所有文档，以查看有关这些组成部分的文档是否是最新的？

Answer 1

您所描述的不是我认为的版本控制问题。

以此类推，如果程序使用算法并且算法已更新，则我们不使用版本控制来检测使用该算法的所有场所是否都是最新的。 取而代之的是，我们使用DRY（不要重复自己）等原理以及促进这些原理的工具来构建软件。

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

Answer 2

我知道您为什么要考虑“版本控制”，但是我同意其他答案，这不是版本控制问题。

我认为您正在寻找通常被称为“包含功能”的东西：您有N个文档引用相同的GUI元素：与其重复N次与该GUI相关的更改，您只需进行一次更改，然后N个文档将“包括”描述GUI的文档。

例如，asciidoctor是一种轻量级但功能强大的文档标记系统，具有包含这一概念。 （许多其他系统都具有此功能）。

有关示例，请参见此博客文章 。 它指的是包括部分代码，但是相同的概念可以用于包括部分文本和图像。

有关更多信息，请参见http://asciidoctor.org 。