先给结论:产品文档改版后,旧文章里需要优先更新的不是所有带链接的句子,而是那些把旧界面、旧字段或旧流程当作当前事实来陈述的引用。判断标准是引用是否承担了“让读者据此操作”的功能。如果它只是背景说明、历史沿革或外部标准出处,改版本身不构成必须动它的理由。先做一次引用清点,再按功能分三档处理,比整站扫一遍替换链接更省力,也更不容易把有效信息改坏。
把旧文章里的引用逐条抽出来,按它和产品文档的关系分成三类,处理方式完全不同。
这三类的区分依据是“读者读完这句话会不会立刻去操作”。会,就归第一档;不会,再判断是解释还是历史。
不要靠记忆决定哪篇要改。打开旧文章列表,为每一条引用建一行记录,至少包含四个字段:所在文章、引用指向的文档位置、引用在句子里承担的功能、以及改版后该位置是否仍然存在。第四项需要实际打开新文档确认,不能只看链接是否返回正常页面——链接能打开但内容已经换了对象,是这类改版里最常见的坑。
清点完成后,把“功能=操作”且“新位置已变化”的行单独拉出来,这就是第一批要改的清单。其余行按解释、历史两类归档,暂时不动。这个动作的结果会直接决定下一步:如果第一批清单很短,说明这次改版对旧文章的冲击集中在少数几处,逐条改即可;如果清单很长,说明旧文章大量依赖操作细节,需要考虑的不只是改链接,而是这些段落是否还应该留在原文里。
假设某产品文档把“通知设置”里的字段从“推送频率”改名为“提醒间隔”,取值逻辑不变。旧文里有两句话引用了它:
第一句是“在通知设置中把推送频率调低可以减少打扰”。这句承担操作指引,字段名已经不存在,读者按图索骥会找不到入口,必须改成新字段名,并确认改版后该字段所在页面层级是否也变了。
第二句是“推送频率这类参数的设计初衷是让用户控制信息密度”。这句在解释设计思路,字段改名不影响这个判断。可以保留原词作为历史称谓,也可以加一句“现称提醒间隔”,但不必强行替换,否则会丢失“这个功能曾经叫什么”的信息。
同一个字段,两句话的处理方式相反,原因不在关键词本身,而在句子是否要求读者动手。
改完第一批引用后,不要立刻认为任务结束。观察两个可核对的信号,并准备好它们的其他解释。
一是旧文章带来的站内跳转是否仍然指向有效的新文档位置。如果跳转量下降,可能是改版导致入口变化,也可能是读者本来就不点这些链接,不能单独归因于引用没改好。二是读者反馈或支持请求里是否还出现“按文章操作找不到入口”这类描述。若这类反馈消失,说明操作性引用基本对齐;若仍出现,需要回到清点表,检查是否漏掉了嵌套在步骤里的间接引用,比如截图说明、字段示例值。
反过来,如果跳转量没变甚至上升,也不能证明引用无需更新——读者可能只是从别处绕进来了。验证的目的是缩小不确定范围,不是给改动打分。
为了控制改动范围,以下几类在多数情况下不需要因为文档改版而更新:指向外部标准或第三方规范的引用;引用内容本身是结论、定义而非操作步骤的句子;已经明确标注“适用于旧版本”的历史段落。对最后一类,正确动作是补上版本标注,而不是把旧描述改成新描述。把历史内容改成当前事实,会让需要查旧行为的读者失去依据,这比留着过时链接更难修复。
如果清点后发现某篇旧文章里操作性引用占比很高,且大部分已经失效,更合理的决定可能不是逐条替换,而是把操作部分整体指向新文档,原文只保留概念解释。这个取舍取决于该文章的主要用途:以检索入口为主,就保留可读的解释;以操作手册为主,就交给文档本身维护。