先给结论:产品文档改版后,旧文章里需要更新的不是所有提到该产品的句子,而是那些依赖旧版事实才能成立的引用。判断标准只有一条——读者按文章操作时,会不会因为引用的内容与新版文档不一致而做错。会,就必须改;不会,可以留。这条标准在样本少时容易执行,文章一多就会出现例外,下面分开说。
条件一:旧文章引用的是操作步骤、参数名称、界面路径、限制条件这类会随文档改版而失效的内容。这类引用必须逐一核对并更新,因为读者是照着做的。条件二:旧文章引用的是概念解释、设计意图、适用场景判断这类不随版本变的内容。这类引用通常只需确认表述没有和新版产生冲突,不必改写。
区分方法很直接:把旧文章里的引用句单独摘出来,问一句“这句话在新版文档里还能找到对应依据吗”。能找到对应依据,且含义一致,属于条件二;找不到,或含义已经偏移,属于条件一。这个判断不依赖文章长短,也不依赖发布先后。
规模化之后,逐篇打开改效率很低。更稳的动作是先建立一份引用清单:列出每篇旧文章中涉及该产品的句子、所在段落、引用类型(步骤/参数/概念)、以及它指向新版文档的哪一节。
这份清单本身就是决定下一步的依据:必改项集中在少数几篇时,直接改文;必改项分散在大量文章中时,先改被引用次数最多的那几篇,其余排队处理。
小范围试改时,往往发现“改了步骤引用就够了”,于是把这条经验推广到全部文章。规模化后例外通常来自三类情况。
第一类是间接引用。旧文章没有直接抄文档,而是转述了文档里的结论,措辞不同但依赖同一事实。按字面搜索找不到,按含义才能发现。第二类是交叉引用。旧文章引用了另一篇旧文章,而那篇才是直接依赖文档的。只改直接依赖的那篇,前一篇的表述就悬空了。第三类是上下文依赖。引用本身没变,但文章用它论证的结论变了,例如旧文用“默认关闭”推出某个使用建议,新版改成默认开启后,建议不再成立。
这三类例外说明:不能把“引用句是否与文档字面一致”当作唯一判据,还要看它承担了什么论证作用。
假设某产品文档把配置项从“手动开启”改为“默认开启”,旧文章 A 直接写了开启步骤,旧文章 B 引用 A 说“因为默认关闭,所以要先开启”。
A 属于条件一,必须改。B 没有直接抄文档,属于间接引用,如果只按字面搜索文档关键词,B 会被漏掉;但读者按 B 操作会多做一个已不需要的步骤,所以 B 也要改。反过来,如果旧文章 C 只是解释这个配置项的作用,不涉及开关状态,即使文档改版,C 也可以不动。
这个例子的数字只为说明比较方法:假设清点出 20 处引用,其中 6 处是步骤或参数类,2 处是间接引用,其余 12 处是概念类。那么优先处理的是那 8 处,而不是全部 20 处。
改完后不要只看文字是否通顺,要回到读者动作上验证:按更新后的文章走一遍,是否与新版文档一致。一致则这篇可以关闭;不一致说明还有间接引用没找到。
什么时候可以停止排查?当剩余未改的引用全部属于概念类,且逐条确认与新版没有冲突时,可以停。如果发现某篇文章的必改项反复出现,说明它的引用密度过高,与其逐句修补,不如重写该段落,减少对具体版本的依赖。这是规模化后比逐条更新更省事的做法。
需要提醒的是,引用清点数量下降、搜索不到旧措辞,都只能说明字面匹配减少,不能单独证明引用已经处理干净,间接引用和交叉引用仍可能残留,需要按含义再查一遍。