《技术写作手册》学习笔记

图片来源：iFixit

如果你阅读过产品介绍手册、使用指南或维修说明书的话，相信你跟我一样对这些内容都没什么好感，读完几遍后总是一头雾水。怀疑自己智商不够？千万别，实在是这些内容的用户体验不好而已。

换做是你，怎么写？这就关乎「技术写作」话题了。维修教学公司 iFixit 就专门为此出品了一份《Tech Writing Handbook（技术写作手册）》，感兴趣的话不妨前往学习学习。我也做了一些笔记如下，或可参考。

• 首先明白技术写作的内容是用来帮助用户解决问题的
• 作为写作者，你必须使用产品，理解使用流程，当你明白这是怎么一回事儿了，才能把内容写好
• 向产品专家、程序员、工程师学习，无疑是了解产品和流程最快的方式
• 把最重要的信息放在前头，以免有些读者没有耐心看下去
• 去掉无关痛痒的信息，比如产品历史介绍，用户未必感兴趣
• 用户更爱短句，而不是长句
• 凝练字词，比如「因为这个原因」可以写为「因此」
• 可以使用被动语态，但主动语态更简洁有力
• 使用简明语言（Plain Language）
• 避免使用专业术语
• 写完后拿给普通用户读一读，看看他们能否看明白
• 加点幽默元素（当然啦，别强求）
• 明确语气风格。严肃？权威？友好？诙谐？不卑不亢？
• 统一好用「您」还是「你」
• 一段话一个观点
• 为国际化做好准备（真要国际化的话，少用俚语，因为不好翻译）
• 应该保证小学六年级水平的用户就能看懂（当然，要视国民教育水平来看）
• 能用图说明就不要写文字
• 流程图、视频、图标、符号等等，也能帮助用户更好理解
• 做好目录
• 可以以任务为节点，比如「如何拆卸屏幕」
• 结合清单
• 善于重复使用内容，比如「详见第 9 条」
• 添加法律法规要求添加的内容，比如「请避免 6 岁以下儿童接触使用」
• PDF 并不是唯一选择，你也可以用 Wiki
• 做成网页内容，还便于搜索引擎查找
• 做好 API 更利于多渠道及时更新
• 做好团队内知识管理工作
• 加入反馈渠道，让用户顺畅无阻找到你
• 不断迭代