选择与主题相符的示例,判断标准不是“看起来相关”,而是这个示例能否直接支撑当前页面要证明的观点。对内容管理系统而言,最稳妥的做法是先从交付结果倒推:这篇内容最终要让读者理解什么、完成什么,再判断示例需要包含哪些字段、流程或对比项。示例与主题相符,意味着读者看完示例后,能复现你描述的判断过程,而不是只记住一个孤立案例。
很多示例跑偏,是因为写作者先找素材,再决定用它说明什么。更可靠的做法是先写一句结论,例如“栏目结构混乱会导致同一篇内容被重复发布”。然后检查候选示例:它是否包含栏目、内容类型、发布状态这三个要素?如果缺少其中任何一个,读者就无法从示例中看出重复发布是怎么发生的。
这一步的检查项可以固定为三条:
假设你要交付的是一份“内容管理系统栏目规划说明”,验收标准是运营人员能按说明建出栏目并知道每类内容放在哪里。那么示例至少需要呈现:内容类型、对应栏目、发布角色、更新频率。缺了发布角色,读者不知道谁负责;缺了更新频率,读者不知道栏目是常设还是临时。
反过来,如果交付结果是一篇面向新手的操作说明,示例就不需要展示数据库字段或权限矩阵,而应展示操作前后的状态变化。示例的详细程度由交付结果决定,不由素材多少决定。资料收集阶段可以多准备,但写入正文的只保留支撑结论的部分。
单一示例只能说明“可以这样做”,对比示例才能说明“为什么这样选”。例如说明内容管理系统中“标签”和“栏目”的区别时,可以给出同一篇内容的两种归置方式:放入栏目表示它属于某个固定板块,打上标签表示它涉及某个话题。读者通过对比就能判断自己的站点该用哪一种。
对比示例的适用条件是:两个选项容易混淆,且选择错误会带来实际后果。如果两个概念本来就不会被混用,强行对比只会增加篇幅。判断结果是否合格,可以看读者能否用一句话说出两者的选择条件。
示例本身不会自动被执行,所以与示例配套的说明里要写清谁负责核对、核对什么。以栏目规划为例,责任可以拆成:内容编辑负责提交内容类型,栏目负责人负责确认归属,技术或运维负责确认栏目层级能否实现。验收时逐项检查示例中的每个要素是否都有对应责任人。
如果示例涉及具体工具或平台,不要断言某个功能当前一定存在。可以写成核查方法:在所用系统的栏目设置中确认是否支持多级分类,在内容编辑页确认是否支持同时选择栏目和标签。这样写既给出了可执行的检查动作,也避免把未经核实的界面描述成通用事实。
第一种偏差是示例过于完整,把无关字段一并列出,读者找不到重点。修正方法是只保留支撑结论的字段,其余放进补充说明。第二种偏差是示例只有结果没有过程,读者不知道从哪个状态开始。修正方法是补上初始状态和触发条件。第三种偏差是示例来自完全不同的业务场景,读者无法迁移。修正方法是替换为同类型站点的场景,或明确写出迁移时需要调整的条件。
完成示例筛选后,下一步是把它放回页面结构中检查:示例前面的段落是否已经给出结论,示例后面的段落是否说明了适用条件和判断结果。如果示例前后缺少这两部分,即使示例本身与主题相关,读者也难以把它转化为可执行的判断。