AI-assisted Technical Communication

# 技术写作

# 什么是技术写作

技术写作 (Technical Writing) 遵循一定的规范产出高质量技术文档，用简单的表达让用户了解使用复杂的技术产品。技术写作是技术传播最典型的表现形式，而技术作家 (Technical Writer) 是技术传播领域典型且普遍的岗位。

# 技术文档的类型

根据文档的写作目的，技术文档一般存在以下四种topic：

doc overview

在实际写作过程中，为了达到特定目的，我们需要交付的技术文档可能融合以上的一种或多种类型。例如当我们需要产出一篇技术文档，指导交付人员基于某个项目完成整体软件的配置任务时，可能需要组合概述说明、操作指南、技术参考这三种topic在一篇文档中。

# 技术文档的风格指南

技术写作风格指南 (Style Guide) 帮助 TCer 产出符合规范的高质量技术文档，保证技术文档整体的风格一致、易读易用易查找。

技术写作风格指南通常包含以下内容：

  • 文档结构：指导如何组织文档的结构，包括标题、段落、章节的使用等。

  • 语言和术语：规定使用什么样的语言和术语，以确保读者易于理解。此外，可能还有关于缩写、首字母缩写词等的规范。

  • 格式和排版：提供关于字体、字号、标题风格、代码示例展示等格式和排版的指导。

  • 文档风格：确定文档的整体风格和语气，如正式、友好、客观等。

  • 文档设计：指导如何使用图表、示意图、表格等辅助工具来更好地呈现技术概念和信息。

  • 语法和标点：提供对正确的语法和标点使用的规范。

  • 写作规范：包括关于书写风格、用词精简、避免歧义和模糊性等方面的准则。

实际工作中常见且开源的技术写作风格指南有：

# 新手如何入行技术写作

这个问题很好解答：

  • 第一步 学习理论
  • 第二步 练习写作
  • 第三步 参与实践

当然这个回答就像是解答如何把大象装进冰箱一样，实际操作还是需要个人对于这个行业的热情与坚持。

所以在第一步之前，还需要自我考量自己到底适不适合做这类型的工作。也可以在网上自行搜索，看看别人的入行经验，比如这一篇 技术传播 | 入行Technical Writer的踩坑秘籍 (opens new window)。

# 文科生的自我修养

技术写作岗位相比于其他IT岗位来说压力稍稍轻松一些，是一个需要不断学习吸收新事物的工作。对于文科生来说，要扪心自问自己是否喜欢新技术。同时，还要具备多种综合性技能，包括但不仅限于计算机知识、翻译、审校、营销、项目管理等等。读书期间完全可以通过自学，把自己武装成合格的技术写作人才。

以下是一些可以考虑自我培养的技能和书单： required skills

# 零基础如何参与实践

对于没有技术背景的大学文科生来说，参与实践技术写作是一个很好的方式来提升自己的技能。以下是一些建议来帮助你零基础参与技术写作实践：

  • 参与开源项目：

    既然你已经看到了这篇文章，最直接方便就是参与我们的开源项目 AI-assisted Technical Communication (opens new window) 一起进行技术写作实践。我们需要更多的小伙伴一起探索使用AI来写技术文档并总结经验。最佳实践案例也会展示在我们的官网上。

  • 阅读在线技术文档

    选择阅读大公司如谷歌、微软等的在线技术文档。它们通常很全面易懂。通过阅读这些文档，你可以了解技术写作的风格、结构和术语。同时，你也可以学习一些新的技术知识。

  • 自己进行写作训练

    选择一个你感兴趣或具备一些基础知识的主题，尝试写一篇简单的技术文档。可以写关于某个软件的使用指南、某个工具的安装步骤，或解释某个概念的文章。通过实际动手写作，你可以提升自己的表达能力和组织结构能力，并逐渐熟悉技术写作的流程和规范。

  • 参与技术写作活动

    参加Google举办的文档季活动 Google Season of Docs (opens new window)，为开源项目提供支持，也为你提供在开源项目中获得经验的机会。这些活动还会给与你一定的报酬，同时还有机会与全球的开源社区合作。

# 相关参考

如果想要了解技术传播行业更多的信息，可以点击查阅以下信息：

← Docs Like Code →