当我不编写计算机文档时，我会使用哪种DITA主题类型？

Question

我是一名技术作家，正在使用DITA编写通用业务流程标准。我之所以选择使用DITA是因为它具有出色的主题组合，内容参考和条件分析，所有这些都将帮助我控制我复杂的，相互关联的文档。

我需要选择要使用的主题类型。

我有三个选择：

1. 我可以专注于我自己的主题类型，以满足我的确切需求
2. 我可以使用主题。
3. 我可以使用一个或所有OASIS计算机文档主题（概念/任务/参考）。

选项1不切合实际，因为我无法访问DITA开发人员。另外，即使伪代码设计专业化也不是一件容易的事。

这使选项2和3成为现实。

选项2让我使用主题主题。这给了我灵活性，因为它是最宽容的主题类型。它也是最“干净”的，因为我没有使用为其他东西设计的主题类型。然而，主题主题实际上是专业化的基础，不应该直接使用。

选项3让我使用计算机文档主题。我可以或多或少地让我的内容适合他们。但是，它们实际上是用于以特定方式编写的“tripane help”类型的内容。例如，这些主题类型通常用于根据John Carroll的极简主义进行编写，该极简主义鼓励用户进行实验，并专注于用户的任务。我的文件规定了要求，我不想在写作中鼓励极简主义原则。

选项2和3都涉及妥协。编写流程标准的两者中哪一个更好？

Answer 1

另一种选择是使用DITA for Publishers项目提供的主题类型，这些主题类型旨在为典型的非技术文档发布组件建模：文章​​，章节，小节，侧栏和部分。

DITA for Publishers项目位于http://dita4publishers.sourceforge.net。

请注意，如果您需要的话，定义新的主题类型是一个与众不同的主题类型标记名称，这很简单：它完全是复制，粘贴和重命名的练习，任何人都可以这样做。

http://www.xiruss.org/tutorials/dita-specialization/上的配置和专业化教程将引导您完成它，虽然现在看着它们，但我发现主题专业化教程实际上比仅仅执行简单的root-tagname专用化更为复杂。

Answer 2

类型概念，任务和参考不仅适用于计算机文档。我也将这些任务用于

• 课本
• 啤酒自酿指南
• 烹饪食谱

对于所有这些例子，可以（通常不容易）将内容划分为标准Dita类型。 您的术语“非计算机文档”过于模糊。我认为，当你详细介绍你的内容时，很多专家都可以为你提供建议。

Answer 3

虽然DITA是作为技术文档的语言开发的，但这与我认为您的计算机文档的含义不同。

使用Concept类型提供的信息有助于通过促进用户对某事物的理解来确定用户的方向。这可能就像“为什么我需要遵循此SOP”一样简单，或者它可以描述一些神秘算法是如何工作的（如果您的用户需要了解它以正确执行任务）。

每次描述用户执行活动的方式时，请使用“任务”类型。这不一定是带有“单击此”和“键入”的步骤的编号列表（尽管这是软件文档的常见用例）。如果需要，它可以（特别是如果你使用“一般任务”类型）更自由形式。这里的区别在于您提供某种方向。

使用引用类型提供用户可能需要查找的信息（通常用于支持活动）。如果主题完全是一个列表或表，那几乎可以肯定是参考信息。

有经验的技术交流者有时可能不同意在特定情况下使用哪种主题类型，但这些是区分这三种主要主题类型的一般指导原则。

如果您愿意，可以使用通用主题，但使用CTR（概念，任务，参考）模型组织信息已经证明了技术通信成功的成功记录，并且即使信息不是技术性。例如，考虑一下业务演示。它通常以“什么是whoozy小部件”开头，继续“whoozy小部件将如何改变你的生活”，并以购买链接或获取有关whoozy小部件的更多信息结束。 CTR。

Answer 4

如果您无权访问开发人员，则可以使用DITA Generator生成仅添加新根元素的简单专门化。即使您没有创建structural specialization，您仍应生成custom shell DTD。这将允许您使用基本主题类型，如任务，但不包括例如编程和软件域如果你不需要它们。

Answer 5

在很多情况下，必须根据创作时对语义标记内容的严格要求来评估DITA的好处，以便根据受众需求进行呈现。我认为专业化是实现更高级别语义标记的唯一方法。例如，您可能只有一个名为要求的专门主题。但是，随着时间的推移，您可能需要进一步将需求元素专门化为其他类型，如硬需求，软需求，强制需求，法规要求，功能需求，非功能需求等。另一个考虑因素在决定专业化水平的同时，标记有此专业化的内容是否需要被任何其他系统使用，如果是，那么两个系统的语义是如何紧密对齐的，以及如果存在这种情况，后退处理将如何工作没有匹配元素。

不是为了阻止任何人尝试而是现实地，为某些领域开发全面的DITA专业化需要很长时间。对于半导体行业，自2007年以来正在开发一个名为SIDSC的专业化，涉及许多公司和开发人员，由于其复杂性，它仍未在整个行业中广泛使用。但是，由于我们的产品在复杂性方面趋于增长，因此我们公司的信息开发人员能够更好地跟上文档和发布挑战，因为我们正在使用此专业化。

Answer 6

你没有使用概念，因为...？

根据我的经验很容易说，我们的客户使用了很多概念甚至是通用主题。这在几个行业中确实很常见。我想说，如果你的文档不是教学（任务），只需使用概念，那么你就不需要专门化了。

但如果某些原因你需要非常特别的东西，你应该考虑专业化。只需转到http://dita-generator-hrd.appspot.com/即可。 ：）