Shiwei Shang

Thinking will not overcome fear but action will.

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

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

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

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

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

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

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

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

欢迎光临

我的第一篇博客~

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