产品文档改版后,旧文章里需要更新的引用不是所有提到旧产品名的句子,而是那些会让读者做出错误动作的引用:指向已删除页面的链接、描述已改变行为的步骤、以及把旧版本当默认前提的对比。判断标准很简单——读者照着这句话操作,会不会走到死路或得到不同结果。会,就必须改;不会,可以留。
假设你所在团队把一款产品的帮助中心从旧域名迁移到新结构,旧页面里大量出现“详见《XX 设置指南》”这类指向。改版后,这些引用的命运并不相同,可以按性质分成三类:
三类混在一起时,最容易被误伤的是语境性引用——它们读起来“过时”,但删掉后读者会失去理解现状的参照。
实际操作上,先做机械筛查:抓取旧文章里所有站内链接,标记出返回 404、301 到无关页、或指向已下线文档的条目。这一步只解决导航性问题,不解决文字描述是否正确。
一个可用的动作是:把返回 404 的链接逐条打开目标新页,确认新页是否覆盖了原引用想表达的内容。如果覆盖,改链接文字与地址;如果新页只覆盖一半,就在原句里补一句限定,而不是直接换链接。这个动作的结果会直接影响下一步——只有当链接层面清理干净,文字层面的核对才有意义,否则你会在“改描述”时反复遇到死链干扰判断。
改版常伴随默认行为变化,例如某个选项从默认关闭变为默认开启。旧文章若写“默认关闭,需要手动开启”,读者按旧文操作会以为功能没生效,实际它已经开着。这类句子的更新依据是行为差异,不是新文档的用词是否更漂亮。
核对方法:把旧句拆成“前提—动作—预期结果”,再拿新版本实际走一遍。三者中任意一项变了,就改;只有措辞变了、行为没变,可以不动。这能避免把大量同义改写当成必要更新,也避免漏掉真正会导致误操作的句子。
并非所有旧引用都要清除。以下情况适合保留,必要时加一句时间或版本限定:
保留时加限定语的成本很低,却能防止读者把旧信息当现行规则。相反,为了“看起来统一”而删除全部旧引用,往往会让文章失去解释力。
改完后,随机挑几篇旧文章,只读其中的引用句,不看上下文,问自己:这句话会让读者去点哪个链接、做哪个操作?如果答案指向的新页面或新行为与当前一致,这条引用就算通过。这个判断不依赖字数或关键词密度,只依赖引用与现状是否对齐。
把通过和不通过的条目分开记录,不通过的按导航性、事实性、语境性回填处理方式,下一次文档再改版时,这份记录就是最省力的起点。