技术文档写作:如何使用DITA XML进行写作

Technical Writing: How to Write Using DITA XML

如何使用 DITA XML 成为现代成功的科技作家

课程亮点

本课程专为希望提升使用 DITA XML 进行结构化文档编写技能的中高级技术文档编写人员设计。您将获得创建复杂用户指南的能力,并掌握内容重用和个性化艺术。通过 DITA XML 的宝贵知识,改变您的技术写作生涯,在求职面试中脱颖而出。立即报名,解锁高级技术写作机会!

您将获得的技能: 创建 DITA XML 文档、实施内容重用策略、有效个性化用户指南、配置交互式图像和链接

要求

  • 您需要一台个人电脑或笔记本电脑来安装所需软件并完成课程中的练习
  • 本课程不适合在移动设备或平板电脑上使用
  • 技术写作基础知识建议具备

课程介绍

你想学习如何使用 DITA XML 编写结构化文档吗?如果是,我可以帮助你!

我叫 Jordan Stanchev。我在过去 20 年里建立了我的技术传播领域的职业生涯。

我最初是一名 Java 开发者,后来成为了一名高级技术作家,并作为一名 DITA 信息架构师建立了我的职业生涯。

我已为管理员和开发者撰写了数千页的软件文档指南。我参与过的软件产品涉及安全领域、消息服务以及开发基础设施(如 GitHub 和 SAP NWDI)。

如今,我已成为负责开发基于 DITA XML 的基础设施项目的团队一员。我们服务的科技写作者社区拥有超过 1000 名作者。此外,在一家财富 100 强的公司——SAP SE 中,我领导着一个近 300 人的 DITA 信息架构师专家小组。除了用户指南,我还需要不断撰写软件开发规范和项目文档。

我能说什么呢,我在使用 DITA XML 进行结构化写作和信息架构方面拥有丰富的经验。这也是我在本课程中关注的重点。

根据我的经验,我可以告诉你的,对于希望在技术传播领域发展职业生涯的现代技术文档作者来说, 掌握 DITA XML 是必须的 !

你简直无法相信,我有多频繁地收到学生们的反馈,说这门课程的知识是他们成功突破 DITA 技术写作工作面试并帮助其职业发展的关键!

要实现最终的职业目标,你只需要学习使用 DITA 进行写作!

DITA 知识对于任何以技术写作者身份参与软件文档工作的人来说都至关重要!

  • 技术写作者;

  • 信息架构师;

  • 团队经理,负责管理技术文档撰写人员;

  • 用户体验设计师;

  • 业务分析师;

  • 项目经理;

课程“ 如何使用 DITA XML 编写 ”专为希望深入探索 DITA 功能、创建复杂和个性化的用户指南,并使用 Oxygen Author 工具将这种单源输出交付到各种交付渠道的中高级技术文档编写人员设计。

该课程基于我在大学为学生提供的在线 DITA XML 培训。

警告:

这堂课程从开始到结束,你需要大约 8-10 个小时的时间来学习这些材料!它包含许多各种的实践练习、示例,以及基于我实践经验的建议。

我建议你每天最多学习一个部分 ,以避免被信息淹没,并能够完成所描述的每个练习。

本课程进一步深入探讨和详细阐述了课程 《DITA 技术写作快速入门》 中介绍的基本概念和知识,然后提供了更多高级的细节和策略,例如内容的复用和基于用户画像策略的内容个性化。

注意:

如果你正在寻找快速入门 DITA 的方法, 可以考虑基本的 DITA 课程《使用 DITA 进行技术写作的快速入门》, 这门课程适合尚未熟悉 DITA 的技术传播者。

课程需要多长时间?简而言之:

第一部分:介绍 – 70分钟

第二部分:5 个快速步骤来使用 DITA XML 进行写作 – 50 分钟

第三节:DITA 元素 – 25 分钟

第四节:在 DITA 中重用内容 – 50 分钟

第五节:在 DITA 中配置(条件化)内容 – 60 分钟

第六节:技术传播者的信息架构 – 50分钟

第七部分:DITA 作者的信息架构 – 90 分钟

第八部分:如何在 DITA 中创建交互式图像 – 80 分钟

第九部分:DITA 中的链接 – 77 分钟

第十部分:自定义 DITA XML 输出 – 60 分钟

你将学到什么?

第一部分:介绍 – 70分钟

学完本部分后,你将能够解释:

– 什么是 DITA;

– 使用 DITA 编写软件文档的益处是什么;

仅仅列举使用 DITA 编写的益处就需要花费大量时间!DITA 越来越受欢迎的原因有很多。如今,如果你不知道如何使用 DITA XML 编写软件文档,就不可能成为一名现代技术文档编写者!它是事实上的标准 XML 编写格式!你必须了解并说明 DITA 的益处,而且可以肯定,在求职面试中你将会被问到为什么 DITA 如此重要。

仅列举几点:

– 基于通用信息类型。

– 这意味着写作有严格的规定,无论技术写作者是谁!

– 内容模块化且可重用。

– 从相同的 DITA 源自动生成各种输出;

– 内容可以个性化,等等。

第二节:5 分钟快速掌握 DITA XML 写作 – 50 分钟

通过本节,您将能够:

– 应用创建用户指南内容的 5 个步骤 ;

– 解释 什么是 DITA 地图 ;

– 创建三种最常用的 DITA 主题类型:任务、概念和参考;

– 创建 DITA 地图 ;

– 在地图中引用主题,使用构建交付物(用户指南),通过 Oxygen XML Author;

使用 DITA 写作很简单。不要让标签的多样性以及 DITA 的众多功能让你感到困惑。

你需要制定一个策略(你想要传达的内容)以及一套简单的步骤来构建你的指南(本课程这一部分将进行解释)!

第 3 节:DITA 元素 – 25 分钟

本节结束时,你将能够:

– 命名最常用的 DITA 主题元素(DITA 标签);

– 描述在特定主题上下文中使用主题元素 的策略 ;

– 打开、搜索并选择主题中的所需主题元素;

– 在任务主题上下文中使用 主题元素列表 ;

DITA 提供了大量的标签供使用。这些标签带来了写作内容的极大灵活性。但您从何处开始?哪些元素是“必须了解”的,哪些是“可选了解”的?本节将帮助您了解这些内容,为您的写作内容打下坚实的基础。

第 4 节:在 DITA 中重用内容 – 50 分钟

通过本节,您将能够:

– 描述 复用的好处 ;

– 在 地图 级别重用内容(mapref);

– 在主题 级别(topicref)重用内容;

– 在 主题元素 层级重用内容(conref);

– 重用整个 表格行 (conref – conrefend);

在所有这些层面上重用内容,可以让你显著减少编写文档所需的时间。这是 DITA 最重要的优势之一。

让我给你举个例子:你可以在主题元素级别使用重用功能来定义你的软件产品的名称作为一个可重用的主题元素。然后你可以在整个文档中使用这个元素。稍后,当产品名称发生变化时,你只需更新可重用主题元素的价值,它就会自动更新到每个文档中的所有出现位置!对比一下你在 Word 文档或维基页面上搜索并替换产品名称所需的时间!

第 5 节:DITA 中的内容分析(条件化)- 60 分钟

本节结束时,你将能够:

– 描述使用内容分析(条件化)的好处 ;

– 在 地图 层级上的配置内容;

– 在一个 主题 层级上的配置内容;

– 在一个 主题元素 层级上的配置内容;

– 配置 表格行 ;

今天,每个人都在谈论软件的用户体验个性化。那么,软件文档的用户体验个性化呢?

分析功能允许您为目标受众个性化内容,而不会中断创作过程。最终生成的个性化最终用户指南是根据作者设置的规则自动生成的。对于 DITA 中任何非结构化内容写作方式来说,几乎不可能的事情,在几次点击内就完成了!

第6节:技术传播者的信息架构 – 50分钟

通过本节,您将能够解释:

– 什么是 信息架构 ?

– 信息架构师是谁 ?

– 要成为高效的信息架构师,需要考虑什么 ?

从这一部分开始,我们将提升要求!这门课程不仅适合那些想学习使用 DITA 写作的人,也适合那些希望在职业生涯中有所成长的人。技术写作的下一阶段叫什么?它叫做”信息架构”。但什么是信息架构?你应该从今天开始做些什么,才能成为信息架构师?

这就是本节所解释的内容。信息架构师拥有更高层次、更广泛、更全面的内容创建过程视角。你不再专注于单用户指南的整洁且贪婪的细节。相反,你着眼于整体图景,关注你的内容如何组织、在哪里组织,以及它如何契合端到端的客户体验。

在本节中,你将学习信息架构的基础知识,并开启作为技术写作者职业生涯下一阶段的大门。

第 7 节:DITA 作者的信息架构 – 90 分钟

到本节结束时,你将能够解释:

– 如何让技术文档作者在专用 DITA 地图范围内控制分析值的用法 govern the usage of profiling values by technical writers

– DITA 主题方案地图是什么

在本节中,我将探讨许多技术文档作者未能意识到的一个方面。通常,这是作为技术文档作者与作为 DITA 信息架构师之间的区别。我将解释如何使用 DITA 来控制不同作者如何在您的地图中分析内容,减少分析错误,并确保最终生成的个性化文档质量更好。

第 8 节:如何在 DITA 中创建交互式图像 – 80 分钟

通过本节,您将能够:

– 描述在技术写作中使用图像的规则 ;

– 列出用于创建图形的工具 ;

– 解释 DITA 中交互式图形和图像映射是什么;

– 描述使用 交互式图形 的好处;  

– 为文档中的图像创建 图像映射 ;

第九部分:DITA 中的链接 – 77 分钟

DITA XML 具有强大的功能,可以帮助技术写手和信息开发者以最佳方式组织文档。

任何专业的技术写作者都会告诉你,你必须创建并插入指向外部内容的链接,例如网站,同时也要引用 DITA 地图中的其他主题,以便为读者提供具有出色导航能力的技术文档交付成果。

但这意味着你需要浪费时间去手动创建和维护这些链接吗?作为一名专注于为读者提供最佳信息的技术写作者,你的时间是宝贵的!维护链接而不是为读者提供有价值的指令和内容是你应该做的! 不是 !

DITA 如何帮助你实现这一点呢?

你会惊讶地发现,有多少技术写作者甚至不知道 DITA XML 支持自动生成的链接。你只需要激活所需的链接选项,链接就会自动出现在生成的输出中!

而且情况会更好,链接只有在存在有效的链接目标时才会显示!

那么对你有什么好处呢? 显然:

  • 你花在插入链接上的时间更少。

  • 文档中链接损坏的机会更少——从而提高内容质量!

  • 链接的一致性更好——你选择一种链接策略,链接将在整个文档交付物中以一致的风格显示。

  • 你有更多时间专注于最重要的事情——向最终用户传递高质量信息!

一旦你学会如何在 DITA XML 中使用链接,你就会获得这些好处!

在本课程中,我们将涵盖以下主题:

手动创建的链接

您将学习如何创建链接到:

  • 一个网站

  • 一个资源

  • 另一个 DITA 主题

  • 在同一个主题的不同章节之间!

自动生成的链接

您将学习如何使用 collection-type 属性设置和触发链接的自动生成。您将学习创建以下类型的链接:

  • choice

  • 家庭

  • 序列

本节将涵盖以下主题,每个主题都配有演示和练习,您可以使用 Oxygen XML Author 编辑器进行操作。

第 10 节:自定义 DITA XML 输出 – 60 分钟

在本节结束时,您将能够:

– 根据预定义(但可自定义!)的 HTML 输出配置您的 HTML 外观和感觉

为什么是 DITA?

DITA XML 中的结构化写作是技术写作者的高级学科 。您可以找到许多具有良好语言和写作能力的作者。但您已经知道,技术写作远不止于没有拼写错误的纯文本,不是吗?

如果你需要你的技术文档作者:

– 严格 遵循公司或行业的写作 指南 ;

– 能够将 维护旧文档的时间减少,将更多时间用于为客户创造价值的活动;

– 在所有层级上提供 可重用的信息 ——包括整个指南、章节、主题、句子,甚至单个词语;

– 保持非常高的 内容质量 标准,确保没有损坏的链接和缺失的内容;

– 产出客户需要的尽可能多的不同输出格式 ——所有内容均来自同一份内容

– 使用元数据对已编写的内容进行分类 ,并提供给自动化的信息消费形式;

那么,你很可能已经在评估 DITA 作为写作选项了。

DITA 已经提供了所有列出的功能,甚至更多!

作为一名懂得使用 DITA 的技术文档编写者, 你将有机会进入世界上一些顶尖的 IT 公司开启职业生涯 !

使用 DITA 的公司

以下是一些使用 DITA XML 编写文档的公司名称:

– Apple

– IBM(毕竟他们发明了 DITA!)

– Google

– VMware

– SAP SE

并且还有数百家其他公司,其中许多公司属于 IT 和软件开发行业!

学员怎么说?

“我重视全面培训、具有挑战性的实践作业,以及用来提高和指导我写作的各种技巧!”

– Devon Apple, 网页开发者

“ 如果你想了解如何使用 DITA 进行写作,可以去学习这门课程!讲师提供了非常精彩的解释和教程,这些在实际操作中非常有帮助。“

– 卡里娜·德尔切娃 , 技术作家

“ 对 DITA 和 XML Author 软件世界的非常优秀且易于理解的介绍。我强烈推荐这门课程给所有希望快速了解该主题并开始使用的人…“

– Boris, 一名大学生

如果你正在寻找作为 DITA 技术写作者提升职业发展的途径,这门课程就是为你准备的!我确信,仅通过在 Google 上搜索,你就已经看到,像这样的课程费用远超 1000 美元,并且至少需要一周的实体或在线参与、差旅费用,而且…通常甚至无法涵盖我在这里呈现的一半材料!感谢 Udemy 致力于为尽可能多的人提供最佳课程的策略,我们成功将费用降低至仅 199 美元,仅在 Udemy 平台上!

课程仍然包含一个互动和社区部分 ——你将获得我们 JPDocu Learning Facebook 页面上封闭学习社区的访问权限。

你将有机会直接与这门课程的讲师联系 ,并获得关于使用 DITA 的个性化反馈。

你将在成功完成这门课程后获得一份宝贵的证书 ,可以放在你的简历上,或分享到 Facebook 和 LinkedIn——不要低估这份证书的重要性——没有它,你很可能永远无法进入你梦想工作的面试短名单!

也许最重要的部分,将让你不仅能够进入而且能够突破一个工作面试——你自己的作品 ,你可以用它来展示你学到的知识以及如何应用 DITA 来制作文档!

立即报名 ,看看使用 DITA XML 进行技术写作有多么简单和有益!

P.S. 如果你想在软件开发公司担任技术写作职位——请检查两件事:

1. 他们是否使用 DITA XML 编写软件文档?

2. 他们使用什么工具进行写作?

在面试前就做好准备,展示你使用 Oxygen XML Author 编写的 DITA XML 文档,并证明你擅长应用重用策略和高级 DITA 技术——包括配置文件、自动链接和图像映射。

附言:别忘了,本课程提供30天全额退款政策——无需任何理由!

这门课程适合谁:

  • 想要提升 DITA 知识的技术人员
声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。