Shiwei Shang

Thinking will not overcome fear but action will.

谷歌技术文档写作课程笔记 8 受众分析

受众分析 受众分析是开始写作前的必要步骤。正好的文档=完成某项任务所需的所有知识-受众已有的知识。作者要分析受众的知识储备，这样才能写出适合受众的文档。 我们首先要确定受众群体是那些人群，以及他们需要什么知识才能完成特定的任务。确定好这些之后，我们要选择适合他们的词汇进行写作；不要想当然地认为某个东西作者自己知道就默认受众群体也知道，要站在他们的角度上；要使用简单的词语，不要使用黑话和行...

Posted by Shiwei Shang on June 23, 2025

谷歌技术文档写作课程笔记 7 段落

段落 章节是由段落组成的。段落的组织也是有一定规则的。 写好每个段落的开头 每段的第一句至关重要。有的读者倾向于只看每段的第一句来获得整个章节的主旨。所以，每段的第一句一定要表达这一段的主旨。 每个段落只谈论一个话题 和句子的规则一样，每个段落只能谈论一个话题。不可以东拉西扯，导致中心不明确。 段落不能太长或太短 太长的段落会让读者失去阅读的动力；太短的段落会让文档意思不够连贯。...

Posted by Shiwei Shang on June 23, 2025

谷歌技术文档写作课程笔记 6 列表和表格

列表和表格 列表和表格在技术文档中很常见，因为它们让文字看起来清爽，更有条理。 列表 常见的列表有三种： 无序列表 有序列表 嵌入列表 无序列表 无序列表用于非步骤的内容的列举，顺序对于列表条目的排列并不重要。但是，无序列表的条目要保持平行，要使用同样的结构、逻辑、标点、和大小写。 比如，动物园里有很多动物： 狮子。（❌）狮子（✔） 錦雞（❌）锦鸡（✔）...

Posted by Shiwei Shang on June 22, 2025

谷歌技术文档写作课程笔记 5 简洁的魅力

简洁的魅力 表达简洁的优势在于： 容易理解。 容易维护。 技术文档写作实践中通常遵循以下原则。 把长句子切分成若干个短句 和任务类话题一样，一个句子只用来表达一个中心思想。把长句子按照中心思想进行切分，可以让表达的内容更容易理解。 把长句子转换成列表 有的长句子里包含并列的内容。我们可以把这些并列的内容挑出来，逐一列出，从而让层次更清晰，阅读起来也更快。 删除不必...

Posted by Shiwei Shang on June 22, 2025

谷歌技术文档写作课程笔记 4 让句子简洁有力

让句子简洁有力 简洁有力的句子主要靠两点： 使用具体的词而不是宽泛的词。 使用简洁的结构而不是复杂的结构。 选择有力的动词 许多技术文档作者都把动词看作句子的灵魂。选对了动词，就等于成功了一半。但是，现实中我们往往会使用很多弱化句子的词汇，比如： be动词 occur happen 比较： This error message happens wh...

Posted by Shiwei Shang on June 21, 2025

谷歌技术文档写作课程笔记 3 主动语态和被动语态

技术文档写作中的主动语态和被动语态 技术文档写作主要使用主动语态，很少使用被动语态，因为主动语态有以下优点： 不需要读者在头脑中把被动语态转换成主动语态，节省思考时间。 主动语态的表达比被动语态更直接。 有些被动语态省略了主语，让读者自己去花心思结合上下文判断。 使用主动语态的句子比被动的短。 但是被动语态也不是绝对不可以用的。在以下情况，你可以使用被动语态： ...

Posted by Shiwei Shang on June 21, 2025

谷歌技术文档写作课程笔记 2 用词

技术文档写作中的用词 对于技术文档中用词的问题，主要有以下几个方面值得我们特别注意。 陌生的术语要解释 提到新词或者术语的时候，一般有两种处理方式： 给这个词加一个链接，跳转到已有的解释。 在这个词后边紧跟解释，如果文档术语特别多，直接建一个话题，用来解释整个文档中出现的所有新词或术语。 术语的使用要统一 和日常写作不同，技术文档的术语要前后统一，不可以前面用一个词，后面用另...

Posted by Shiwei Shang on June 20, 2025

谷歌技术文档写作课程笔记 1 简介

什么是技术文档写作 技术文档写作有很多种定义。在我看来，它是一种准确、清晰、简洁的写作方式。其目的是用简单明了的语言，帮助他人学会使用某些工具或理解某些技术原理。 一套完整的技术文档由若干个“话题”构成。“话题”主要分为任务、概念、和参考三类，每个话题只聚焦一件事。这样做的目的是让整个文档的结构清晰，便于理解和查阅。 技术写作的语言风格具有以下特点： 使用简单词汇和短句。 采...

Posted by Shiwei Shang on June 19, 2025

欢迎光临

我的第一篇博客~

欢迎光临 这是我的第一篇博客。 我打算在这个网站上记录生活、工作、学习等等，敬请期待。

Posted by Shiwei Shang on June 18, 2025

FEATURED TAGS
谷歌技术文档写作课程 DQTI 主题式写作 英语语法
ABOUT ME

A technical writer, translator, and teacher.

✉️ shiwei.shang@qq.com