先给结论:改版后需要更新的不是“所有提到旧版本文档的文章”,而是那些引用内容已经失效、或者读者会据此做出错误操作的文章。判断依据不是文章发布时间,而是引用与新版文档之间是否存在事实冲突。若冲突只影响表述风格,可以不动;若冲突影响步骤、参数或结论,就必须改。
旧文章里的引用大致分两类。第一类是事实引用,比如操作步骤、字段名称、参数默认值、接口返回结构、限制条件。这类内容一旦被产品文档改版改变,旧文章就会出错,属于必须更新的范围。第二类是观点引用,比如作者基于旧版本给出的使用建议、适用场景判断、与其他方案的比较。改版未必推翻这些观点,但可能让前提不再成立,需要逐条核对。
区分方法很直接:把旧文章里的引用逐条摘出来,对照新版文档问一句——如果读者照旧文章操作,会不会失败或得到不同结果?会,就改;不会,但表述容易引起误解,就补一句版本说明;完全不受影响,就保留。
此时应直接更新,而不是在文末加一句“以最新文档为准”。后者把核对成本转嫁给读者,而读者往往不会去核对。具体动作是:定位旧文章中的引用段落,替换为新版文档的对应表述,并在必要处保留一句变更说明,例如“旧版本中该字段为必填,新版改为可选”。这样处理的结果是,旧文章继续承担独立解决问题的功能,不必依赖外部跳转。
代价是工作量集中在事实核对上,一篇文章可能只有两三处需要改,但每处都要回到新版文档确认,不能凭印象替换。
此时优先保留原文,只在前提发生变化的位置补注。比如旧文章建议“先配置A再配置B”,新版文档把顺序调换但两种顺序都可行,那么旧文章不需要重写,只需在步骤前说明两种顺序的适用条件。若新版文档删除了某个功能,而旧文章仍在推荐使用,那就从观点引用变成了事实冲突,回到情况一处理。
这里的取舍标准是:改版是否改变了读者做决定所依赖的信息。改变了,就更新;没改变,只是措辞不同,就不必为了统一口径而重写,否则会消耗大量编辑时间,却对读者没有实际帮助。
假设某产品文档改版后,把配置项的默认值从“开启”改为“关闭”。旧文章里有一句“该选项默认开启,无需额外设置”。这句话属于事实引用,且与新版冲突,必须改。另一句“建议在测试环境先验证再上线”属于观点引用,新版没有改变这个建议的适用性,可以保留。
再假设旧文章引用了文档中的一张流程图,新版把流程拆成了两个阶段。如果旧文章的读者按旧图操作仍能走通,只是多了一步确认,那么可以补一句说明;如果旧图对应的入口在新版中已经不存在,就必须替换或删除该引用。
可执行的动作是建立一张核对表,按引用类型分列:事实引用、观点引用、混合引用。对每条引用标注“需更新”“需补注”“可保留”,并记录判断依据。完成一轮后,优先处理“需更新”的条目,因为它们直接影响读者操作结果。处理完后再回看“需补注”的条目,判断是否值得为少量读者增加说明。
例外情况有两种。一是旧文章已经明确标注了适用版本,且读者能自行判断是否适用,此时可以不改,但要在文章开头保留版本标识。二是旧文章本身已经不再被任何入口引用,且没有外部链接指向它,那么更新优先级可以降低,但仍建议在页面顶部加一句状态说明,避免通过搜索进入的读者被误导。
最后要提醒的是,引用更新不是一次性任务。产品文档每次改版后,都应回到核对表,只检查与本次变更相关的引用,而不是全文重读。这样既控制成本,也能保证旧文章与新版文档之间的摘要与关键词相关性不被事实冲突破坏。