产品文档改版后,旧文章里需要更新的引用不是“所有提到旧版本的句子”,而是那些会让读者做出错误操作的引用。判断标准可以落成一句话:如果读者顺着这句话去查证、下载、配置或提交,却找不到对应对象或得到不同结果,它就必须更新;如果只是叙述历史或解释概念,可以保留。下面按你手里的一个页面逐步处理。
打开一篇旧文章,把涉及产品的句子逐条摘出来,按引用指向的对象分类。这个分类决定了处理动作,比搜索某个词出现了几次更有用。
先做这一步的实际结果是:一篇看起来“到处都是旧内容”的文章,往往只剩少数几条属于前两类。后续工作量会因此下降一个量级,你也能决定是先改可执行引用,还是先补说明。
对每一条可执行引用和可获取引用,做一次“照着走”的对照:在新版文档或产品里找到对应位置,记录三件事——对象是否还存在、名称是否一致、结果是否相同。三者中任意一项不同,就标记为需要更新。
这里有一个常见例外:个别样本成立,不代表可以照搬。假设你抽查了五篇旧文章,发现只有一篇的按钮名称变了,于是判断“这次改版影响很小”。这个结论不成立,因为抽查样本可能集中在概念类文章上,而操作类文章恰好没被抽到。要避免这个误判,应该按引用类型分层抽样,而不是按文章顺序抽样。假设某站有八十篇旧文章,其中操作类二十篇、概念类六十篇,那么至少要把二十篇操作类全部过一遍,概念类再抽若干篇确认,而不是从八十篇里随机抽十篇。
另一个容易误判的现象是:某些旧文章的访问量在改版后下降,有人据此认为这些文章“过期了”。访问下降还可能来自季节波动、渠道调整、同主题新文章分流,不能单独作为引用失效的证据。反过来,访问量没降也不代表引用正确,读者可能只是没走到那一步就离开了。
确认需要更新后,按下面顺序动手,避免改一半留下不一致:
每改完一批,回看这批文章之间的相互引用。如果 A 文引用 B 文的某个小节标题,而 B 文改版时删掉了该小节,A 文的锚文本就会指向空处。这一步的实际作用是:把单篇更新变成一组更新,避免读者在文章之间跳转时遇到断裂。
不是所有旧引用都值得动。满足以下条件时可以保留:引用对象仍然存在且行为一致;引用只用于说明历史或对比;读者不会据此执行操作。保留的代价是文章里会同时出现新旧两套说法,所以至少要在旧说法附近标明它对应哪个版本,否则读者无法判断该信哪一句。
还有一种情况需要单独决定:旧文章本身已经不再是主要入口,但仍在被外部引用。这时可以只做最小修正——把失效链接换成有效链接,把明显错误的操作步骤标注为已过时,而不是整篇重写。这个取舍的依据是读者到达路径,而不是文章本身的新旧程度。
下次产品文档再改版时,可以直接沿用这个顺序:摘出引用、按四类归档、对可执行和可获取引用做照着走对照、按位置更新、回看文章间相互引用。真正需要每次重新判断的只有两件事——哪些引用属于可执行或可获取,以及分层抽样的范围是否覆盖了操作类文章。把这两件事写进你的处理记录,旧文章的引用更新就不再依赖个人记忆,而能按同一套依据重复执行。