知行札记

把知识组织成可理解的路径

从读者已有知识和阅读目标出发,建立概念联系,安排解释顺序,并确定专题内部的拆页与承接。

作者知道一个结论怎样成立,读者需要在阅读中取得同样关键的联系。知识组织的任务是找出这些联系,并安排它们首次出现的位置。例如,一篇文章要解释为什么某次测试无法证明产品整体更好,就需要先交代测试对象、输入范围、指标和比较目标,再说明结果能支持哪些判断。只有一个结论和几份引用,仍会把中间推理留给读者自行补齐。

这一章讨论怎样从已经研究清楚的内容形成阅读路径。具体取证方法见研究与证据,文字和载体选择见写作与风格。

把阅读结果落实到知识起点

先确定读者阅读后需要理解什么、判断什么或完成什么动作,再找出他们已经具备的相关知识。“开发者”“初学者”“资深作者”可以帮助识别场景,同一个角色对不同主题的熟悉程度仍可能差别很大。Google 的 Audience 指南也将角色、对主题的熟悉程度及目标知识分别讨论。1

假设要解释一个资料库为什么需要标明来源的版本。熟悉研究的人可能只需要知道新旧版本有哪些差异;首次接触资料核查的人,则需要先理解三个对象:作者要判断的主张、实际读取的材料、材料成立的时间与范围。两者都需要版本信息,首次建立关系所需的解释量不同。

知识起点可以用一句具体假设表达:“读者会查找和引用网页,但尚未比较同一规则在不同版本中的变化。”这句话直接影响正文:可以沿用普通链接的知识,需要讲清版本如何改变主张。遇到不能确认的读者基础,应把实际使用的假设交代清楚,避免在写到一半时偷偷提高前提。

阅读结果同样需要具体。对于这篇版本解释,完成条件可以是“能指出当前主张依赖哪个版本,以及换版本后需要重新核对哪里”。纯理解文章无需为了证明有用而附加操作任务;解释可以独立服务理解。2

先形成作者的关系模型

安排正文之前,先确定实际有哪些对象和联系。关于来源版本的最小模型可以写成:

要回答的问题 → 关键主张 → 支持主张的材料及版本
                                    ↓
                         材料适用的对象、条件与范围
                                    ↓
                         本文可以作出的判断及局限

这里的箭头表示判断依赖,不表示材料出版或作者工作发生的时间顺序。这个模型使作者能够检查:结论是否缺依据,依据是否适用,局限是否改变结论。它可以只是临时草图,也可以在确有解释用途时进入正文。

面对真实系统,还需要分清职责、调用、数据、时序和包含关系。两项知识相互关联,并不说明谁先执行;两个源码目录并列,也不说明它们是两个运行服务。作者先核对关系的真实含义,再决定读者怎样取得它们。系统对象和多视图的具体处理见架构文档。

研究过程可能先找到结论,再追溯来源,最后发现条件。最终文章可以先介绍需要判断的问题,逐步建立这些关系。研究取得材料的顺序、系统的执行顺序和读者的理解顺序,各自有用途,不能直接互换。

从目标向前找出必要依赖

把目标结论放在末端,逐步追问它依赖什么。每个依赖判断有三种处理:声明为读者已有基础;在首次使用处解释;在本专题的前置章节中完整建立,并在使用处给足定位和短承接。

以“旧版测试结果不能自动证明当前版本效果”为例,关键联系包括:测试运行的是某个具体版本;改动可能改变输入、路径或依赖;结果只覆盖当时的条件。读者理解这条关系不必掌握全部测试框架内部实现。继续补充只有在它会改变本次判断时才有作用。

如果两个概念互相定义,先给能识别对象的局部模型。例如“证据是支持判断的材料”“判断是依据材料形成的回答”,随后用一项具体主张和其支持材料展示对应,再说明两者的适用范围。不要把每个新定义都交给另一个尚未建立的术语。

概念依赖的检查重点是影响主路径的缺口。写一篇资料版本解释,无需补齐信息学的全部基础;讲清异步确认则可能必须补上请求接受、任务完成和持久化的不同状态。技术讲解进一步说明如何沿目标行为追溯这些技术关系。

选择进入方式,集中回答同一问题

已有直接答案的比较内容,可以先给带条件的判断,再展开依据;陌生机制可以从可观察现象、具体问题或最小模型进入;查阅材料可以先呈现可定位的规则。入口应让读者知道当前要理解哪件事,随后给出足够支撑。

提纲围绕读者问题组织。例如讨论来源版本,可以依次回答“版本为什么影响判断”“怎样定位当前材料”“哪些变化需要重查”。“背景—现状—问题—建议”只有在这些栏目确实帮助解释时才有作用。Google 的长文组织指南也将提纲、导航与渐进展开作为可选择的方法,未提供通用最佳提纲。3

同一关注点应集中保留答案、成立条件和主要依据。若前面断言“这个结果可以复用”,后面才说明“仅限相同输入与未变更路径”,读者需要跨位置重建结论。把条件接到判断处,再在后续部分展开验证细节,可以兼顾直接回答和依据深度。

每段的承接都应有信息作用:上一段建立的对象如何参与新关系,新增条件为什么改变判断,接下来的例子要显露哪个联系。无需用空泛的“接下来深入探讨”填充过渡。

用层次容纳不同阅读深度

先提供足以完成主要理解的路径,再放不影响该路径的内部细节、变体或具体引用。一个完整的短解释可以连接定义、关键条件和结果;进一步的技术分析则展开决定这些结果的内部规则。缩短正文时优先删去无用途的复述,关键条件继续保留。

对于基础不同的读者,可以在同一章内安排局部展开,标明理解更深部分所需的知识。已经熟悉对象的人可以跳到条件变化;首次接触的人沿主要路径建立概念。这种组织仍需判断实际收益,多条完整解释路线容易增加维护和阅读选择的负担。

分层的有效性需要具体检查:短路径是否足够完成承诺,深入部分是否有独立作用,跳读位置是否明确。篇幅长短或“适合初学者”的标签无法单独证明这些条件。

按知识职责拆页,并保留解释闭合

当一页包含多个独立问题,而且解释其中一个问题经常打断另一个,就可以拆页。一个专题允许不同页面分别承担研究、知识组织、表达选择和专项方法;它们通过共享的阅读目标与必要承接组成完整成果。正文长度只提供线索,拆页依据仍是阅读问题。

为每个可复用解释确定一个主要位置。例如本专题由本页讲知识起点与理解路径;技术章在具体机制上应用它,不再完整重复一套受众分析。应用处可以用一句话唤回所需知识,然后直接讲当前对象。

专题之外的来源供追溯和评估。若要理解本文主结论必须另读一份独立调研,当前专题仍存在缺口。反过来,调研在评价方法时只需保留足够辨认该方法及其取舍的短说明,成熟教学正文可以集中归入专题。这种分工需要同时保护必要来源、证据和条件。

完成组织后,沿读者起点阅读一次:每个重要对象是否已经出现,每条关键关系能否接回前文,每个结论的条件是否及时取得,每个分支是否有当前用途。这个检查能发现文本中的缺口;实际读者是否理解,仍要通过相应任务取得证据。质量与修订进一步说明如何报告这种边界。

Footnotes

  1. Google Technical Writing,Audience,Define your audience、Determine what your audience needs to learn。借鉴具体知识差距分析,不把指南中的角色示例作为所有读者的既定基础。 ↩

  2. Diátaxis,Explanation,Explanation and understanding。用于说明理解本身可以成为文档目标;本站的专题与调研分类仍按自身用途组织。 ↩

  3. Google Technical Writing,Organizing large documents,Organize a document、Add navigation、Disclose information progressively。这里只借鉴组织方法,没有声称本专题已取得真实读者效果证据。 ↩

最后更新于

本页目录