选择与主题相符的示例,判断标准不是“里面有没有出现目标词”,而是这个例子能否独立证明正文观点:把目标词删掉后,例子仍然成立,并且它描述的对象、场景、读者身份与文章主题一致。多人协作时,把这条标准写成示例验收项,能显著减少返工。
动手找例子前,先回答三个问题:这个例子要证明哪一句话?读者是谁?它属于概念解释、操作步骤还是结果对比?用途不同,示例的形态也不同。概念解释适合用日常场景,操作步骤适合用可复现的输入与输出,结果对比适合用同一条件下的前后差异。
在协作文档里,可以为每个示例加一行说明,格式建议为:
这一步的关键是让写作者和审核者对“这个例子为什么放在这里”有共同答案,而不是各自凭感觉判断。
第一步,检查主题一致性。示例涉及的产品类型、使用场景、读者水平,应与文章主线保持同一层级。讲入门操作时突然插入企业级架构案例,读者会觉得跳跃;讲批量处理时只给单个手工操作,又显得不够。
第二步,做“删除测试”。把示例中的目标词或同义替换全部去掉,如果例子仍然能说明问题,说明它的价值来自内容本身,而不是靠重复堆出来的。反之,如果去掉目标词后例子就散了,通常意味着这个例子只是在凑词,应该重写。
第三步,检查可验证性。示例中的输入、条件、输出要能被读者复现或核对。假设要说明“标题过长会影响阅读”,可以写:假设一条标题为 30 个汉字,在手机屏幕上需要折行三次,读者扫读时容易跳过后半句。这里标明“假设”,不冒充真实数据,但逻辑可检查。
对多人协作来说,最关键的一步是第二步的删除测试。它把“感觉相关”变成“可以复核”,审核者不需要争论词出现了几次,只需要看例子是否独立成立。
交付前可以逐项核对:
如果第 3 项不通过,优先改写示例内容,而不是往例子里补词。如果第 4、5 项不通过,补上条件与结果即可,不必重写整段。
示例不是一次写完就固定不变。主题调整、读者变化或案例过期时,需要重新走一遍删除测试。可以在团队模板中保留示例卡片,记录来源、适用条件和最后核对时间,避免不同人反复修改同一处。
维护时还要区分“可能原因”和“已定位原因”。例如某段示例读起来突兀,可能原因包括它与段落观点错位、读者层级不匹配、缺少条件说明;不要直接断定是词频问题。先按清单定位,再决定改示例还是改正文。
下一步,挑出你当前文档里最长的一个示例,删掉其中所有目标词,读一遍。如果它仍然能说服读者,就保留并补上适用条件;如果不能,就按上面的三步重新筛选一个与主题同层的例子。