简单解释技能(SES)
先给出答案,用简洁的语言。再分层增加深度,读者可跳过。永远不为简洁牺牲真实性。
结构:答案 -> 机制 -> 细节
按读者需要的顺序组织解释,而非按你学习它的顺序:
- 答案。 用一两句简洁的话直接回答问题或陈述要点。在此停住的读者获得的是正确的画面——一个更小的画面,永远不会是错误的画面。
- 如何与为何。 答案背后的机制:原因、结构、运作规则。
- 细节。 数字、参数、边缘情况、例外、证明。大多数读者会跳过的部分——但当有人回看时,这部分必须仍在。
通过以下规则保持结构:
- 完成一层后再开始下一层。切勿将摘要与细节混在一起。
- 使层次可见且可跳过:段落分隔、加粗引导、标签、标题,或当媒介支持时使用展开器。
- 改变答案的警告必须放在答案旁边。安全风险、数据丢失、破坏性变更和实际成本绝不放在低层。
- 步骤按依赖顺序排列。围绕过程分层组织文字——先结果和前置条件,再编号步骤,最后是失败情况——但绝不能按重要性重排步骤。
- 深度取决于问题。聊天回复可能只需要一层;设计文档可能需要四层。切勿为了填充结构而填充解释。
词汇
- 以执行者和动词开头:“缓存返回过期数据”,而不是“过期数据可能被返回”。
- 对同一个事物使用同一个名称,且每次都用同一个名称。切换名称会让读者以为是不同的事物。
- 优先使用简短常见的词:使用、开始、帮助、展示——而非利用、开始、促进、展示。
- 每个句子只表达一个观点。以20个词为上限;拆分句子而非堆叠从句。
- 条件放在动作之前:“如果构建失败,请检查锁定文件”——而不是反过来。
- 在读者遇到术语的半个句子中定义它。不要前置背景信息。
- 将抽象名词转回动词:“分析日志”,而不是“执行日志分析”。
- 删除填充词、强化词和空洞的赞誉:非常、健壮、无缝、强大、全面、“值得注意的是”。
- 使用数字而非形容词:“从40秒降至6秒”胜过“显著加快”。
底线:简单,但绝不失实
- 保留所有事实、数字、警告和注意事项。简化会将细节移到底层;它永远不会删除细节。
- 不要编造来源没有的示例、证据或信心。当某件事未知时,直接说明。
- 将类比视为桥梁,而非证据。如果读者会依赖它,请指出其局限之处。
- 当简洁与准确性冲突时,准确性优先——然后继续努力让准确的版本变得简洁。
示例
之前——真实、完整、难以使用:
事务是一个语句序列,被视为一个不可分割的工作单元——在第一个语句时隐式启动,由COMMIT或ROLLBACK终止——这一构造之所以重要,是因为许多多步骤操作只有以原子方式执行才是正确的。
之后——同样的事实,分层呈现:
事务是一组要么全部成功、要么全部失败的语句。
它从第一个语句开始,以
COMMIT(保存更改)或ROLLBACK(撤销更改)结束。分组之所以重要,是因为某些操作只有作为一个整体才是正确的:一个从一个账户扣款而未向另一个账户入账的转账会导致资金丢失。
交付前检查
- 第一句话是否回答了问题?
- 读者在任何一层停下来后,理解是否正确?
- 警告和改变答案的说明是否位于顶层?
- 是否有更短、更常见的词可以在不改变意思的情况下使用?
- 所有事实、数字和注意事项是否都保留下来了?