技术写作:如何使用 DITA XML 写作
如何使用 DITA XML 成为现代成功的技术作家
讲师:JPDocu School of Technical Writing
口袋资源独家Udemy付费课程,独家中英文字幕,配套资料齐全!
用不到1/10的价格,即可享受同样的高品质课程,且可以完全拥有,随时随地都可以任意观看和分享。
你会学到什么
- 学习使用 DITA XML 主题和地图进行写作
- 使用 Oxygen XML Author 工具生成文档可交付成果
- 在地图级别 (mapref)、主题级别 (topicref)、主题元素级别 (conref) 和表行 (conref – confend) 上重用
- 基于相同 DITA 内容的个性化用户指南,使用内容分析(调节)
- 创建交互式图像并创建图像映射
- 如何配置和自定义 DITA HTML 输出
要求
- 您需要一台 PC 或笔记本电脑来安装所需的软件并按照课程中的练习进行操作
- 本课程不适合在移动设备或平板电脑上使用
- 推荐技术写作的基础知识
描述
您想学习如何使用 DITA XML 编写结构化文档吗?如果是,我可以帮忙!
我叫乔丹·斯坦切夫。在过去的 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 的技术传播者。
课程需要多少时间?简而言之:
第 1 部分:简介 – 70 分钟
第 2 部分:使用 DITA XML 编写的 5 个快速步骤 – 50 分钟
第 3 部分:DITA 元素 – 25 分钟
第 4 部分:重用 DITA 中的内容 – 50 分钟
第 5 部分:分析(调节)DITA 中的内容 – 60 分钟
第 6 部分:技术传播者的信息架构 – 50 分钟
第 7 节:DITA 作者的信息架构 – 90 分钟
第 8 部分:如何在 DITA 中创建交互式图像 – 80 分钟
第 9 节:DITA 中的链接 – 77 分钟
第 10 节:自定义 DITA XML 输出 – 60 分钟
你会学到什么?
第 1 部分:简介 – 70 分钟
到本节结束时,您将能够解释:
–什么是 DITA;
-使用 DITA 编写软件文档有什么好处;
仅仅阐明用 DITA 编写的好处就需要花费很多时间!DITA 越来越流行的原因有很多。今天,如果您不知道如何使用 DITA XML 编写软件文档,您就不能成为现代技术作家!它是事实上的写作标准 XML!您必须知道并阐明 DITA 的好处,并且可以肯定的是,在求职面试中您会被问到为什么 DITA 如此重要。
仅举几个:
– 基于常见的信息类型。
– 这意味着严格的写作规则,无论技术作家是谁!
– 内容模块化且可重复使用。
– 从同一个 DITA 源自动生成各种输出;
– 内容可以个性化等等。
第 2 部分:使用 DITA XML 编写的 5 个快速步骤 – 50 分钟
到本节结束时,您将能够:
-应用创建用户指南内容的 5 个步骤;
– 解释什么是 DITA 映射;
–创建最常用的 3 种DITA 主题类型:任务、概念和参考;
–创建 DITA 映射;
– 地图中的参考主题以使用Oxygen XML Author构建可交付成果(用户指南);
用 DITA 编写很容易。不要让标签的多样性和大量的 DITA 功能让您感到困惑。
编写您的第一份指南所需要做的就是一个策略(您想要提供的内容)和一组要遵循的简单步骤来构建您的指南(在本课程的这一部分中解释)!
第 3 部分:DITA 元素 – 25 分钟
到本节结束时,您将能够:
– 命名最常用的 DITA 主题元素(DITA 标签);
– 描述在特定主题的上下文中使用主题元素的策略;
– 打开、搜索并选择主题中需要的主题元素;
-在任务主题的上下文中使用主题元素列表;
DITA 带有大量可供使用的标签。它们为编写内容带来了极大的灵活性。但你从哪儿开始呢?哪些元素是“必须知道”与“可选择知道”的?这就是您将在本节中学到的内容,以稳步开始您的内容。
第 4 部分:重用 DITA 中的内容 – 50 分钟
到本节结束时,您将能够:
– 描述重用的好处;
– 在地图级别重用内容(mapref);
– 在主题级别重用内容(topicref);
– 在主题元素级别 (conref)重用内容;
– 重复使用整个表格行(conref – confend);
在所有这些级别上重复使用内容可以大大减少您必须花在编写文档上的时间。这是 DITA 最重要的好处之一。
请允许我举个例子:您可以在主题元素级别上使用重用,将您的软件产品的名称定义为可重用的主题元素。然后,您可以在整个文档中使用此元素。稍后,当产品名称更改时,您更新可重用主题元素的值,它会在每个文档中的所有出现处自动更新!将此与您在 Word 文档或 Wiki 页面中搜索和替换产品名称所花费的时间进行比较!
第 5 部分:分析(调节)DITA 中的内容 – 60 分钟
到本节结束时,您将能够:
– 描述在您的内容中使用分析的好处;
–地图级别的个人资料内容;
–主题级别的配置文件内容;
–主题元素级别的配置文件内容;
– 配置表行;
今天每个人都在谈论软件用户体验的个性化。如何通过软件文档实现用户体验的个性化?
分析功能允许您为目标受众个性化内容,而不会中断创作过程。最终会根据作者设置的规则自动生成个性化的最终用户指南。对于在 DITA 中以任何非结构化方式编写内容几乎不可能的事情,只需单击几下即可发生!
第 6 部分:技术传播者的信息架构 – 50 分钟
到本节结束时,您将能够解释:
– 什么是信息架构?
–谁是信息架构师?
–成为一名高效的信息架构师需要考虑什么?
从本节开始,我们正在提高赌注!本课程不仅适用于想要学习使用 DITA 写作的人,也适用于那些想要在职业生涯中成长的人。技术写作的下一个级别的名称是什么?它被称为“信息架构”。但什么是信息架构?你应该从今天开始做什么,成为一名信息架构师?
这就是本节中解释的内容。信息架构师对内容创建过程拥有更高层次、更广泛和更全面的看法。您不再专注于单用户指南的简洁贪婪的细节。相反,您要着眼于大局,内容的组织位置和方式,以及它如何适应端到端的客户体验。
在本节中,您将学习信息架构的基础知识,并为您作为技术作家的职业生涯的下一阶段打开大门。
第 7 节:DITA 作者的信息架构 – 90 分钟
到本节结束时,您将能够解释:
– 如何在专用 DITA 映射范围内管理技术作者对分析值的使用
–什么是 DITA 主题方案图
在本节中,我将触及许多技术作家没有意识到的一个方面。通常,这就是 DITA 技术作家和信息架构师之间的区别。我将解释如何使用 DITA 来控制不同作者如何在您的地图中分析内容,减少分析错误并确保最终生成的个性化文档的质量更高。
第 8 部分:如何在 DITA 中创建交互式图像 – 80 分钟
到本节结束时,您将能够:
– 描述在技术写作中使用图像的规则;
– 命名用于创建图形的工具;
– 解释什么是DITA中的交互式图形和图像映射;
– 描述使用交互式图形的好处;
-为文档中的图像创建图像映射;
第 9 节:DITA 中的链接 – 77 分钟
DITA XML 具有强大的功能,可以帮助技术作家和信息开发人员以最佳方式组织文档。
任何熟练的技术作家都会告诉您,您必须创建和插入外部内容(例如网站)的链接,而且还需要从您的 DITA 地图中引用其他主题,以便为您的读者提供出色的导航功能的文档可交付成果。
但这是否意味着您需要浪费时间手动制作然后维护这些链接?作为专注于向读者提供尽可能最好的信息的技术作家,您的时间非常宝贵!维护链接而不是为您的读者提供有价值的说明和内容不是您应该做的!
DITA 如何帮助您?!
您会惊讶地发现有多少技术作家甚至不知道 DITA XML 支持自动生成链接。您需要做的就是激活所需的链接选项,您的链接将自动出现在生成的输出中!
而且它变得更好,链接只会在存在有效链接目标时出现!
那对你有什么好处呢? 明显地:
- 更少的时间浪费在插入链接上。
- 文档中出现断开链接的机会更少 – 导致更高的内容质量!
- 更好的链接一致性——您选择一种链接策略,并且链接在您的整个文档交付中以一致的风格出现。
- 您有更多时间专注于最重要的事情 – 向最终用户提供高质量的信息!
一旦您学习了如何在 DITA XML 中使用链接,这就是您将获得的!
在本课程中,我们将涵盖以下主题:
手动创建的链接
您将学习如何创建指向以下内容的链接:
- 一个网站
- 资源
- 另一个 DITA 主题
- 在一个和同一主题的部分之间!
自动生成的链接
您将学习如何使用collection-type属性设置和触发链接的自动生成。您将学习创建以下类型的链接:
- 选择
- 家庭
- 顺序
这些是我们将在本节中介绍的主题,每个主题都附有您可以使用 Oxygen XML Author 编辑器执行的演示和练习。
第 10 节:自定义 DITA XML 输出 – 60 分钟
到本节结束时,您将能够:
-根据预定义(但可自定义!)HTML 输出配置 HTML 输出的外观
为什么是 DITA?
DITA XML 中的结构化写作是技术作家的一门高级学科。您可以找到许多具有良好语言和写作技巧的作者。但是您已经知道技术写作不仅仅是没有拼写错误的文字,不是吗?
如果您需要您的技术作家:
– 严格遵循贵公司或行业的写作指南;
– 能够花更少的时间在维护旧文档上,花更多的时间为客户进行增值活动;
– 提供可在所有级别重复使用的信息– 整个指南、章节、主题、句子,甚至单个单词;
– 保持非常高的内容质量标准,没有损坏的链接和丢失的内容;
– 根据您的客户需求生成尽可能多的不同输出格式– 全部来自相同的内容
– 使用元数据对编写的内容进行分类,并将其提供给自动化的信息消费形式;
那么很可能您已经在评估 DITA 作为写作的一种选择。
DITA 已经提供了所有列出的功能甚至更多!
成为一名知道如何使用 DITA 的技术作家可以为您打开大门,让您在世界上一些最伟大的 IT 公司开始职业生涯!
使用 DITA 的公司
以下是一些使用 DITA XML 编写文档的公司名称:
– 苹果
– IBM(毕竟是他们发明了 DITA!)
– 谷歌
– VMware
– SAP 工程师
以及数百家 其他公司,其中许多公司属于 IT 和软件开发行业!
学生们在说什么?
“我重视全面的培训、具有挑战性的练习作业以及用于改进和告知我的写作的各种技巧!”
– Devon Apple,Web 开发人员
“如果您想知道如何使用 DITA 进行写作,请查看本课程!讲师提供了很好的解释和教程,这对实践很有帮助。 “
– Karina Delcheva,技术作家
“对 DITA 和 XML Author 软件世界的很好且易于理解的介绍。我强烈推荐这门课程给希望快速理解该主题并开始使用它的每个人…… ”
– 鲍里斯,大学生
如果您正在寻找一种方法来提升您作为 DITA 技术作家的职业生涯,那么这就是您的课程!我相信你已经通过谷歌搜索看到,像这样的课程花费超过 1000 美元,并且至少需要一周的实体和/或在线存在,差旅费用,而且……通常甚至不包括我在这里展示了一半的材料!由于 Udemy 向尽可能多的人提供最好的课程的政策,我们已经设法将成本降低到仅 199 美元,仅在 Udemy 上!
该课程仍然带有互动和社区部分——您将可以在我们的 JPDocu Learning Facebook 页面上访问一个封闭的学习社区。
您将有机会直接与本课程的培训师取得联系,并收到有关您在使用 DITA 时可能遇到的问题的个性化反馈。
成功完成本课程后,您将获得一份宝贵的证书,您可以将其放入您的简历中,或在 Facebook 和 LinkedIn 上分享 – 不要低估此证书的重要性 – 没有它,您很可能永远无法在您梦想的工作面试的入围名单!
也许是最重要的部分,这将使您不仅能够参加工作面试,而且还能通过工作面试 – 您自己的工作可以用来展示您学到的知识以及您如何应用 DITA 生成文档!
立即注册,看看使用 DITA XML 进行技术写作是多么简单和有益!
PS 如果您正在软件开发公司寻找技术作家的工作,请检查两件事:
1. 他们是否使用 DITA XML 编写软件文档?
2. 他们用什么工具写作?
甚至在面试之前就做好准备,展示您使用 Oxygen XML Author 编写的 DITA XML 文档,并证明您在应用重用策略和高级 DITA 技术(分析、自动链接和图像映射)方面有多出色。
PSS 不要忘记该课程附带 30 天全额退款政策 – 不问任何问题!
本课程适合谁:
- 想要提高 DITA 知识的技术作家