先给结论:旧文章里需要更新的引用,不是所有提到产品的句子,而是那些依赖被改版动作改变的事实或路径的引用。判断依据是这次改版是否改变了功能名称、入口位置、操作顺序或可用范围。如果只改了排版和措辞,旧引用通常可以保留;如果改了入口、名称或流程,旧引用就必须逐条核对并更新。
产品文档改版通常落在两类变化里,处理方式完全不同。
第一类:只改呈现,不改事实。比如段落顺序调整、配图替换、同义改写。这类改版后,旧文章里引用的功能名、入口路径、操作步骤仍然成立。此时不必大范围返工,只需要检查引用链接是否还能打开、指向的段落是否还在同一页。如果锚点失效,改链接即可,不必改正文描述。
第二类:改了事实。包括功能改名、入口从A菜单移到B菜单、操作步骤增减、某些能力收窄或放开。这类改版会让旧文章里的描述变成错的。例如旧文写“在设置页开启某开关”,改版后开关移到了账户页,读者照着做会找不到。这种情况下,引用必须更新,否则会持续误导访问者。
区分这两类的动作很简单:拿改版前后的文档做一次逐项对照,把变化归到“呈现”或“事实”两栏。归到事实栏的条目,就是旧文章需要更新的范围。
把旧文章里的引用拆成几类,分别判断:
一个可操作的判断标准:如果读者按旧文章的描述去操作,会不会卡住或得到不同结果?会卡住的,改;不会的,留。这个标准比“是否提到产品”更准,能避免把大量无害的提及也卷进返工。
假设某产品的数据导出功能,改版前在“报表”页,改版后移到了“数据中心”,名称也从“导出报表”改成了“数据下载”。
一篇旧文章写:“进入报表页,点击导出报表,选择格式后下载。”改版后,这段描述有两处失效:入口和名称。更新动作是把这句话改成新入口和新名称,而不是只改其中一个。如果只改名称、不改入口,读者仍然找不到。
另一篇旧文章只写:“导出数据时注意选择正确的格式,否则后续处理会出错。”这句话不依赖入口和名称,改版后依然成立,可以保留。这就是“依赖事实”和“不依赖事实”的差别。
假设这个产品还有一篇旧文引用了导出功能的帮助页链接。改版后帮助页地址变了,链接会打不开。这时更新的是链接本身,正文描述如果没提入口,就不用动。动作和结果对应:改链接后,读者能重新到达正确页面;不改,则会遇到死链。
建议按影响面排序,而不是按文章新旧排序:
例外情况也要留出空间。有些旧文章本身已经过时,不只是引用问题,而是整篇内容不再适用。这时更新单个引用意义不大,应该考虑重写或下架,而不是硬改几个词。还有一种例外:旧文章面向的是历史版本的使用者,如果产品仍保留旧版本入口,那旧引用可能仍然有效,需要确认后再决定是否改。
完成一轮更新后,建议把“改版事实清单”和“已更新文章清单”对应起来。下一步动作是定期拿新文档对照这两份清单,确认没有遗漏。这样做的结果是,下次再改版时,你能快速定位哪些旧文章会受影响,而不必从零排查。