2

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

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

我有三个选择：

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

选项 1 不现实，因为我无权接触 DITA 开发人员。再加上将专业化设计为伪代码也并非易事。

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

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

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

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

4

6 回答 6

5

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

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

请注意，如果您只需要一个可区分的主题类型标签名称，那么定义新的主题类型非常简单：这完全是复制、粘贴和重命名的练习，任何人都可以做到。

http://www.xiruss.org/tutorials/dita-specialization/上的配置和专业化教程将引导您完成它，尽管现在看它们，我发现主题专业化教程实际上比仅仅做一个简单的 root 更多 -仅标记名专业化。

于 2013-03-02T12:15:37.070 回答
4

类型概念、任务和参考并非专门用于计算机文档。我也将这些任务用于

  • 教科书
  • 啤酒自酿指南
  • 烹饪食谱

对于所有这些示例，可以（并非总是那么容易）将内容划分为标准 Dita 类型。您的术语“不是计算机文档”太含糊了。我认为当您更多地介绍您的内容时，许多dita专家可以为您提供建议。

于 2013-03-01T16:43:03.917 回答
3

尽管 DITA 是作为技术文档的语言开发的，但这与我认为您所说的计算机文档不同。

使用概念类型来提供信息，这些信息有助于通过帮助用户了解某事来确定他们的方向。这可以像“为什么我需要遵循这个 SOP”一样简单，或者它可以描述一些神秘算法的工作原理（如果您的用户需要理解这一点才能正确执行任务）。

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

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

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

如果您愿意，您可以使用通用主题，但使用 CTR（概念、任务、参考）模型组织信息在技术交流方面具有成功的记录，即使信息不属于技术性质，也可能对您的用户有所帮助。例如，想想一个商业演示。它通常以“什么是 whoozy 小部件”开头，然后是“whoozy 小部件将如何改变您的生活”，最后是购买链接或获取有关 whoozy 小部件的更多信息。点击率。

于 2013-03-07T12:03:36.803 回答
2

如果您无权访问开发人员，您可以使用DITA Generator生成一个简单的专门化，它只添加一个新的根元素。即使您不创建结构专业化，您仍然应该生成自定义外壳 DTD。这将允许您使用诸如任务之类的基本主题类型，但如果您不需要它们，则不包括例如编程和软件领域。

于 2013-03-03T10:23:23.017 回答
1

在很多这样的情况下，人们必须根据创作时对语义标记内容的要求程度来评估 DITA 的好处，以便根据观众的需要进行渲染。我认为专业化是实现更高级别语义标记的唯一途径。例如，您可能有一个名为需求的专门主题。但是，随着时间的推移，您可能需要进一步将需求元素专门化为其他类型，例如硬需求、软需求、强制要求、法规要求、功能要求、非功能要求等。另一个考虑因素在决定专业化水平的同时，是否需要任何其他系统使用带有该专业化标签的内容，如果需要，

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

于 2013-04-25T00:16:50.967 回答
0

而且您没有使用概念，因为...？

根据我的经验，很容易说，我们的客户使用了很多概念，甚至是通用主题。这在几个行业中确实很常见。我想说，如果您的文档不是指导性的（任务），只需使用概念，然后您就不必专门研究任何内容。

但是如果出于某种原因你需要一些非常特别的东西，你应该考虑专业化。只需访问http://dita-generator-hrd.appspot.com/并使其成为可能。:)

于 2013-04-19T11:30:31.803 回答