选择与主题相符的示例,判断标准只有一条:这个例子能否让读者在不了解你项目背景的情况下,直接看出它和指定关键词之间的对应关系。能看出,就保留;需要额外解释才能建立联系,就换掉。
示例不是装饰,它承担一项具体任务:证明这个页面确实在围绕指定关键词提供有用信息。因此选择示例前,先明确页面交付什么结果。是让读者学会一个操作、理解一个概念,还是完成一次对比判断。结果不同,示例的形态也不同。
如果示例无法对应上述任一结果,它大概率只是填充内容。
第一步,写下指定关键词在页面中实际指向的对象。它可能是一个动作、一类事物或一种状态。第二步,用一句话说明示例与这个对象的关系,例如“该示例展示的是对象在受限条件下的表现”。第三步,把这句话删掉,只看示例本身,检查读者是否仍能建立同样联系。
第三步是关键的检查项。删掉解释后联系断裂,说明示例依赖你的补充说明才成立,应替换为更直接的材料。假设某页面围绕“指定关键词优化”讲内容取舍,示例却是一段与主题无关的排版调整记录,读者无法从中看出取舍依据,这就是不相符。
把示例当作一项小型交付物来管理,可以避免主观争论。
四者缺一,示例就容易变成孤立的片段。资料不足时,宁可缩短示例,也不要补入未经核对的细节。
第一种,示例范围明显大于主题。围绕一个具体判断写的页面,却使用覆盖多个环节的综合案例,读者抓不住重点。替换方向是截取其中一个环节。
第二种,示例只展示结果,不展示条件。读者看到结论却不知道适用边界。替换方向是补上条件说明,并标明哪些是假设。
第三种,多个示例之间没有递进关系,只是同义重复。替换方向是保留一个,其余改为不同条件下的对照。
第四种,示例中的术语与页面其余部分不一致,读者需要来回换算。替换方向是统一表述,或在首次出现时给出对应关系。
打开已有页面,逐个标出所有示例,对每个示例执行删除解释测试,并记录它对应的交付结果。无法通过测试或找不到对应结果的示例,列入替换清单。替换时优先使用页面内已有资料能够支撑的例子,避免引入新的待核实信息。完成后,再通读一遍,确认示例之间的顺序能自然推进读者理解,而不是并列堆叠。