Shiwei Shang

Thinking will not overcome fear but action will.

DQTI读书笔记8-撰写易查的文档

撰写易查的文档 想要让文档易查，要做到以下几点： 把信息分成概念（concept）、任务（task）和参考（reference）三类。 这三类信息对应着三种话题（topic），即概念话题（concept topic）、任务话题（task topic）和参考话题（reference topic）。每个话题只介绍一个主题，比如有个“把大象装冰箱“的任务话题，这个话题...

Posted by Shiwei Shang on June 27, 2025

DQTI读书笔记7-撰写易懂的文档

撰写易懂的文档 想要让文档易懂，要做到以下几点： 表达清楚。避免使用： 词组，能用单词尽量用单词，尽量简练 模糊的表达，比如kinds of 加强语气的词，比如significantly 长句 没必要的修饰词 空洞的段落 避免歧义。要做到： 避免用多义词 ...

Posted by Shiwei Shang on June 27, 2025

DQTI读书笔记6-撰写准确的文档

撰写准确的文档 想要让文档准确，要做到以下几点： 先理解你要写的东西，然后再动笔，最后再验证你写的东西。不能不懂装懂，泛泛地写，甚至提供错误信息。 跟上技术的变化。每个版本的产品都会在某些方面升级改造，文档定稿前要仔细检查各种版本、商标、产品名是不是与实际相符合。 保持信息的一致。同一件事，不可以在这里是这么说的，在那里就变成了那么说的。可以通过重用的方式让信息保持一致，或...

Posted by Shiwei Shang on June 27, 2025

DQTI读书笔记5-撰写以任务为导向的文档

撰写以任务为导向的文档 以任务为导向的文档就是教用户怎么做的文档。作者要站在用户的角度理解各项任务。对于复杂的任务，应该把它分成多个子任务，避免让话题太长。 面向目标读者 写文档也要“看人下菜碟”。对管理者，文档可能只写整体的任务即可，对于基层操作员，文档要写得足够详细。 以用户视角呈现信息 需要用户操作的地方要用第二人称和主动语态来写，以此来表明操作的执行者是用户自己。 交代任务的背景...

Posted by Shiwei Shang on June 26, 2025

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

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

A technical writer, translator, and teacher.

✉️ shiwei.shang@qq.com