先给结论:改版后需要更新的,不是所有提到旧版功能的句子,而是那些会让读者按旧路径操作后失败、或让内容与新产品事实直接冲突的引用。判断顺序是先区分引用类型,再决定保留、改写还是退出。只做同义词替换通常无效,因为读者遇到的是操作步骤对不上,而不是措辞过时。
产品文档改版后,旧文章里的引用大致分三类,处理方式完全不同。
把这三类分开后,你会发现真正需要动手的往往只占一部分。先全部改一遍,既费时间,又容易把原本正确的解释改坏。
保留适用于引用只是背景信息,且不指向具体操作。前提是:删掉这句后,读者仍能完成文章要解决的任务。例如一篇讲权限模型原理的文章,顺带提到旧版角色名,只要不引导读者去点击,就不构成操作障碍。
改写适用于引用仍然指向同一功能,只是名称或位置变了。前提是你已经确认新旧功能是同一件事,而不是被拆分或合并。改写时要同时处理正文、截图说明、代码示例里的字段名,以及文末的相关阅读标题。只改正文第一段,读者仍会在示例代码里踩到旧字段。
退出适用于该引用所依赖的功能已被移除,或文章整体围绕旧流程展开。前提是这篇内容仍有搜索需求或内部链接价值。退出不是直接删除,而是把它标记为历史版本、加一行说明当前替代方案,或合并进新文档。直接删掉会让已有外部链接和书签变成死路。
假设你刚完成一次产品文档改版,旧文章有几十篇。可以按下面的顺序处理,而不是从第一篇开始逐字读。
这个顺序的关键动作是第三步的分类。分类结果直接决定后面花多少时间:如果一篇旧文章里大部分引用是边缘性的,它就不该进入本轮改写队列。
常见遗漏条件是:只改了正文,没改结构化数据、图片替代文本、代码块注释和下载文件里的旧名称。这些位置同样会被读者看到或被程序读取。另一个遗漏是只改了文章本身,没改指向它的锚文本和摘要。读者从搜索结果或站内列表点进来,看到的仍是旧描述,会以为内容没更新。
还有一种情况是引用更新了,但文章的结论仍建立在旧流程上。例如旧文章假设用户先进入某个旧页面再操作,新版本已经取消了这一步。这时改名称不够,需要重写操作前提,否则读者按新界面走,会发现文章描述的起点不存在。
不必追求所有旧引用归零。如果一篇旧文章已经没有访问、没有内部链接指向、也不对应任何当前任务,把它标记为历史内容即可,不必逐句改写。反过来,如果一篇文章仍在被大量引用,即使它只提到一个旧按钮名,也值得优先处理,因为读者最容易在这里卡住。
假设某篇旧教程在改版后仍有稳定访问,其中一处旧路径导致读者无法完成设置。你把它改写为新路径并走通流程,这篇内容就重新可用,接下来可以把它加入新版文档的相关阅读。如果改写后发现整篇流程都已失效,那就转为退出处理,补上替代文档链接,而不是继续修补。这个判断依据是读者能否按文章完成操作,而不是文章里还有多少处旧名称。