Technical Writing One Introduction

技术写作指导一

Posted by Axag on September 2, 2020

来自谷歌的技术写作课程,工作多年没有写技术文档的习惯,得把这个习惯养好,既然想要写好技术文档,那么谷歌这个指导就很有意义,自己一边学习一边尝试翻译。

技术写作介绍

Technical Writing One 指导你如何去书写一个清晰的技术文档。

目标受众

你至少得有熟练的英语写作能力,但是学习这个可能不需要你有非常强的写作能力.

如果你没有接受过任何写作训练,这个课程对你来说是十分合适的.如果你曾经接受过技术写作训练,这门课程帮你更高效的复习。

学习目标

这门课程会传授你技术写作的基本知识,当完成这么课程的学习后,你会明白以下的内容

  • 使用术语-包含缩写和首字母缩略词
  • 认识和消除恼人的代词歧义
  • 区分主动语态和被动语态
  • 将被动语态的句子转换为主动语态的句子
  • 明白主动语态比被动语态先进的三种方式
  • 学习至少三种方式让句子更加清晰和契合
  • 学习至少四种方式让句子更精简
  • 明白符号列表和数字列表的区别
  • 使目录更加有帮助
  • 为每个段落起一个好的开头句子
  • 为每个段落起一个好的标题
  • 在每篇文档的开头精准确定关键词
  • 明白你文档的目标受众
  • 明确明白你的受众目标已经了解的和他们想要通过文档了解的
  • 明白文档中所要传达的知识的难点和痛点
  • 识别和修改所使用的方言
  • 指出你文档的内容范围和合适受众
  • 将长主题切割成合适的章节
  • 正确使用逗号”,”,圆阔号”()”,冒号”:”,破折号”-“,和分号”;”
  • 掌握使用Markdown

成为一名优秀的工程师或者出色的技术作家需要花费多年的专注练习。这门课程可以提高你的技术写作水平,但不会立刻让你成为一名出色的技术作家

Pre-class 和 in-class

这门课程由以下两个部分组成

  • pre-class
  • in-class

你现在正在阅读的是pre-class部分的开头

In-class 部分将强化pre-class部分的知识点。即使这样,pre-class仍然提供了宝贵的学习内容。

硬件和网络要求

虽然这门课程在笔记本电脑或者台式电脑学习体验是最好的,但是你也可以在平板或者手机上进行学习,如果你在学习in-class的内容,你将要输入非常多的内容.

网络连接是不可缺少的,你不能下载课程内容到本地,该课程也没有可用的有形媒体内容(书本等)

该课程包含一些简短的视频,这些内容是可选的.如果你想要跳过这些视频,则可以通过低带宽的互联网连接来学习本课程。

可选单元

有些单元是可选的。这些内容不是必须的,但是可能你会觉得这些内容是有用的。