我在大学兼职教授课程，上学期的一门课程是“数字技术写作”，学生们在其中了解了技术作者在行业中使用的不同技术和工具。主题包括 HTML、CSS、XML、DITA、Markdown、GitHub 以及其他写作工具和技术。
在上学期结束时，我和我的班级回顾了我们喜欢学习的技术。如果您刚开始从事技术写作，您可能会对这份开源技术列表感兴趣，这些技术可以使技术写作更轻松。
HTML
每个网站都建立在 HTML（超文本标记语言）之上。虽然专业技术作者可能会使用 Drupal 或 TYPO3 等基于 Web 的工具来创建网页，但了解 HTML 以了解幕后工作原理总是好的。虽然这种情况可能不会经常发生，但有时基于 Web 的工具会生成不正确的 HTML。技术作者需要知道如何在不进一步破坏网页的情况下编辑 HTML 以修复网页。
HTML 代码完全基于文本，标签位于尖括号内。元素可以是块级或内联，例如 <p> 用于定义块级段落，或 <em> 用于强调（通常是斜体）单词或短语。
技术作者可能会专注于用 HTML 编写内容，并在单独的 CSS 文件或样式表中定义样式，以定义内容在屏幕上的外观。这种内容和外观的分离是专注于写作的好方法。
Markdown
编写文档的另一种方法是使用 Markdown。Markdown 旨在通过尽可能多地删除标记语法来简化技术写作，并用您在纯文本文件中写作时可能使用的标准约定来代替它。
例如，要在 Markdown 中开始一个新段落，请在文本文件中添加一个空行。下一个段落从下一个文本块开始。通过在其下方绘制一条线来添加标题，例如这样创建一级标题
Title of my document
====================
以及这样在文档中创建子标题
How to use the software
-----------------------Markdown 通常用于在 GitHub 或 GitLab 上编写 Readme 文件或其他项目文档。这使得 Markdown 成为开源开发人员和技术作者的热门选择。
DITA
Darwin 信息类型化架构 (DITA) 本质上是一个具有特定文件结构的 XML 文件。当使用 DITA 创建项目文档时，技术作者专注于如何重用和混合内容以创建新型输出文件。
例如，三种常见的 DITA 文件格式是 DITA 概念，它描述一个事物或一个过程；DITA 任务，它列出了执行过程的步骤；以及 DITA 参考，它仅提供有关主题的事实，例如警告或重要提示。
DITA 是技术作者的强大工具，因为您可以通过创建一个名为 DITAMap 的单独 XML 文件来组装文档，该文件编译了关于主题的多个 DITA 文件。这允许技术作者重用内容，而无需在单独的文档之间复制和粘贴。DITA Open Toolkit 和其他 DITA 工具提供转换，可以将 DITA 源转换为不同的输出类型，包括 PDF 文档、HTML 网站和 EPUB 书籍。
LibreOffice
如果您更喜欢使用传统的文字处理器来编写文档，LibreOffice Writer 提供了一个出色的开源选项。作者可以利用 LibreOffice 中提供的不同样式来定义文档中的章节标题、节标题、段落和示例代码。LibreOffice 还支持字符样式，这有助于强调或突出显示源代码关键字和其他内联文本。
LibreOffice 中的页面样式在创建打印文档方面提供了很大的灵活性。例如，页面样式包括左右页，通常在较长的文档中使用，以确保新章节或主要部分始终从印刷书籍的右侧页面开始。页眉和页脚可以在左右页上独立定义，从而在技术写作中提供更大的灵活性。
LibreOffice 是一款更传统的桌面文字处理器，具有易于学习的界面。大多数功能直接在工具栏上可用，其他功能在菜单中。或者使用弹出的“样式”窗格快速选择您要使用的段落、字符或页面样式。
本文由以下人员共同撰写：Teagan Nguyen、Joshua Hebeisen、Aurora Dolce、David Kjeldahl 和 Rose Lam。
1 条评论