Shiwei Shang

Thinking will not overcome fear but action will.

DQTI读书笔记4-话题的分类

话题的分类 话题（topic）分为三类： 任务话题（task topic）：介绍某一任务的简要目的和背景；列出完成某一任务的所有详细步骤。 概念话题（concept topic）：介绍什么是什么和背景信息。 参考话题（reference topic）：提供任务话题的补充材料，如术语表、各种定义等。 为什么要做话题分类 方便内容的重复利用。假如某个产品有用户手册（us...

Posted by Shiwei Shang on June 26, 2025

DQTI读书笔记3-技术写作流程

技术写作流程 技术写作流程如下： 准备阶段：理解用户、分析任务、学习产品。 理解用户：了解用户的知识水平和工作场景，以确定文档的难易度。 分析任务：了解用户工作中需要完成哪些任务，哪些任务最重要、最费时、最费事，以确定文档的顺序和重点。 学习产品：学习产品的功能，并理解这些功能和用户工作内容之间的关系。做产品的第一个用户，先自己学会，然...

Posted by Shiwei Shang on June 26, 2025

DQTI读书笔记2-什么是高质量的技术信息

什么是高质量的技术信息 高质量的技术信息有以下特点： 易用 以完成任务为导向，教会读者怎么做。 没有错误；内容与实际相符合。 囊括了所有必要信息，没有冗余信息。 易懂 不模棱两可。 有恰当的例子。 风格统一。 易查 结构清晰。 ...

Posted by Shiwei Shang on June 26, 2025

Developing Quality Technical Information（DQTI）读书笔记1-开篇

DQTI读书笔记-开篇 本文是Developing Quality Technical Information（DQTI）读书笔记的开篇。 这本书是IBM出版的，主要讲如何让技术文档易用、易懂、易查。 这本书的受众可以是： 技术文档写作员 编辑 视觉设计者 其他和技术文档有交集的人

Posted by Shiwei Shang on June 26, 2025

谷歌技术文档写作课程笔记 10 修改草稿

如何修改草稿 写好的文档，怎样把它修改得更好呢？这个过程不是一蹴而就的。需要多轮修改。以下是常见的做法： 参照风格手册 每个公司都有自己的风格手册，里面明确了语法、用词、标点、格式等规则。检查草稿是否遵循了这些规则，如果有违背，要按照规则进行修改。 再次站在读者的角度 再次站在读者的角度阅读草稿。看一看草稿的内容是不是和读者的角色和水平相符合，内容是不是解决了读者的疑问，是不是能帮...

Posted by Shiwei Shang on June 25, 2025

谷歌技术文档写作课程笔记 9 组织文档

组织文档 组织文档一般要考虑以下几个方面： 说明文档的范围，让读者知道文档是围绕什么来写的，能帮助读者解决哪些问题。 说明文档的受众，自己受众应该具备的知识，好让读者判断这个文档是否适合自己。 在文档的开头介绍所有的重点。人们阅读的时候，往往会仔细阅读最前面的内容，所以要在文档的开头交代所有重要的事情。 分析受众角色和承担的任务，根据受众的知识水平和任务流程组织文档。

Posted by Shiwei Shang on June 24, 2025

谷歌技术文档写作课程笔记 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

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

A technical writer, translator, and teacher.

✉️ shiwei.shang@qq.com